Package com.clover.remote.client

Class WebSocketCloverDeviceConfiguration

java.lang.Object

com.clover.remote.client.WebSocketCloverDeviceConfiguration

All Implemented Interfaces:

CloverDeviceConfiguration, PairingDeviceConfiguration, Serializable

public abstract class WebSocketCloverDeviceConfiguration
extends Object
implements PairingDeviceConfiguration, CloverDeviceConfiguration, Serializable

Default configuration to communicate with the Mini via WebSockets to the LAN Pay Display

See Also:

• Serialized Form

Field Summary

Fields inherited from interface com.clover.remote.client.CloverDeviceConfiguration

REMOTE_SDK

Constructor Summary

Constructors

Constructor	Description
WebSocketCloverDeviceConfiguration(URI endpoint, String applicationId, KeyStore trustStore)	Constructor
WebSocketCloverDeviceConfiguration(URI endpoint, String applicationId, KeyStore trustStore, String posName, String serialNumber, String authToken)	Constructor
WebSocketCloverDeviceConfiguration(URI endpoint, String applicationId, KeyStore trustStore, String posName, String serialNumber, String authToken, long pongTimeout, long pingFrequency, long reconnectDelay, long reportConnectionProblemAfter)	Constructor

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.clover.remote.client.transport.PairingDeviceConfiguration

onPairingCode, onPairingSuccess

Constructor Details

WebSocketCloverDeviceConfiguration

public WebSocketCloverDeviceConfiguration(URI endpoint,
 String applicationId,
 KeyStore trustStore,
 String posName,
 String serialNumber,
 String authToken)

Constructor

Parameters:

endpoint - network endpoint of the device to connect to

applicationId - remote application ID

trustStore - certificate keystore used to support the secure websockets protocol (wss)

posName - point of sale name

serialNumber - serial number of the POS terminal/device attaching to the clover device

authToken - cached authentication token provided from a previous PairingDeviceConfiguration.onPairingSuccess(String) call Please see WebSocketUtils for help with . Please see WebSocketUtils.createSecureURI(String, String) or WebSocketUtils.createNonsecureURI(String, String) for help with .

WebSocketCloverDeviceConfiguration

public WebSocketCloverDeviceConfiguration(URI endpoint,
 String applicationId,
 KeyStore trustStore)

Constructor

Parameters:

endpoint - The endpoint for the Clover Device.

applicationId - Your application's Remote Application ID

trustStore - A KeyStore containing the device certificates. Please see WebSocketUtils for help with . Please see WebSocketUtils.createSecureURI(String, String) or WebSocketUtils.createNonsecureURI(String, String) for help with .

WebSocketCloverDeviceConfiguration

public WebSocketCloverDeviceConfiguration(URI endpoint,
 String applicationId,
 KeyStore trustStore,
 String posName,
 String serialNumber,
 String authToken,
 long pongTimeout,
 long pingFrequency,
 long reconnectDelay,
 long reportConnectionProblemAfter)

Constructor

Parameters:

endpoint - network endpoint of the device to connect to

applicationId - remote application ID

trustStore - certificate keystore used to support the secure websockets protocol (wss)

posName - point of sale name

serialNumber - serial number of the POS terminal/device attaching to the clover device

authToken - cached authentication token provided from a previous PairingDeviceConfiguration.onPairingSuccess(String) call

pongTimeout - amount of time, in milliseconds, before closing the connection, but still wait

pingFrequency - amount of time, in milliseconds, between pings

reconnectDelay - amount of time, in milliseconds, to wait before attempting to reconnect

reportConnectionProblemAfter - amount of time, in milliseconds, in which a disconnected client is reported if a pong hasn't come back, before it is actually disconnected Please see WebSocketUtils for help with . Please see WebSocketUtils.createSecureURI(String, String) or WebSocketUtils.createNonsecureURI(String, String) for help with .

Method Details

getApplicationId

public String getApplicationId()

Description copied from interface: CloverDeviceConfiguration

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

Specified by:

getApplicationId in interface CloverDeviceConfiguration

Returns:

application ID

getCloverDeviceTypeName

public String getCloverDeviceTypeName()

Description copied from interface: CloverDeviceConfiguration

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

Specified by:

getCloverDeviceTypeName in interface CloverDeviceConfiguration

Returns:

the canonical class name

getMessagePackageName

public String getMessagePackageName()

Description copied from interface: CloverDeviceConfiguration

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

Specified by:

getMessagePackageName in interface CloverDeviceConfiguration

Returns:

package name

getName

public String getName()

Description copied from interface: CloverDeviceConfiguration

Retrieve the device configuration name

Specified by:

getName in interface CloverDeviceConfiguration

Returns:

name

getMaxMessageCharacters

public int getMaxMessageCharacters()

Description copied from interface: CloverDeviceConfiguration

Retrieve the max message characters

Specified by:

getMaxMessageCharacters in interface CloverDeviceConfiguration

Returns:

max numner characters

getCloverTransport

public CloverTransport getCloverTransport()

Description copied from interface: CloverDeviceConfiguration

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.

Specified by:

getCloverTransport in interface CloverDeviceConfiguration

Returns:

disconnected transport