| Package | Description |
|---|---|
| com.eurotech.framework |
Contains objects necessary to manage framework exceptions.
|
| com.eurotech.framework.clock |
Contains interface and event model to synchronize hardware clock.
|
| com.eurotech.framework.cloud |
Provides services for managing communications between M2M applications and remote servers.
|
| com.eurotech.framework.comm |
Provides services for managing a connection with a serial port.
|
| com.eurotech.framework.configuration |
Contains services to manage all configurable components of the system.
|
| com.eurotech.framework.data |
Provides services for connecting and communicating with a MQTT broker.
|
| com.eurotech.framework.net |
Contains interfaces and event model to manage and configure network interfaces on a given system.
|
| com.eurotech.framework.net.dhcp |
Interfaces for all DHCP server instances.
|
| com.eurotech.framework.net.route |
Provides services to manage interfaces and their priorities in the static routing table.
|
| com.eurotech.framework.usb |
Provides services and interfaces for finding and managing USB devices within the system.
|
| Modifier and Type | Class and Description |
|---|---|
class |
EsfConnectException
EsfConnectException is raised during connect failures.
|
class |
EsfNotConnectedException
EsfNotConnectedException is raised when the attempted operation requires
an active connection to the remote server while the current state is
disconnected.
|
class |
EsfPartialSuccessException
EsfPartialSuccessException is used capture the response
of bulk operations which allow for the failures of some
of their steps.
|
class |
EsfStoreCapacityReachedException
EsfStoreCapacityReachedException is raised when a message can not be appended
to the publishing queue as the internal database buffer has reached its
capacity for messages that are not yet published or they are still in transit.
|
class |
EsfStoreException
EsfStoreException is raised when a failure occurred during a persistence operation.
|
class |
EsfTimeoutException
EsfTimeoutException is raised when the attempted operation failed to respond before the timeout exprises.
|
class |
EsfTooManyInflightMessagesException
EsfTooManyInflightMessagesException is raised if a publish is attempted when there are already too many messages queued for publishing.
|
| Modifier and Type | Method and Description |
|---|---|
static EsfException |
EsfException.internalError(String message)
Factory method to build an EdcException with the EdcErrorCode.INTERNAL_ERROR code providing only a message.
|
static EsfException |
EsfException.internalError(Throwable cause)
Factory method to build an EdcException with the EdcErrorCode.INTERNAL_ERROR code providing a cause and a message.
|
static EsfException |
EsfException.internalError(Throwable cause,
String message)
Factory method to build an EdcException with the EdcErrorCode.INTERNAL_ERROR code providing a cause and a message.
|
| Modifier and Type | Method and Description |
|---|---|
Date |
ClockService.getLastSync()
Returns a Date denoting when the clock was synchronized last.
|
| Modifier and Type | Method and Description |
|---|---|
EsfResponsePayload |
CloudCallService.call(String appId,
String appTopic,
EsfPayload appPayload,
int timeout)
Sends a local (to this device) request to a Cloudlet application
with the given application ID waiting for the response.
|
EsfResponsePayload |
CloudCallService.call(String deviceId,
String appId,
String appTopic,
EsfPayload appPayload,
int timeout)
Sends a request to a remote server or device identified by the specified deviceId
and targeting the given application ID waiting for the response.
|
int |
CloudClient.controlPublish(String appTopic,
EsfPayload payload,
int qos,
boolean retain,
int priority)
Publishes a control message to the remote server.
|
int |
CloudClient.controlPublish(String deviceId,
String appTopic,
byte[] payload,
int qos,
boolean retain,
int priority)
Publishes a control message to the remote server addressing it to another device
with a raw byte array payload.
|
int |
CloudClient.controlPublish(String deviceId,
String appTopic,
EsfPayload payload,
int qos,
boolean retain,
int priority)
Publishes a control message to the remote server addressing it to another device.
|
void |
CloudClient.controlSubscribe(String appTopic,
int qos)
Subscribes to a control topic with the remote server.
|
void |
CloudClient.controlUnsubscribe(String appTopic)
Unsubscribes to a control topic with the remote server.
|
protected void |
Cloudlet.doDel(CloudletTopic reqTopic,
EsfRequestPayload reqPayload,
EsfResponsePayload respPayload) |
protected void |
Cloudlet.doExec(CloudletTopic reqTopic,
EsfRequestPayload reqPayload,
EsfResponsePayload respPayload) |
protected void |
Cloudlet.doGet(CloudletTopic reqTopic,
EsfRequestPayload reqPayload,
EsfResponsePayload respPayload) |
protected void |
Cloudlet.doPost(CloudletTopic reqTopic,
EsfRequestPayload reqPayload,
EsfResponsePayload respPayload) |
protected void |
Cloudlet.doPut(CloudletTopic reqTopic,
EsfRequestPayload reqPayload,
EsfResponsePayload respPayload) |
List<Integer> |
CloudClient.getDroppedInFlightMessageIds()
Finds the list of identifiers of in-flight messages that have been dropped.
|
List<Integer> |
CloudClient.getInFlightMessageIds()
Finds the list of identifiers of messages that are still in-flight
(messages published but not confirmed yet).
|
List<Integer> |
CloudClient.getUnpublishedMessageIds()
Gets the list of identifiers of messages that have not been published yet.
|
CloudClient |
CloudService.newCloudClient(String appId)
Returns a new instance of the CloudClient for the given application Id.
|
int |
CloudClient.publish(String appTopic,
byte[] payload,
int qos,
boolean retain,
int priority)
Publishes a message to the remote server with a raw byte array payload.
|
int |
CloudClient.publish(String appTopic,
EsfPayload payload,
int qos,
boolean retain)
Publishes a message to the remote server using the default priority 5.
|
int |
CloudClient.publish(String appTopic,
EsfPayload payload,
int qos,
boolean retain,
int priority)
Publishes a message to the remote server.
|
void |
CloudClient.subscribe(String appTopic,
int qos)
Subscribes to a topic with the remote server.
|
void |
CloudClient.unsubscribe(String appTopic)
Unubscribes to a topic with the remote server.
|
| Modifier and Type | Method and Description |
|---|---|
byte[] |
CommConnection.flushSerialBuffer()
Reads all bytes that are waiting in the serial port buffer and returns them in
an array.
|
byte[] |
CommConnection.sendCommand(byte[] command,
int timeout)
Sends and array of bytes to a CommConnection and returns an array of bytes
that represents the 'response' to the command.
|
byte[] |
CommConnection.sendCommand(byte[] command,
int timeout,
int demark) |
void |
CommConnection.sendMessage(byte[] message)
Sends and array of bytes to a CommConnection
|
| Modifier and Type | Method and Description |
|---|---|
ComponentConfiguration |
ConfigurationService.getComponentConfiguration(String pid)
Returns the ComponentConfiguration for the component identified with specified PID (service's persistent identity).
|
List<ComponentConfiguration> |
ConfigurationService.getComponentConfigurations()
Returns the list of ConfigurableComponents currently registered with the ConfigurationService.
|
ComponentConfiguration |
SelfConfiguringComponent.getConfiguration()
This method is called by the ConfigurationService when it requires
the current snapshot of the configuration for this components.
|
List<ComponentConfiguration> |
ConfigurationService.getSnapshot(long sid)
Loads a snapshot given its ID and return the component configurations stored in that snapshot.
|
Set<Long> |
ConfigurationService.getSnapshots()
Returns the ID of all the snapshots taken by the ConfigurationService.
|
long |
ConfigurationService.rollback()
Rolls back to the last saved snapshot if available.
|
void |
ConfigurationService.rollback(long id)
Rolls back to the specified snapshot id.
|
long |
ConfigurationService.snapshot()
Takes a new snapshot of the current configuration of all the registered ConfigurableCompoenents.
|
void |
ConfigurationService.updateConfiguration(String pid,
Map<String,Object> properties)
Updates the Configuration of the registered component with the specified pid.
|
void |
ConfigurationService.updateConfigurations(List<ComponentConfiguration> configs) |
| Modifier and Type | Method and Description |
|---|---|
DataTransportToken |
DataTransportService.publish(String topic,
byte[] payload,
int qos,
boolean retain)
Enqueues a message for publishing with the underlying transport implementation.
|
void |
DataTransportService.subscribe(String topic,
int qos)
Subscribes to a topic on the broker.
|
void |
DataService.subscribe(String topic,
int qos)
Subscribes to the specified topic with the remote server.
|
void |
DataTransportService.unsubscribe(String topic)
Unsubscribes to a topic on the broker.
|
void |
DataService.unsubscribe(String topic)
Unubscribes to the specified topic with the remote server.
|
| Modifier and Type | Method and Description |
|---|---|
void |
NetworkAdminService.disableInterface(String interfaceName)
Disables the specified interface.
|
void |
NetworkAdminService.enableInterface(String interfaceName,
boolean dhcp)
Enables the specified interface.
|
List<NetInterface<? extends NetInterfaceAddress>> |
NetworkService.getActiveNetworkInterfaces()
Return the active NetworkIntefaces which have active connections for the system.
|
List<String> |
NetworkService.getAllNetworkInterfaceNames()
Gets the names of all the network interface attached to the system.
|
List<WifiAccessPoint> |
NetworkService.getAllWifiAccessPoints()
Returns the list of all available WifiAccessPoints as seen from the system.
|
List<NetConfig> |
NetworkAdminService.getFirewallConfiguration()
Gets the firewall configuration of the system as currently specified
|
String |
NetworkService.getModemPppPort(ModemDevice modemDevice) |
List<? extends NetInterfaceConfig<? extends NetInterfaceAddressConfig>> |
NetworkAdminService.getNetworkInterfaceConfigs()
Returns a list of all of the configurations associated with all of the interfaces on
the system.
|
List<NetConfig> |
NetworkAdminService.getNetworkInterfaceConfigs(String interfaceName)
Returns the configuration information for the specified NetworkInterface name.
|
List<NetInterface<? extends NetInterfaceAddress>> |
NetworkService.getNetworkInterfaces()
Gets the names of all the network interface attached to the system.
|
NetworkState |
NetworkService.getState()
Returns the overall state of the networking subsystem
|
NetInterfaceState |
NetworkService.getState(String interfaceName)
Returns the state of a specific network interface
|
List<WifiAccessPoint> |
NetworkService.getWifiAccessPoints(String wifiInterfaceName)
Returns the list of the WifiAccessPoints visible from the specified wifi network interface.
|
void |
NetworkAdminService.manageDhcpServer(String interfaceName,
boolean enable)
Used to control DHCP servers on specified interfaces.
|
void |
NetworkAdminService.manageFirewall(String gatewayIface)
Updates the Firewall configuration based on current environmental conditions.
|
void |
NetworkAdminService.renewDhcpLease(String interfaceName)
Releases current IP address and acquires a new lease for the provided interface.
|
void |
NetConfigIP.setAddress(T address)
Sets the static address to be assigned to the interface.
|
void |
NetworkAdminService.setFirewallOpenPortConfiguration(List<FirewallOpenPortConfigIP<? extends IPAddress>> firewallConfiguration)
Sets the 'open port' portion of the firewall configuration
|
void |
NetworkAdminService.setFirewallPortForwardingConfiguration(List<FirewallPortForwardConfigIP<? extends IPAddress>> firewallConfiguration)
Sets the 'port forwarding' portion of the firewall configuration
|
void |
NetConfigIP.setNetworkPrefixLength(short networkPrefixLength)
Sets the prefix length to be used for the network interface
|
void |
NetConfigIP.setSubnetMask(T subnetMask)
Sets the subnet mask to be used for the network interface
|
void |
NetworkAdminService.updateEthernetInterfaceConfig(String interfaceName,
boolean autoConnect,
int mtu,
List<NetConfig> netConfigs)
Updates the configuration of the specified EthernetInterface.
|
void |
NetworkAdminService.updateModemInterfaceConfig(String interfaceName,
String serialNum,
String modemId,
int pppNumber,
boolean autoConnect,
int mtu,
List<NetConfig> netConfigs)
Updates the configuration of the specified ModemInterface.
|
void |
NetworkAdminService.updateWifiInterfaceConfig(String interfaceName,
boolean autoConnect,
WifiAccessPoint accessPoint,
List<NetConfig> netConfigs)
Updates the configuration of the specified WifiInterface.
|
| Constructor and Description |
|---|
NetConfigIP4(NetInterfaceStatus status,
boolean autoConnect,
IP4Address address,
IP4Address subnetMask,
IP4Address gateway) |
NetConfigIP4(NetInterfaceStatus status,
boolean autoConnect,
IP4Address address,
short networkPrefixLength,
IP4Address gateway) |
NetConfigIP6(NetInterfaceStatus status,
boolean autoConnect,
IP6Address address,
IP6Address subnetMask,
IP6Address gateway)
Constructor for a Static Configuration for a
network interface based on IPv6 addresses.
|
NetConfigIP6(NetInterfaceStatus status,
boolean autoConnect,
IP6Address address,
short networkPrefixLength,
IP6Address gateway)
Constructor for a Static Configuration for a
network interface based on IPv6 addresses.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
DhcpServer.isRunning()
Returns whether or not the DhcpServer is actively running or not
|
| Modifier and Type | Method and Description |
|---|---|
void |
RoutingAgentService.addInterface(NetInterfaceConfig netIfaceConfig)
Adds interface to RoutingAgent
|
String |
RoutingAgentService.getDefaultGateway()
Get the default gateway
|
void |
RoutingAgentService.removeInterface(String interfaceName)
Removes interface from RoutingAgent
|
| Modifier and Type | Method and Description |
|---|---|
UsbServices |
UsbService.getUsbServices()
Gets the UsbServices currently available as specified by JSR-80 in the javax.usb
|
Copyright © 2013. All Rights Reserved.