de.fhg.ipa.vfk.msb.client.websocket

Class MsbClient

java.lang.Object

de.fhg.ipa.vfk.msb.client.websocket.MsbClient

All Implemented Interfaces:

AutoCloseable

public class MsbClient
extends Object
implements AutoCloseable

The type Client to establish a connection with an MSB instance.

Author:

des

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MsbClient.Builder The type Builder to build a client.

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	hostnameVerification The constant hostnameVerification.

Constructor Summary

Constructors

Constructor and Description
MsbClient(String url) Instantiates a new Client.
MsbClient(String url, int eventCacheSize) Instantiates a new Msb client.
MsbClient(String url, int eventCacheSize, int websocketTextMessageSize) Instantiates a new Msb client.
MsbClient(String url, int eventCacheSize, int websocketTextMessageSize, int functionCallExecutorPoolSize) Instantiates a new Msb client.

Method Summary

Modifier and Type	Method and Description
void	close()
Future<MsbClientHandler>	connect() Start the client, which opens and hold a connection to MSB.
static void	disableHostnameVerification(boolean disable) Disable hostname checking when establishing a secure connection, if self-signed certificates are used or an ip is used instead of a domain name.
void	disconnect() Stop client and close connection to MSB.
MsbClientHandler	getClientHandler() Get client handler to interact with the connected MSB instance.
int	getEventCacheSize() Gets event cache size.
int	getReconnectInterval() Gets reconnect interval.
String	getUrl() Gets url.
int	getWebsocketTextMessageSize() Gets websocket text message size.
boolean	isAutoReconnect() Is auto reconnect boolean.
boolean	isConnected() Checks if is connected.
boolean	isDataFormatValidation() Is data format validation boolean.
boolean	isEventCache() Is event cache boolean.
boolean	isHostnameVerificationDisabled() Is hostname verification enabled.
boolean	isInvokableFunctionCalls() Is invokable function calls boolean.
boolean	isRegistered() Is registered boolean.
void	setAutoReconnect(boolean autoReconnect) Sets auto reconnect.
void	setDataFormatValidation(boolean dataFormatValidationEnabled) Set data format validation.
void	setEventCache(boolean eventCacheEnabled) Set event cache.
void	setInvokableFunctionCalls(boolean invokable) Sets invokable function calls.
void	setReconnectInterval(int millis) Sets reconnect interval, it must be greater than 3000 milliseconds.
void	setTrustStore(String trustStorePath, String trustStorePwd) Sets trust store for secure connection over wss/https.

Methods inherited from class java.lang.Object

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

Field Detail

hostnameVerification

protected static boolean hostnameVerification

The constant hostnameVerification.

Constructor Detail

MsbClient

public MsbClient(String url)

Instantiates a new Client.

Parameters:

url - the url of MSB websocket interface

MsbClient

public MsbClient(String url,
                 int eventCacheSize)

Instantiates a new Msb client.

Parameters:

url - the url

eventCacheSize - the event cache size

MsbClient

public MsbClient(String url,
                 int eventCacheSize,
                 int websocketTextMessageSize)

Instantiates a new Msb client.

Parameters:

url - the url

eventCacheSize - the event cache size

websocketTextMessageSize - the websocket text message size

MsbClient

public MsbClient(String url,
                 int eventCacheSize,
                 int websocketTextMessageSize,
                 int functionCallExecutorPoolSize)

Instantiates a new Msb client.

Parameters:

url - the url

eventCacheSize - the event cache size

websocketTextMessageSize - the websocket text message size

functionCallExecutorPoolSize - the function call executor pool size

Method Detail

setTrustStore

public void setTrustStore(String trustStorePath,
                          String trustStorePwd)

Sets trust store for secure connection over wss/https. Alternatively use the following system property to inject trust store. System.setProperty("javax.net.ssl.trustStore", "[path to trust store].trs");

Parameters:

trustStorePath - the trust store path

trustStorePwd - the trust store pwd

disableHostnameVerification

public static void disableHostnameVerification(boolean disable)

Disable hostname checking when establishing a secure connection, if self-signed certificates are used or an ip is used instead of a domain name.

Parameters:

disable - the disable

isHostnameVerificationDisabled

public boolean isHostnameVerificationDisabled()

Is hostname verification enabled.

Returns:

the boolean

getUrl

public String getUrl()

Gets url.

Returns:

the url

getEventCacheSize

public int getEventCacheSize()

Gets event cache size.

Returns:

the event cache size

getWebsocketTextMessageSize

public int getWebsocketTextMessageSize()

Gets websocket text message size.

Returns:

the websocket text message size

getClientHandler

public MsbClientHandler getClientHandler()

Get client handler to interact with the connected MSB instance.

Returns:

the client handler

isInvokableFunctionCalls

public boolean isInvokableFunctionCalls()

Is invokable function calls boolean.

Returns:

the boolean

setInvokableFunctionCalls

public void setInvokableFunctionCalls(boolean invokable)

Sets invokable function calls.

Parameters:

invokable - the invokable

isEventCache

public boolean isEventCache()

Is event cache boolean.

Returns:

the boolean

setEventCache

public void setEventCache(boolean eventCacheEnabled)

Set event cache.

Parameters:

eventCacheEnabled - the event cache enabled

isAutoReconnect

public boolean isAutoReconnect()

Is auto reconnect boolean.

Returns:

the boolean

setAutoReconnect

public void setAutoReconnect(boolean autoReconnect)

Sets auto reconnect.

Parameters:

autoReconnect - the auto reconnect

setReconnectInterval

public void setReconnectInterval(int millis)

Sets reconnect interval, it must be greater than 3000 milliseconds.

Parameters:

millis - the millis

getReconnectInterval

public int getReconnectInterval()

Gets reconnect interval.

Returns:

the reconnect interval

isDataFormatValidation

public boolean isDataFormatValidation()

Is data format validation boolean.

Returns:

the boolean

setDataFormatValidation

public void setDataFormatValidation(boolean dataFormatValidationEnabled)

Set data format validation.

Parameters:

dataFormatValidationEnabled - the data format validation enabled

connect

public Future<MsbClientHandler> connect()

Start the client, which opens and hold a connection to MSB. After connection is established, this method returns a client handler to interact with the connected MSB instance.

Returns:

the client handler

isConnected

public boolean isConnected()

Checks if is connected.

Returns:

true, if is connected

isRegistered

public boolean isRegistered()

Is registered boolean.

Returns:

the boolean

disconnect

public void disconnect()

Stop client and close connection to MSB.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception