|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.IBM.WirelessClient.API.eWirelessAPI
This class provides a java wrapper for the IBM Wireless Client api.
Field Summary | |
static int |
ART_BATT_LOW
ART_HARDWARE_EV constant values. |
static int |
ART_BATT_OK
ART_HARDWARE_EV constant values. |
static int |
ART_BUFF_OK
ART_HARDWARE_EV constant values. |
static int |
ART_BUFFER_FULL
ART_HARDWARE_EV constant values. |
static int |
ART_HW_OFF
ART_HARDWARE_EV constant values. |
static int |
ART_UNKNOWN_HW_EV
ART_HARDWARE_EV constant values. |
static int |
eErrAccountDeleted
Use the eOK, e*****,... |
static int |
eErrAccountExpired
Use the eOK, e*****,... |
static int |
eErrAccountLocked
Use the eOK, e*****,... |
static int |
eErrAccountUnknown
Use the eOK, e*****,... |
static int |
eErrAddressInUse
Use the eOK, e*****,... |
static int |
eErrAddressNotAvailable
Use the eOK, e*****,... |
static int |
eErrAlreadyConnected
Use the eOK, e*****,... |
static int |
eErrAuthorizationRequired
Use the eOK, e*****,... |
static int |
eErrBadState
Use the eOK, e*****,... |
static int |
eErrBufferTooSmall
Use the eOK, e*****,... |
static int |
eErrCommPort
Use the eOK, e*****,... |
static int |
eErrCoreNotStarted
Use the eOK, e*****,... |
static int |
eErrFailed
Use the eOK, e*****,... |
static int |
eErrForcePasswordChange
Use the eOK, e*****,... |
static int |
eErrForceRadiusAuthentication
Use the eOK, e*****,... |
static int |
eErrGatewayDown
Use the eOK, e*****,... |
static int |
eErrIdleTimeout
Use the eOK, e*****,... |
static int |
eErrInitUnknown
Use the eOK, e*****,... |
static int |
eErrInvalidConfiguration
Use the eOK, e*****,... |
static int |
eErrInvalidDestination
Use the eOK, e*****,... |
static int |
eErrInvalidNewPassword
Use the eOK, e*****,... |
static int |
eErrInvalidParameter
Use the eOK, e*****,... |
static int |
eErrMaximumErrorNumber
Use the eOK, e*****,... |
static int |
eErrMemoryFailure
Use the eOK, e*****,... |
static int |
eErrModemConnectFailed
Use the eOK, e*****,... |
static int |
eErrModemInitFailed
Use the eOK, e*****,... |
static int |
eErrNdisNotConfigured
Use the eOK, e*****,... |
static int |
eErrNoActiveInterface
Use the eOK, e*****,... |
static int |
eErrNotInitialized
Use the eOK, e*****,... |
static int |
eErrNotSupported
Use the eOK, e*****,... |
static int |
eErrOperator
Use the eOK, e*****,... |
static int |
eErrPassword
Use the eOK, e*****,... |
static int |
eErrProtocol
Use the eOK, e*****,... |
static int |
eErrQueueAlreadyRegistered
Use the eOK, e*****,... |
static int |
eErrRadiusAuthenticationChallenge
Use the eOK, e*****,... |
static int |
eErrTimeout
Use the eOK, e*****,... |
static int |
eErrTooManyInterfaces
Use the eOK, e*****,... |
static int |
eErrUpperLimit
Use the eOK, e*****,... |
static int |
eErrVersion
Use the eOK, e*****,... |
static int |
eEXPRESS
eBATTERYMODE constant values. |
static int |
eOK
Use the eOK, e*****,... |
static int |
eOperationPending
Use the eOK, e*****,... |
static int |
eSAVER
eBATTERYMODE constant values. |
static int |
eUNKNOWNMODE
eBATTERYMODE constant values. |
Constructor Summary | |
eWirelessAPI()
Class constructor. |
Method Summary | |
void |
addeWirelessAPIListener(eWirelessAPIListener listener)
Applications implementing the eWirelessAPIListener interface defined above should use addeWirelessAPIListener and removeeWirelessAPIListener to register and deregister from this object, in order to receive events over the interface |
int |
eAuthenticate(java.lang.String userID,
java.lang.String Password)
This method is used to initiate a third party authentication logon sequence with the Wireless Gateway, where the access control is managed by a remote authentication dial-in user service (RADIUS) server. |
int |
eChangePassword(java.lang.String currentPassword,
java.lang.String newPassword)
This method is used to change the password used by the Wireless Client to log onto the Wireless Gateway. |
int |
eCloseApi()
This method closes the link between this application and the wireless client. |
int |
eCloseInterface(eInterfaceHandle hInterface)
This method closes an interface opened with eOpenInterface(). |
int |
eDisableTransmitter(eInterfaceHandle hInterface)
This method is used to disable the radio transmitter. |
int |
eEnableTransmitter(eInterfaceHandle hInterface)
This method is used to enable the radio transmitter. |
int |
eGetActiveInterface(eInterfaceHandle hInterface)
This method returns a handle to the current active interface. |
int |
eGetAllInterfaceHandles(java.util.Vector handles)
This method returns an vector containing all currently open interface handles. |
int |
eGetBatteryMode(eInterfaceHandle hInterface)
This method is used to query the modem (or radio) battery mode. |
int |
eGetBatteryStrength(eInterfaceHandle hInterface)
This method is used to query the modem (or radio) battery strength. |
int |
eGetConnectionInfo()
This method triggers an asynchronous event that returns a structure containing information about the connection specified at logon, such as IP addresses, encryption, compression, and caching settings. |
int |
eGetConnectionNames(java.util.Vector names)
This method is used to enumerate all of the configured connections in the Wireless Client configuration store. |
int |
eGetInterfaceNames(java.lang.String connectionName,
java.util.Vector names)
This method is used to enumerate all of the interface names that are configured for a particular connection. |
int |
eGetNetworkCapabilities(eInterfaceHandle hInterface)
This method is used to request information specific to the capabilities of current modem and interface type (e.g. |
int |
eGetNetworkSpecific(eInterfaceHandle hInterface)
This method is used to request information specific to the current modem and interface type, such as current channel number, modem firmware level, and modem addresses. |
int |
eGetNetworkStatus(eInterfaceHandle hInterface)
This method is used to request information about the network status for this interface. |
int |
eGetRFModemStatistics(eInterfaceHandle hInterface)
This method is used to request rf statistical information from the modem This method is not supported by all network drivers. |
int |
eGetRFModemStatus(eInterfaceHandle hInterface)
This method is used to request status information from the modem such as in range status, trasmitter and receiver status, baseStationID, etc. |
int |
eGetSignalQuality(eInterfaceHandle hInterface)
This method is used to request modem signal quality. |
int |
eGetSignalStrength(eInterfaceHandle hInterface)
This method is used to request modem signal strength. |
int |
eGetStatistics(eInterfaceHandle hInterface,
eStats stats)
This method returns a structure containing statistical information about this interface, such as the bytes and packets that have been sent and received by the Wireless Client. |
int |
eLogoff()
This method is used to initiate a logoff attempt with the Wireless Gateway. |
int |
eLogon(java.lang.String sessionConfig,
java.lang.String userId,
java.lang.String password,
java.lang.String orgUnit)
This method is used to initiate a logon sequence with the Wireless Gateway. |
int |
eOpenApi()
This method opens the link between this application and the wireless client. |
int |
eOpenInterface(java.lang.String interfaceName,
java.lang.String destinationOverride,
eInterfaceHandle hInterface)
This method should be used by applications to initialize the modem or network device and establish a physical link to the network. |
int |
eResetStatistics(eInterfaceHandle hInterface)
This method resets the statistical information for this interface. |
int |
eResumeInterface(eInterfaceHandle hInterface)
This method is used to resume the physical link for this interface. |
int |
eSendRedialMessage(eInterfaceHandle hInterface)
This method is used to request that the interface start redialing the modem. |
int |
eSetActiveInterface(eInterfaceHandle hInterface)
This method sets the active interface. |
int |
eSetBatteryMode(eInterfaceHandle hInterface,
int newMode)
This method is used to change the modem (or radio) battery mode. |
int |
eShutdown()
This method will disconnect all interfaces and stop the Wireless Client executable. |
int |
eSuspendInterface(eInterfaceHandle hInterface)
This method is used to disconnect the physical link over this interface, but to otherwise keep the interface open. |
void |
removeeWirelessAPIListener(eWirelessAPIListener listener)
Applications implementing the eWirelessAPIListener interface defined above should use addeWirelessAPIListener and removeeWirelessAPIListener to register and deregister from this object, in order to receive events over the interface |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final int eOK
public static final int eOperationPending
public static final int eErrFailed
public static final int eErrMemoryFailure
public static final int eErrInvalidParameter
public static final int eErrQueueAlreadyRegistered
public static final int eErrForcePasswordChange
public static final int eErrCoreNotStarted
public static final int eErrNotInitialized
public static final int eErrNotSupported
public static final int eErrModemInitFailed
public static final int eErrCommPort
public static final int eErrTooManyInterfaces
public static final int eErrInvalidConfiguration
public static final int eErrBadState
public static final int eErrNdisNotConfigured
public static final int eErrNoActiveInterface
public static final int eErrTimeout
public static final int eErrPassword
public static final int eErrProtocol
public static final int eErrAuthorizationRequired
public static final int eErrGatewayDown
public static final int eErrAccountDeleted
public static final int eErrAccountUnknown
public static final int eErrAlreadyConnected
public static final int eErrOperator
public static final int eErrVersion
public static final int eErrAccountLocked
public static final int eErrAccountExpired
public static final int eErrInvalidNewPassword
public static final int eErrInitUnknown
public static final int eErrModemConnectFailed
public static final int eErrAddressNotAvailable
public static final int eErrAddressInUse
public static final int eErrInvalidDestination
public static final int eErrBufferTooSmall
public static final int eErrForceRadiusAuthentication
public static final int eErrRadiusAuthenticationChallenge
public static final int eErrIdleTimeout
public static final int eErrMaximumErrorNumber
public static final int eErrUpperLimit
public static final int eEXPRESS
public static final int eSAVER
public static final int eUNKNOWNMODE
public static final int ART_BATT_LOW
public static final int ART_BUFFER_FULL
public static final int ART_BATT_OK
public static final int ART_BUFF_OK
public static final int ART_HW_OFF
public static final int ART_UNKNOWN_HW_EV
Constructor Detail |
public eWirelessAPI()
Method Detail |
public void addeWirelessAPIListener(eWirelessAPIListener listener)
listener
- User implemented instance of the eWirelessAPIListener interfaceremoveeWirelessAPIListener(eWirelessAPIListener)
public void removeeWirelessAPIListener(eWirelessAPIListener listener)
listener
- User implemented instance of the eWirelessAPIListener interfaceaddeWirelessAPIListener(eWirelessAPIListener)
public int eAuthenticate(java.lang.String userID, java.lang.String Password)
userID
- [in] String specifying the userID for the connection. A userID is requiredPassword
- [in] String specifying the password for the connection. The password must
be a required field. See RCF 2138 for userID and password guidelines.public int eChangePassword(java.lang.String currentPassword, java.lang.String newPassword)
currentPassword
- [in] The current valid password string.newPassword
- [in] The new password string.public int eCloseApi()
eErrCoreNotStarted
. Upon receiving this return code,
applications should call this method followed by a call to
eOpenAPI().
If this method is not called by an application, it will be called in the
finalize() method for this object.
Associated events: eOpenApi()
public int eCloseInterface(eInterfaceHandle hInterface)
>
If your application calls eCloseInterface, determine whether you want to modify the UseDefaultAPIBehavior
parameter in the Wireless Client configuration file,
artour.ini. This parameter determines whether the Wireless Client shuts down
automatically either after a eMsg_Logoff event is received from a network driver
or after the last ative interface closes. See General Programming Considerations
for more information on the UseDefaultAPIBehavior
parameter
Associated events: hInterface
- [in] Identifies the interface that should be closed. This value should
have been obtained from the eOpenInterface or eGetActiveInterface methods..eOpenInterface(String, String , eInterfaceHandle)
public int eDisableTransmitter(eInterfaceHandle hInterface)
eMsg_DisableTransmitter
contains a return code indicating success or failure for the call.hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.eEnableTransmitter( eInterfaceHandle )
public int eEnableTransmitter(eInterfaceHandle hInterface)
eMsg_EnableTransmitter
contains a return code indicating success or failure for the call.hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.eDisableTransmitter( eInterfaceHandle)
public int eGetActiveInterface(eInterfaceHandle hInterface)
hInterface
- [out] Identifies the active interface. This value is invalid
unless the return code from the operation is eOK.eSetActiveInterface( eInterfaceHandle)
public int eGetAllInterfaceHandles(java.util.Vector handles)
handles
- [in/out] parameter. public int eGetBatteryMode(eInterfaceHandle hInterface)
hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.eSetBatteryMode( eInterfaceHandle, int)
public int eGetBatteryStrength(eInterfaceHandle hInterface)
hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.public int eGetConnectionInfo()
hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.public int eGetConnectionNames(java.util.Vector names)
names
- [out] On successful return from the method, this vector will
contain the connection names.public int eGetInterfaceNames(java.lang.String connectionName, java.util.Vector names)
connection
- [in] The name of the Wireless Client connection. You may use
eGetConnectionNames to determine this value.names
- [out] On successful return from the method, this vector will
contain the interface names.public int eGetNetworkCapabilities(eInterfaceHandle hInterface)
hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.public int eGetNetworkSpecific(eInterfaceHandle hInterface)
hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.public int eGetNetworkStatus(eInterfaceHandle hInterface)
hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.public int eGetSignalQuality(eInterfaceHandle hInterface)
hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.public int eGetSignalStrength(eInterfaceHandle hInterface)
hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.public int eGetStatistics(eInterfaceHandle hInterface, eStats stats)
hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.eStats
- [out] The statistical information is returned in this eStats
object.public int eGetRFModemStatus(eInterfaceHandle hInterface)
hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.public int eGetRFModemStatistics(eInterfaceHandle hInterface)
hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.public int eLogoff()
UseDefaultAPIBehavior
parameter in the Wireless Client configuration
file, artour.ini. See General Programming Considerations for more information on the
UseDefaultAPIBehavior
parameter.
Associated events: eLogon(String, String, String, String)
public int eLogon(java.lang.String sessionConfig, java.lang.String userId, java.lang.String password, java.lang.String orgUnit)
This method is used to initiate a logon sequence with the Wireless Gateway. The logon sequence exchanges identities and credentials with the Wireless Gateway. This typically involves two packets sent to the Wireless Gateway and two packets received from the Wireless Gateway, but might involve more packets.
NOTE: Unlike most API calls, this method does not require an interface handle. A logon and logoff identify a logical connection with the Wireless Gateway (as apposed to a physical link). This connection is independent of the physical link which is established with eOpenInterface, which allows you to switch physical networks while maintaining a logical connection.
A Wireless Client cannot have concurrent logon sessions. If an application issues a logon call while the Wireless Client is already logged onto the Wireless Gateway, the Wireless Client receives an eLogon event with an error.
If your application calls eLogoff after an eLogon, determine whether you want
to modify the UseDefaultAPIBehavior
parameter in the Wireless Client
configuration file, artour.ini. This parameter determines whether the Wireless
Client shuts down automatically either after a eMsg_Logoff event is received
from a network driver or after the last ative interface closes. See General Programming Considerations
for more information on the UseDefaultAPIBehavior
parameter.
sessionConfig
- [in] String identifying the section in the configuration which contains the connection-specific information needed
to logon (such as Wireless Gateway address, encryption, compression, etc).userId
- [in] String specifying the userid for the connection. If a userid is not required, this parameter can be set to NULL.password
- [in] String specifying the password for the connection. If a password is not required, this parameter can be set to NULL.orgUnit
- [in] String specifying the organization unit for the connection. If an organization unit is not required, this parameter can be set to NULL.eLogoff()
public int eOpenApi()
eErrCoreNotStarted
. Upon receiving
this return code, applications should call eCloseApi() followed by a call to
this method.
This method should also be invoked by an application that wishes to again
use the API after previously calling eCloseApi().eCloseApi()
public int eOpenInterface(java.lang.String interfaceName, java.lang.String destinationOverride, eInterfaceHandle hInterface)
This method should be used by applications to initialize the modem or
network device and establish a physical link to the network. This method
determines the type of interface to open (e.g. Mobitex, DataTAC, etc.) by
searching for the interfaceName
in the Wireless Client configuration. When
the interfaceName
is located, the method opens and initializes the specified
interface.
NOTE: This method does not log on to the Wireless Gateway.
Asynchronous events are generated by this method; a return code of eOK does not mean that the attempt to open the interface succeeded. Applications should monitor other events that mark the staged completion of the attempt. If you do not want your applications to handle events indicating completion of intermediate steps, your application should monitor only for the final event, eMsg_OpenInterface, ignoring the intermediate steps. In rare instances, applications may receive the events before this funtion returns. Your application should be prepared to handle this occurrence.
If no other interface is open, the interface that was set in the eOpenAPI call is set as active. An active interface is the interface that data will flow over. If another interface is already active, you must call the eSetActiveInterface method to set the interface active.
If your application calls eOpenInterface, determine whether you want to modify
the UseDefaultAPIBehavior
parameter in the Wireless Client configuration file,
artour.ini. This parameter determines whether the Wireless Client shuts down
automatically either after a eMsg_Logoff event is received from a network
driver or after the last ative interface closes. See General Programming
Considerations for more information on the UseDefaultAPIBehavior
parameter
interfaceName
- [in] Name of the interface as specified in the Wireless Client configuration file (e.g. MyMobitex).destinationOverride
- [in] This parameter is used to temporarily override the destination specified in the configuration
for this interface (e.g. the Wireless Gateway phone number). The exact format of this
string varies by interface. Refer to the documentation for each interface type for details.
If this parameter is not used, it should be set to NULL.hInterface
- [out] This handle is returned by the method and will be used to
identify this interface across API calls and events. It is assumed to be valid until
eCloseInterface is called or until an eMsg_OpenInterface event with a bad return code
is posted. This handle is only valid if the return code from this method is eOK.eCloseInterface(eInterfaceHandle hInterface)
public int eResetStatistics(eInterfaceHandle hInterface)
hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.eGetStatistics(eInterfaceHandle, eStats)
public int eResumeInterface(eInterfaceHandle hInterface)
hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.eSuspendInterface(eInterfaceHandle)
public int eSendRedialMessage(eInterfaceHandle hInterface)
hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.public int eSetActiveInterface(eInterfaceHandle hInterface)
hInterface
- Identifies the new active interface. The interface handle must have been returned
from a previous call to eOpenInterface.eGetActiveInterface( eInterfaceHandle)
public int eSetBatteryMode(eInterfaceHandle hInterface, int newMode)
hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.newMode
- [in] The mode to which the battery should be set. Set value using constants eEXPRESS, eSAVER, eUKNOWNMODE
( eEXPRESS
).eGetBatteryMode( eInterfaceHandle)
public int eShutdown()
public int eSuspendInterface(eInterfaceHandle hInterface)
hInterface
- [in] Identifies the interface for which this action should be performed. This
value should have been obtained from the eOpenInterface or eGetActiveInterface methods.eResumeInterface(eInterfaceHandle)
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |