com.eloview.sdk.networkManager

Class Network

java.lang.Object

com.eloview.sdk.consts.Consts

com.eloview.sdk.accountManager.AccountManager

com.eloview.sdk.networkManager.Network

All Implemented Interfaces:

java.lang.Cloneable

public class Network
extends AccountManager

Network class provides the following functions.

• A method called setNetwork which is used to connect to a user-defined network configuration
• A method called getNetwork which returns the information about the current network the device is connected to, such as the network name, network type, IpAddress and MacAddress
• A method called getWiFiMac which returns the WiFi Mac Address
• A method called getEthernetMac which returns the Ethernet Mac Address
• A method called installCertificate This method is used to send the EST Certificate configuration request. It will generate EST user and ca_certificate.
• A method called removeCertificate This method is used to send the EST Certificate configuration request. It will remove EST user and ca_certificate.
• A method called installLocalCertificate This method is used to install the local wifi certificates even when device is offline.
• A method to power on/off the ethernet port. setEthState
• A method to obtain the DHCP server host name getDHCPServerHostName
• A method to unregister the broadcast receiver registered when the installCertificate(Context, ESTConfig, Handler) API is used in your application unregisterCertificatesListener
• A method to read system property readSystemProperty

Field Summary

Fields

Modifier and Type	Field and Description
static int	GET_ETH_MAC_ADDRESS_CODE Response code which indicates that ethernet mac address is available.
static int	GET_NETWORK_RESPONSE_CODE Response code which indicates that info about current connected network is available.
static int	GET_WIFI_MAC_ADDRESS_CODE Response code which indicates that wifi mac address is available
static int	INSTALL_CERTIFICATE_CODE Response code of Certificate Installation process.
static int	SET_EST_CERTIFICATE_CODE Response code of ESTServer Certificate Install.
static int	SET_NETWORK_RESPONSE_CODE Response code which indicates whether network configuration was applied successfully or not

Fields inherited from class com.eloview.sdk.accountManager.AccountManager

ACCESS_TOKEN_INVALID, ACCESS_TOKEN_VALID, API_ACCESS_TOKEN_INVALID, API_ACCESS_TOKEN_VALID, instance, IS_USER_LOGIN_OAUTH, isPolaris, OAUTH_TOKEN_INVALID, OAUTH_TOKEN_VALID, REQUEST_AUTH_LOGIN, REQUEST_AUTH_LOGOUT, SETUP_OAUTH_ERROR, SETUP_OAUTH_SUCCESS, TOKEN_VERIFY_FAIL, TOKEN_VERIFY_SUCCESS

Fields inherited from class com.eloview.sdk.consts.Consts

GENERIC_ERROR, OAUTH_PATH_TOKEN, OAUTH_PATH_VERIFY

Constructor Summary

Constructors

Constructor and Description
Network()

Method Summary

Modifier and Type	Method and Description
void	bindService(android.content.Context context, ServiceConnectionCallback callback, java.lang.String accessToken) This method is used to bind the service to the application.
java.lang.String	getDHCPServerHostName() This method is used to obtain the DHCP server host name
java.lang.String	getEthernetMac() This method is used to obtain the getEthernetMac
boolean	getEthState() This method is used to get the on/off state of the Ethernet port
void	getNetwork(android.content.Context context, java.lang.String accessToken, android.os.Handler handler) This method is used to provide information about the network the device is currently connected to.
java.lang.String	getWiFiMac() This method is used to obtain the getWiFiMac
void	installCertificate(android.content.Context context, ESTConfig estConfig, android.os.Handler handler) This method is used to send the EST Certificate configuration request.
boolean	installLocalCertificate(android.content.Context context, CertificateConfig certificateConfig) This method is used to install the local wifi certificates even when device is offline.
java.lang.String	readSystemProperty(java.lang.String key) Read system property
boolean	removeCertificate(java.lang.String alias) This method is used to send the EST Certificate configuration request.
void	setEthState(boolean state) This method is used to power on/off the ethernet port.
java.lang.String	setNetmask(NetworkConfig networkConfig, java.lang.String netmask)
void	setNetwork(android.content.Context context, java.lang.String accessToken, NetworkConfig networkConfig, android.os.Handler handler) This method is used to set a network configuration using the parameters described in NetworkConfig class and connect to the network with the given configuration.
void	setNetwork(android.content.Context context, java.lang.String accessToken, NetworkConfig networkConfig, android.os.Handler handler, java.lang.Boolean disableEthernet) This method is used to set a network configuration using the parameters described in NetworkConfig class and connect to the network with the given configuration.
void	unbindService(android.content.Context context) This method is used to unbind the service from the application.
void	unregisterCertificatesListener(android.content.Context context) This method is used to unregister the broadcast receiver registered when the installCertificate(Context, ESTConfig, Handler) API. is used in your application.

Methods inherited from class com.eloview.sdk.accountManager.AccountManager

configureOAuthHostedUI, destroyOAuth, getBaseUri, getClientId, getEloAccessToken, getEloOAuthToken, getEnvironment, getProperty, isPolaris, isPolarisLocked, logoutOAuth, onOAuthActivityResult, selectEnvironment, setDefaultEnvironment, setProperty, stopOAuth, unregisterAccountManagerListener, verifyEloToken

Methods inherited from class com.eloview.sdk.consts.Consts

clone, getEloIntentWithFlag, getMigrate, isDevice7Inch, isDeviceM100

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SET_NETWORK_RESPONSE_CODE

public static final int SET_NETWORK_RESPONSE_CODE

Response code which indicates whether network configuration was applied successfully or not

See Also:

Constant Field Values

GET_NETWORK_RESPONSE_CODE

public static final int GET_NETWORK_RESPONSE_CODE

Response code which indicates that info about current connected network is available.

See Also:

Constant Field Values

GET_WIFI_MAC_ADDRESS_CODE

public static final int GET_WIFI_MAC_ADDRESS_CODE

Response code which indicates that wifi mac address is available

See Also:

Constant Field Values

GET_ETH_MAC_ADDRESS_CODE

public static final int GET_ETH_MAC_ADDRESS_CODE

Response code which indicates that ethernet mac address is available.

See Also:

Constant Field Values

SET_EST_CERTIFICATE_CODE

public static final int SET_EST_CERTIFICATE_CODE

Response code of ESTServer Certificate Install.

See Also:

Constant Field Values

INSTALL_CERTIFICATE_CODE

public static final int INSTALL_CERTIFICATE_CODE

Response code of Certificate Installation process.

See Also:

Constant Field Values

Constructor Detail

Network

public Network()

Method Detail

readSystemProperty

public java.lang.String readSystemProperty(java.lang.String key)

Read system property

Parameters:

key - system property key

Returns:

system property value

setNetwork

public void setNetwork(android.content.Context context,
                       java.lang.String accessToken,
                       NetworkConfig networkConfig,
                       android.os.Handler handler)

This method is used to set a network configuration using the parameters described in NetworkConfig class and connect to the network with the given configuration.

Parameters:

context - Context

accessToken - An authentication token received from the Elo servers.

networkConfig - NetworkConfig to set up the user data

handler - A handler to receive one or more of the following callback messages:

AccountManager.TOKEN_VERIFY_FAIL
Consts.GENERIC_ERROR
SET_NETWORK_RESPONSE_CODE

setNetwork

public void setNetwork(android.content.Context context,
                       java.lang.String accessToken,
                       NetworkConfig networkConfig,
                       android.os.Handler handler,
                       java.lang.Boolean disableEthernet)

This method is used to set a network configuration using the parameters described in NetworkConfig class and connect to the network with the given configuration.

Parameters:

context - Context

accessToken - An authentication token received from the Elo servers.

networkConfig - NetworkConfig to set up the user data

handler - A handler to receive one or more of the following callback messages:

AccountManager.TOKEN_VERIFY_FAIL
Consts.GENERIC_ERROR
SET_NETWORK_RESPONSE_CODE

disableEthernet - Boolean : to decide if we want to disable ethernet or not

getNetwork

public void getNetwork(android.content.Context context,
                       java.lang.String accessToken,
                       android.os.Handler handler)

This method is used to provide information about the network the device is currently connected to. This method does not necessarily return all the parameters defined
in the NetworkConfig class. The parameters returned for each interface are mentioned below.

Parameters:

context - Context

accessToken - An authentication token received from the Elo servers.

handler - A handler to receive one or more of the following callback messages:

AccountManager.TOKEN_VERIFY_FAIL
Consts.GENERIC_ERROR
GET_NETWORK_RESPONSE_CODE

If the device is connected to Ethernet: The following parameters will be returned:
"active", "networkType", "macAddress", "ipAddress", "networkPrefixLength", “interface”, “proxyPort”, “ipAssignmentState”,
"proxyHost", “gateway”, “networkPrefix”, “dnsServers”, “proxyExclusion”

If the device is connected to Wifi: The following parameters will be returned:
"active", "networkType", "ssid_name", "macAddress", "ipAddress", "networkPrefixLength", “interface”, “proxyPort”, “ipAssignmentState”,
"speed", "rssi", "proxyHost", “gateway”, “networkPrefix”, “dnsServers”, “proxyExclusion”

getEthState

public boolean getEthState()

This method is used to get the on/off state of the Ethernet port

Returns:

true iff Ethernet is on, false otherwise

setEthState

public void setEthState(boolean state)

This method is used to power on/off the ethernet port. This is a blocking call. Please do not call on the main UI thread, otherwise, you will get an ANR.

Parameters:

state - ethernet power state (on/off)

unregisterCertificatesListener

public void unregisterCertificatesListener(android.content.Context context)

This method is used to unregister the broadcast receiver registered when the installCertificate(Context, ESTConfig, Handler) API.
is used in your application. Please make sure to call this in the "onPause" and "onDestroy" methods in your activity Lifecycle if you made use of installCertificate(Context, ESTConfig, Handler) API. This ensures the receiver is not leaked.

Parameters:

context - Context in which the Network APIs were used

getWiFiMac

public java.lang.String getWiFiMac()

This method is used to obtain the getWiFiMac

Returns:

String : getWiFiMac

getEthernetMac

public java.lang.String getEthernetMac()

This method is used to obtain the getEthernetMac

Returns:

String : getEthernetMac

getDHCPServerHostName

public java.lang.String getDHCPServerHostName()

This method is used to obtain the DHCP server host name

Returns:

String : DHCP server host name

setNetmask

public java.lang.String setNetmask(NetworkConfig networkConfig,
                                   java.lang.String netmask)

installCertificate

public void installCertificate(android.content.Context context,
                               ESTConfig estConfig,
                               android.os.Handler handler)

This method is used to send the EST Certificate configuration request. It will generate EST user and ca_certificate.

Parameters:

context - Context it must be Activity or Application context

estConfig - ESTConfig having certificate details.

handler - A handler to receive one or more of the following callback messages:

AccountManager.TOKEN_VERIFY_FAIL
Consts.GENERIC_ERROR
SET_EST_CERTIFICATE_CODE

removeCertificate

public boolean removeCertificate(java.lang.String alias)

This method is used to send the EST Certificate configuration request. It will remove EST user and ca_certificate.

Parameters:

alias - String having certificate alias details.

Returns:

boolean true if certificate removed successfully.

installLocalCertificate

public boolean installLocalCertificate(android.content.Context context,
                                       CertificateConfig certificateConfig)

This method is used to install the local wifi certificates even when device is offline. Provide CA or USER certificate file path, name and CERTIFICATE_TYPE. User certificates are generally in ".p12" format and require a valid password to be installed.

Parameters:

context - Context it must be Activity or Application context

certificateConfig - CertificateConfig Configuration of the local certificate files having local certificate file path, name, type. user_certificate_password if CERTIFICATE_TYPE is USER_CERTIFICATE.

Returns:

boolean true if certificate installed successfully.

bindService

public void bindService(android.content.Context context,
                        ServiceConnectionCallback callback,
                        java.lang.String accessToken)

This method is used to bind the service to the application. Use this method to bind the service to the application before using any of the APIs.

Parameters:

context - Context in which the Network APIs were used

callback - ServiceConnectionCallback

accessToken - String

unbindService

public void unbindService(android.content.Context context)

This method is used to unbind the service from the application. Use this method to unbind the service from the application when the clearing resources.

Parameters:

context - Context in which the Network APIs were used