net.rim.device.api.io.transport.options
Class TcpCellularOptions

java.lang.Object
  extended by net.rim.device.api.io.transport.options.TransportTypeOptions
      extended by net.rim.device.api.io.transport.options.TcpCellularOptions

public class TcpCellularOptions
extends TransportTypeOptions

This class stores configuration information for the TcpCellular transport type. If you provide an instance of this class to a ConnectionFactory object, the factory will use the configuration information when it creates a TcpCellular connection.

Otherwise, the factory uses the default configuration information set on the device. You can view or change that default information by navigating to Options->Advanced Options->TCP.

Since:
BlackBerry API 5.0.0

Constructor Summary
TcpCellularOptions()
          Constructs a TcpCellularOptions object
 
Method Summary
 String getApn()
          Retrieves the apn
 String getTunnelAuthPassword()
          Retrieves the tunnelAuthPassword
 String getTunnelAuthUsername()
          Retrieves the tunnelAuthUsername
 void setApn(String apn)
          Sets the apn
 void setTunnelAuthPassword(String tunnelAuthPassword)
          Sets the tunnelAuthPassword
 void setTunnelAuthUsername(String tunnelAuthUsername)
          Sets tunnelAuthUsername
 String toUrlOptionString()
          Converts the contents into a string that can be used in a URL.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

TcpCellularOptions

public TcpCellularOptions()
Constructs a TcpCellularOptions object

Since:
BlackBerry API 5.0.0


Method Detail

getApn

public String getApn()
Retrieves the apn

Returns:
the apn
Since:
BlackBerry API 5.0.0

setApn

public void setApn(String apn)
Sets the apn

Parameters:
apn - the apn to set
Since:
BlackBerry API 5.0.0

getTunnelAuthUsername

public String getTunnelAuthUsername()
Retrieves the tunnelAuthUsername

Returns:
the tunnelAuthUsername
Since:
BlackBerry API 5.0.0

setTunnelAuthUsername

public void setTunnelAuthUsername(String tunnelAuthUsername)
Sets tunnelAuthUsername

Parameters:
tunnelAuthUsername - the tunnelAuthUsername to set
Since:
BlackBerry API 5.0.0

getTunnelAuthPassword

public String getTunnelAuthPassword()
Retrieves the tunnelAuthPassword

Returns:
the tunnelAuthPassword
Since:
BlackBerry API 5.0.0

setTunnelAuthPassword

public void setTunnelAuthPassword(String tunnelAuthPassword)
Sets the tunnelAuthPassword

Parameters:
tunnelAuthPassword - the tunnelAuthPassword to set
Since:
BlackBerry API 5.0.0

toUrlOptionString

public String toUrlOptionString()
Converts the contents into a string that can be used in a URL.

Returns:
urlOptionString a formated String that can be used in a connection URL.
Since:
BlackBerry API 5.0.0





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.