Package com.digi.android.ethernet

Class EthernetManager

java.lang.Object

com.digi.android.ethernet.EthernetManager

public class EthernetManager
extends java.lang.Object

Class that handles the Ethernet connection and configuration.

Note that only one interface is supported.

Unless noted, all API methods require the android.permission.ACCESS_NETWORK_STATE and/or android.permission.CHANGE_NETWORK_STATE permissions, depending on whether you are accessing or changing the Ethernet configuration. If your application does not have these permissions it will not have access to any Ethernet service feature.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor	Description
EthernetManager(android.content.Context context)	Class constructor.

Method Summary

Modifier and Type	Method	Description
void	configureInterface(EthernetConfiguration info)	Configures the interface with the given configuration.
EthernetConnectionMode	getConnectionMode()	Returns the configured connection mode of the interface.
java.net.InetAddress	getDns1()	Returns the configured DNS1 address of the interface.
java.net.InetAddress	getDns2()	Returns the configured DNS2 address of the interface.
java.net.InetAddress	getGateway()	Returns the configured gateway address of the interface.
java.lang.String	getInterfaceName()	Returns the Ethernet interface name.
java.net.InetAddress	getIp()	Returns the configured IP address of the interface.
java.lang.String	getMacAddress()	Reads the MAC address of the Ethernet interface.
java.net.InetAddress	getNetmask()	Returns the configured netmask of the interface.
boolean	isConnected()	Returns whether the Ethernet interface is connected or not.
boolean	isEnabled()	Returns whether the interface is enabled or not.
void	resetInterface()	Resets the Ethernet interface.
void	setEnabled(boolean enable)	Enables or disables the interface.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Constructor Detail

EthernetManager

public EthernetManager(android.content.Context context)

Class constructor. Creates a new instance of the EthernetManager.

Parameters:

context - Application context.

Throws:

java.lang.NullPointerException - If context == null.

Method Detail

getInterfaceName

public java.lang.String getInterfaceName()

Returns the Ethernet interface name.

Returns:

The Ethernet interface name, null if there is not any interface.

isEnabled

public boolean isEnabled()

Returns whether the interface is enabled or not.

Returns:

true if the interface is enabled, false otherwise.

See Also:

setEnabled(boolean)

setEnabled

public void setEnabled(boolean enable)

Enables or disables the interface.

Parameters:

enable - true to enable, false to disable.

See Also:

isEnabled()

isConnected

public boolean isConnected()

Returns whether the Ethernet interface is connected or not.

Returns:

true if connected, false otherwise.

resetInterface

public void resetInterface()

Resets the Ethernet interface.

getConnectionMode

public EthernetConnectionMode getConnectionMode()

Returns the configured connection mode of the interface.

Returns:

The configured connection mode.

See Also:

configureInterface(EthernetConfiguration), EthernetConnectionMode

getIp

public java.net.InetAddress getIp()

Returns the configured IP address of the interface.

Returns:

The configured IP address or null if could not be read.

See Also:

configureInterface(EthernetConfiguration)

getDns1

public java.net.InetAddress getDns1()

Returns the configured DNS1 address of the interface.

Returns:

The configured DNS1 address or null if could not be read.

See Also:

configureInterface(EthernetConfiguration)

getDns2

public java.net.InetAddress getDns2()

Returns the configured DNS2 address of the interface.

Returns:

The configured DNS2 address or null if could not be read.

See Also:

configureInterface(EthernetConfiguration)

getGateway

public java.net.InetAddress getGateway()

Returns the configured gateway address of the interface.

Returns:

The configured gateway address or null if could not be read.

See Also:

configureInterface(EthernetConfiguration)

getNetmask

public java.net.InetAddress getNetmask()

Returns the configured netmask of the interface.

Returns:

The configured netmask or null if could not be read.

See Also:

configureInterface(EthernetConfiguration)

getMacAddress

public java.lang.String getMacAddress()

Reads the MAC address of the Ethernet interface.

Returns:

The MAC address or null if could not be read.

Throws:

java.lang.NullPointerException - If the configured interface is null.

configureInterface

public void configureInterface(EthernetConfiguration info)
                        throws java.net.UnknownHostException

Configures the interface with the given configuration.

This method resets the interface to apply the new configuration.

Parameters:

info - Interface configuration.

Throws:

java.lang.IllegalArgumentException - If the interface name is invalid or the connection mode is unknown.

java.lang.NullPointerException - If info == null or in a static configuration the IP, netmask, gateway or DNS 1 addresses are null.

java.net.UnknownHostException - If the given IP addresses cannot be resolved.

See Also:

getConnectionMode(), getDns1(), getDns2(), getGateway(), getIp(), getNetmask(), EthernetConfiguration