com.clover.remote.client

Interface CloverDeviceConfiguration

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

WebSocketCloverDeviceConfiguration

public interface CloverDeviceConfiguration
extends java.io.Serializable

Interface which defines the configuration of the underlying transport for connecting to a Clover device.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApplicationId() Retrieve the application ID broadcast on all messages sent to the remote device
java.lang.String	getCloverDeviceTypeName() Retrieve the class name of the clover device instantiated during the CloverConnector.initializeConnection() call.
ICloverTransport	getCloverTransport() Retrieve the configuration specified transport (e.g.
int	getMaxMessageCharacters() Retrieve the max message characters
java.lang.String	getMessagePackageName() Retrieve the package name broadcast on all messages sent to the remote device
java.lang.String	getName() Retrieve the device configuration name

Method Detail

getCloverDeviceTypeName

java.lang.String getCloverDeviceTypeName()

Retrieve the class name of the clover device instantiated during the CloverConnector.initializeConnection() call.

Returns:

the canonical class name

getMessagePackageName

java.lang.String getMessagePackageName()

Retrieve the package name broadcast on all messages sent to the remote device

Returns:

package name

getName

java.lang.String getName()

Retrieve the device configuration name

Returns:

name

getMaxMessageCharacters

int getMaxMessageCharacters()

Retrieve the max message characters

Returns:

max numner characters

getCloverTransport

ICloverTransport getCloverTransport()

Retrieve the configuration specified transport (e.g. network, etc.) associated with this configuration. Note that the underlying connection for the transport is not made as a part of this call.

Returns:

disconnected transport

getApplicationId

java.lang.String getApplicationId()

Retrieve the application ID broadcast on all messages sent to the remote device

Returns:

application ID