com.etherios.connector

Interface IPlatformCustomization

public interface IPlatformCustomization

This interface defines the platform customizations that should be implemented by child connectors in order to instance and run it.

Method Summary

Modifier and Type	Method and Description
boolean	canReboot() Retrieves whether it is possible to reboot the device or not.
ConnectorLogger	getConnectorLogger() Retrieves the connector logger.
IConnectorPreferences	getConnectorPreferences() Retrieves the Cloud Connector preferences used to determine the Cloud Connector settings.
ImeiNumber	getImeiNumber() Retrieves the IMEI number of the device.
java.lang.String	getLocalIPAddress() Retrieves the local IP Address.
Location	getLocation() Retrieves the device location (GPS coordinates).
int	getNetworkConnectionType() Retrieves the active network connection type.
byte[]	getPPPLinkSpeed() Retrieves the PPP link speed in bits per second.
byte[]	getPPPPhoneNumber() Retrieves the phone number that was dialed for the PPP connection.
MacAddress	getPrimaryMacAddress() Retrieves the primary MAC Address of the device.
ISocket	getSocket(java.lang.String host, int port) Retrieves the socket to be used to open a connection to Device Cloud.
ISocket	getSSLSocket(java.lang.String host, int port) Retrieves the SSL socket that will be used to open a secure connection against Device Cloud.
boolean	isSimulator() Retrieves whether the connector is running as a simulator or not.
void	reboot() Reboots the device.

Method Detail

canReboot

boolean canReboot()

Retrieves whether it is possible to reboot the device or not.

Returns:

true if the device can be rebooted, false otherwise.

getConnectorLogger

ConnectorLogger getConnectorLogger()

Retrieves the connector logger.

Returns:

The connector logger.

See Also:

ConnectorLogger, DefaultConnectorLogger

getConnectorPreferences

IConnectorPreferences getConnectorPreferences()

Retrieves the Cloud Connector preferences used to determine the Cloud Connector settings.

Returns:

The Cloud Connector preferences.

See Also:

IConnectorPreferences, PreferencesManager

getImeiNumber

ImeiNumber getImeiNumber()

Retrieves the IMEI number of the device.

Returns:

IMEI of the device.

See Also:

ImeiNumber

getLocalIPAddress

java.lang.String getLocalIPAddress()

Retrieves the local IP Address.

Returns:

The local IP Address.

getLocation

Location getLocation()

Retrieves the device location (GPS coordinates).

Returns:

Device location object (GPS coordinates);

See Also:

Location

getNetworkConnectionType

int getNetworkConnectionType()

Retrieves the active network connection type. It should be one of the following values:

• INetworkImplementation.ETH_TYPE
• INetworkImplementation.WIFI_TYPE
• INetworkImplementation.MOBILE_TYPE
• INetworkImplementation.UNKNOWN_TYPE

Returns:

The active network connection type.

See Also:

INetworkImplementation.ETH_TYPE, INetworkImplementation.WIFI_TYPE, INetworkImplementation.MOBILE_TYPE, INetworkImplementation.UNKNOWN_TYPE

getPPPLinkSpeed

byte[] getPPPLinkSpeed()

Retrieves the PPP link speed in bits per second. It should be a 4 octet integer (in case it is a Mobile connection).

Returns:

PPP link speed of the PPP connection. All zeros represents unknown speed.

See Also:

INetworkImplementation.DEFAULT_LINK_SPEED

getPPPPhoneNumber

byte[] getPPPPhoneNumber()

Retrieves the phone number that was dialed for the PPP connection. The phone number is a variable length string (in case it is a Mobile connection). It contains the phone number dialed, including any dialing prefixes.

Returns:

Phone number dialed, including any dialing prefixes.

See Also:

INetworkImplementation.DEFAULT_PHONE_NUMBER

getPrimaryMacAddress

MacAddress getPrimaryMacAddress()

Retrieves the primary MAC Address of the device.

This is used to calculate the Device ID if the device_type_id is configured to mac).

If the network connection type is Ethernet (INetworkImplementation.ETH_TYPE}) or Wi-Fi (INetworkImplementation.WIFI_TYPE) this information is also required by Device Cloud.

Returns:

Primary MAC Address of the device.

See Also:

MacAddress, getNetworkConnectionType(), INetworkImplementation.ETH_TYPE, INetworkImplementation.WIFI_TYPE

getSocket

ISocket getSocket(java.lang.String host,
                  int port)

Retrieves the socket to be used to open a connection to Device Cloud.

Parameters:

host - The host name to connect to.

port - The port of the connection.

Returns:

The socket to connect to Device Cloud.

See Also:

ISocket

getSSLSocket

ISocket getSSLSocket(java.lang.String host,
                     int port)

Retrieves the SSL socket that will be used to open a secure connection against Device Cloud.

Parameters:

host - The host name to connect to.

port - The port of the connection.

Returns:

The SSL socket to connect to Device Cloud.

See Also:

ISocket

isSimulator

boolean isSimulator()

Retrieves whether the connector is running as a simulator or not.

Returns:

true if the connector runs as a simulator, false otherwise.

reboot

void reboot()

Reboots the device. If reboot is not supported this method does not need to be implemented.