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

Class MsbClientWebSocketHandler

java.lang.Object

org.springframework.web.socket.handler.AbstractWebSocketHandler

org.springframework.web.socket.handler.TextWebSocketHandler

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

All Implemented Interfaces:

MsbClientHandler, AutoCloseable, org.springframework.web.socket.WebSocketHandler

public class MsbClientWebSocketHandler
extends org.springframework.web.socket.handler.TextWebSocketHandler
implements MsbClientHandler

The Class MsbClientWebSocketHandler to interacted with a connected MSB instance.

Author:

des

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MsbClientWebSocketHandler() Instantiates a new client web socket handler.
protected	MsbClientWebSocketHandler(String url) Instantiates a new client web socket handler.
protected	MsbClientWebSocketHandler(String url, int eventCacheSize) Instantiates a new Msb client web socket handler.
protected	MsbClientWebSocketHandler(String url, int eventCacheSize, int websocketTextMessageSize) Instantiates a new Msb client web socket handler.
protected	MsbClientWebSocketHandler(String url, int eventCacheSize, int websocketTextMessageSize, int functionCallExecutorPoolSize) Instantiates a new Msb client web socket handler.

Method Summary

Modifier and Type	Method and Description
void	addConfigParam(String configParamId, Object value, PrimitiveFormat format) Add configuration parameter.
void	addConfigParam(String configParamId, Object value, PrimitiveType type) Add configuration parameter.
void	addConfigurationListener(ConfigurationListener configurationListener) Adds the configuration listener.
void	addConnectionListener(ConnectionListener connectionListener) Adds the connection listener.
void	addEvent(Service selfDescription, String eventId, String name, String description, Class<?> dataType, EventPriority priority) Adds a event to the given self-description.
void	addFunction(Service selfDescription, String functionId, String name, String description, String[] responseEventIds, Object functionHandlerInstance, Method method) Adds a function to the given self-description.
void	addFunctionCallsListener(FunctionCallsListener functionCallsListener) Adds the function calls listener.
void	addManagedService(Service subService) Add managed service.
void	afterConnectionClosed(org.springframework.web.socket.WebSocketSession session, org.springframework.web.socket.CloseStatus status) After connection closed.
void	afterConnectionEstablished(org.springframework.web.socket.WebSocketSession session) After connection established.
void	close() Close.
protected void	closeConnection(boolean interrupt) Close connection.
protected boolean	establishConnection() Establish connection.
protected int	getEventCacheSize() Gets event cache size.
protected int	getReconnectInterval() Get reconnect interval int.
protected String	getUrl() Get url string.
protected int	getWebsocketTextMessageSize() Gets websocket text message size.
void	handleTextMessage(org.springframework.web.socket.WebSocketSession session, org.springframework.web.socket.TextMessage message) Handle text message.
protected boolean	isAutoReconnect() Is auto reconnect boolean.
protected boolean	isConnected() Checks if is connected.
protected boolean	isDataFormatValidation() Is data format validation boolean.
protected boolean	isEventCacheEnabled() Is event cache enabled boolean.
protected boolean	isInvokableFunctionCalls() Is invokable function calls boolean.
protected boolean	isRegistered() Is registered boolean.
void	publish(String eventId) Publish a event of the registered service.
void	publish(String eventId, Object obj) Publish a event of the registered service.
void	publish(String eventId, Object obj, EventPriority priority) Publish a event of the registered service.
void	publish(String eventId, Object obj, EventPriority priority, boolean cache) Publish a event of the registered service.
void	publish(String eventId, Object obj, EventPriority priority, boolean cache, Date postDate) Publish a event of the registered service.
void	publish(String eventId, Object obj, EventPriority priority, boolean cache, Date postDate, String correlationId) Publish.
void	publishForService(String serviceUuid, String eventId) Publish a event for the given service uuid.
void	publishForService(String serviceUuid, String eventId, Object obj) Publish a event for the given service uuid.
void	publishForService(String serviceUuid, String eventId, Object obj, EventPriority priority) Publish a event for the given service uuid.
void	publishForService(String serviceUuid, String eventId, Object obj, EventPriority priority, boolean cache) Publish a event for the given service uuid.
void	publishForService(String serviceUuid, String eventId, Object obj, EventPriority priority, boolean cache, Date postDate) Publish a event for the given service uuid.
void	publishForService(String serviceUuid, String eventId, Object obj, EventPriority priority, boolean cache, Date postDate, String correlationId) Publish for service.
protected void	reconnect() Reconnect.
void	register(Service selfDescription) Register a service.
void	register(Service selfDescription, Object[] functionHandler) Register a service and use the instantiated function handlers to invoke function calls.
void	register(Service selfDescription, Object[] functionHandler, Class<?>[] eventDeclarations) Register a service, use the instantiated function handlers to invoke function calls and scan event declaration classes for annotated events.
void	register(Service selfDescription, Object[] functionHandler, String packagePath) Register a service, use the instantiated function handlers to invoke function calls and scan the package path for annotated events and configuration parameters..
void	register(Service selfDescription, String packagePath) Register a service and scan the package path for annotated events, functions and configuration parameters.
void	register(String packagePath) Register a service by scanning the package path for annotated events, functions, configuration parameters and self description.
void	register(String packagePath, Object[] functionHandler) Register a service by scanning the package path for annotated events, functions, configuration parameters and self description.
void	removeConfigurationListener(ConfigurationListener configurationListener) Removes the configuration listener.
void	removeConnectionListener(ConnectionListener connectionListener) Removes the connection listener.
void	removeFunctionCallsListener(FunctionCallsListener functionCallsListener) Removes the function calls listener.
protected void	setAutoReconnect(boolean autoReconnect) Sets auto reconnect.
protected void	setDataFormatValidation(boolean dataFormatValidationEnabled) Set data format validation.
protected void	setEventCacheEnabled(boolean eventCacheEnabled) Sets event cache enabled.
protected void	setInvokableFunctionCalls(boolean invokable) Sets invokable function calls.
protected void	setReconnectInterval(int millis) Set reconnect interval.
protected void	setTrustStore(String trustStorePath, String trustStorePwd) Sets trust store.

Methods inherited from class org.springframework.web.socket.handler.TextWebSocketHandler

handleBinaryMessage

Methods inherited from class org.springframework.web.socket.handler.AbstractWebSocketHandler

handleMessage, handlePongMessage, handleTransportError, supportsPartialMessages

Methods inherited from class java.lang.Object

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

Constructor Detail

MsbClientWebSocketHandler

protected MsbClientWebSocketHandler()

Instantiates a new client web socket handler.

MsbClientWebSocketHandler

protected MsbClientWebSocketHandler(String url)

Instantiates a new client web socket handler.

Parameters:

url - the url

MsbClientWebSocketHandler

protected MsbClientWebSocketHandler(String url,
                                    int eventCacheSize)

Instantiates a new Msb client web socket handler.

Parameters:

url - the url

eventCacheSize - the event cache size

MsbClientWebSocketHandler

protected MsbClientWebSocketHandler(String url,
                                    int eventCacheSize,
                                    int websocketTextMessageSize)

Instantiates a new Msb client web socket handler.

Parameters:

url - the url

eventCacheSize - the event cache size

websocketTextMessageSize - the websocket text message size

MsbClientWebSocketHandler

protected MsbClientWebSocketHandler(String url,
                                    int eventCacheSize,
                                    int websocketTextMessageSize,
                                    int functionCallExecutorPoolSize)

Instantiates a new Msb client web socket handler.

Parameters:

url - the url

eventCacheSize - the event cache size

websocketTextMessageSize - the websocket text message size

functionCallExecutorPoolSize - the function call executor pool size

Method Detail

afterConnectionEstablished

public void afterConnectionEstablished(org.springframework.web.socket.WebSocketSession session)
                                throws Exception

After connection established.

Specified by:

afterConnectionEstablished in interface org.springframework.web.socket.WebSocketHandler

Overrides:

afterConnectionEstablished in class org.springframework.web.socket.handler.AbstractWebSocketHandler

Parameters:

session - the session

Throws:

Exception

handleTextMessage

public void handleTextMessage(org.springframework.web.socket.WebSocketSession session,
                              org.springframework.web.socket.TextMessage message)
                       throws Exception

Handle text message.

Overrides:

handleTextMessage in class org.springframework.web.socket.handler.AbstractWebSocketHandler

Parameters:

session - the session

message - the message

Throws:

Exception - the exception

afterConnectionClosed

public void afterConnectionClosed(org.springframework.web.socket.WebSocketSession session,
                                  org.springframework.web.socket.CloseStatus status)
                           throws Exception

After connection closed.

Specified by:

afterConnectionClosed in interface org.springframework.web.socket.WebSocketHandler

Overrides:

afterConnectionClosed in class org.springframework.web.socket.handler.AbstractWebSocketHandler

Parameters:

session - the session

status - the status

Throws:

Exception - the exception

getUrl

protected String getUrl()

Get url string.

Returns:

the string

getEventCacheSize

protected int getEventCacheSize()

Gets event cache size.

Returns:

the event cache size

getWebsocketTextMessageSize

protected int getWebsocketTextMessageSize()

Gets websocket text message size.

Returns:

the websocket text message size

setTrustStore

protected void setTrustStore(String trustStorePath,
                             String trustStorePwd)

Sets trust store.

Parameters:

trustStorePath - the trust store path

trustStorePwd - the trust store pwd

isRegistered

protected boolean isRegistered()

Is registered boolean.

Returns:

the boolean

isEventCacheEnabled

protected boolean isEventCacheEnabled()

Is event cache enabled boolean.

Returns:

the boolean

setEventCacheEnabled

protected void setEventCacheEnabled(boolean eventCacheEnabled)

Sets event cache enabled.

Parameters:

eventCacheEnabled - the event cache enabled

isAutoReconnect

protected boolean isAutoReconnect()

Is auto reconnect boolean.

Returns:

the boolean

setAutoReconnect

protected void setAutoReconnect(boolean autoReconnect)

Sets auto reconnect.

Parameters:

autoReconnect - the auto reconnect

setReconnectInterval

protected void setReconnectInterval(int millis)

Set reconnect interval.

Parameters:

millis - the millis

getReconnectInterval

protected int getReconnectInterval()

Get reconnect interval int.

Returns:

the int

isInvokableFunctionCalls

protected boolean isInvokableFunctionCalls()

Is invokable function calls boolean.

Returns:

the boolean

setInvokableFunctionCalls

protected void setInvokableFunctionCalls(boolean invokable)

Sets invokable function calls.

Parameters:

invokable - the invokable

isDataFormatValidation

protected boolean isDataFormatValidation()

Is data format validation boolean.

Returns:

the boolean

setDataFormatValidation

protected void setDataFormatValidation(boolean dataFormatValidationEnabled)

Set data format validation.

Parameters:

dataFormatValidationEnabled - the data format validation enabled

establishConnection

protected boolean establishConnection()

Establish connection.

Returns:

the client handler

isConnected

protected boolean isConnected()

Checks if is connected.

Returns:

true, if is connected

reconnect

protected void reconnect()
                  throws IOException

Reconnect.

Throws:

IOException - Signals that an I/O exception has occurred.

closeConnection

protected void closeConnection(boolean interrupt)

Close connection.

Parameters:

interrupt - the interrupt

close

public void close()
           throws Exception

Close.

Specified by:

close in interface AutoCloseable

Throws:

Exception - the exception

See Also:

AutoCloseable.close()

addFunction

public void addFunction(Service selfDescription,
                        String functionId,
                        String name,
                        String description,
                        String[] responseEventIds,
                        Object functionHandlerInstance,
                        Method method)

Description copied from interface: MsbClientHandler

Adds a function to the given self-description.

Specified by:

addFunction in interface MsbClientHandler

Parameters:

selfDescription - the self description

functionId - the function id

name - the name

description - the description

responseEventIds - the response event ids

functionHandlerInstance - the function handler instance

method - the method

addEvent

public void addEvent(Service selfDescription,
                     String eventId,
                     String name,
                     String description,
                     Class<?> dataType,
                     EventPriority priority)

Description copied from interface: MsbClientHandler

Adds a event to the given self-description.

Specified by:

addEvent in interface MsbClientHandler

Parameters:

selfDescription - the self description

eventId - the event id

name - the name

description - the description

dataType - the data type

priority - the event priority

addConfigParam

public void addConfigParam(String configParamId,
                           Object value,
                           PrimitiveFormat format)

Description copied from interface: MsbClientHandler

Add configuration parameter.

Specified by:

addConfigParam in interface MsbClientHandler

Parameters:

configParamId - the configuration parameter id

value - the value

format - the format

addConfigParam

public void addConfigParam(String configParamId,
                           Object value,
                           PrimitiveType type)

Description copied from interface: MsbClientHandler

Add configuration parameter.

Specified by:

addConfigParam in interface MsbClientHandler

Parameters:

configParamId - the configuration parameter id

value - the value

type - the type

addManagedService

public void addManagedService(Service subService)

Description copied from interface: MsbClientHandler

Add managed service. Only useful for a gateway service.

Specified by:

addManagedService in interface MsbClientHandler

Parameters:

subService - the sub service

register

public void register(String packagePath)
              throws IOException

Description copied from interface: MsbClientHandler

Register a service by scanning the package path for annotated events, functions, configuration parameters and self description.

Specified by:

register in interface MsbClientHandler

Parameters:

packagePath - the package path

Throws:

IOException - the io exception

register

public void register(String packagePath,
                     Object[] functionHandler)
              throws IOException

Description copied from interface: MsbClientHandler

Register a service by scanning the package path for annotated events, functions, configuration parameters and self description. And use the instantiated function handlers to invoke function calls.

Specified by:

register in interface MsbClientHandler

Parameters:

packagePath - the package path

functionHandler - the function handler

Throws:

IOException - the io exception

register

public void register(Service selfDescription,
                     String packagePath)
              throws IOException

Description copied from interface: MsbClientHandler

Register a service and scan the package path for annotated events, functions and configuration parameters.

Specified by:

register in interface MsbClientHandler

Parameters:

selfDescription - the self description

packagePath - the package path

Throws:

IOException - Signals that an I/O exception has occurred.

register

public void register(Service selfDescription,
                     Object[] functionHandler)
              throws IOException

Description copied from interface: MsbClientHandler

Register a service and use the instantiated function handlers to invoke function calls.

Specified by:

register in interface MsbClientHandler

Parameters:

selfDescription - the self description

functionHandler - the function handler

Throws:

IOException - Signals that an I/O exception has occurred.

register

public void register(Service selfDescription,
                     Object[] functionHandler,
                     String packagePath)
              throws IOException

Description copied from interface: MsbClientHandler

Register a service, use the instantiated function handlers to invoke function calls and scan the package path for annotated events and configuration parameters.. Register a service and scan the package path for annotated events, functions and configuration parameters.

Specified by:

register in interface MsbClientHandler

Parameters:

selfDescription - the self description

functionHandler - the function handlers

packagePath - the package path

Throws:

IOException - Signals that an I/O exception has occurred.

register

public void register(Service selfDescription,
                     Object[] functionHandler,
                     Class<?>[] eventDeclarations)
              throws IOException

Description copied from interface: MsbClientHandler

Register a service, use the instantiated function handlers to invoke function calls and scan event declaration classes for annotated events.

Specified by:

register in interface MsbClientHandler

Parameters:

selfDescription - the self description

functionHandler - the function handlers

eventDeclarations - the event declarations

Throws:

IOException - Signals that an I/O exception has occurred.

register

public void register(Service selfDescription)
              throws IOException

Description copied from interface: MsbClientHandler

Register a service.

Specified by:

register in interface MsbClientHandler

Parameters:

selfDescription - the self description

Throws:

IOException - Signals that an I/O exception has occurred.

publish

public void publish(String eventId)
             throws IOException

Description copied from interface: MsbClientHandler

Publish a event of the registered service.

Specified by:

publish in interface MsbClientHandler

Parameters:

eventId - the event id

Throws:

IOException - Signals that an I/O exception has occurred.

publish

public void publish(String eventId,
                    Object obj)
             throws IOException

Description copied from interface: MsbClientHandler

Publish a event of the registered service.

Specified by:

publish in interface MsbClientHandler

Parameters:

eventId - the event id

obj - the obj

Throws:

IOException - Signals that an I/O exception has occurred.

publish

public void publish(String eventId,
                    Object obj,
                    EventPriority priority)
             throws IOException

Description copied from interface: MsbClientHandler

Publish a event of the registered service.

Specified by:

publish in interface MsbClientHandler

Parameters:

eventId - the event id

obj - the obj

priority - the priority

Throws:

IOException - Signals that an I/O exception has occurred.

publish

public void publish(String eventId,
                    Object obj,
                    EventPriority priority,
                    boolean cache)
             throws IOException

Description copied from interface: MsbClientHandler

Publish a event of the registered service.

Specified by:

publish in interface MsbClientHandler

Parameters:

eventId - the event id

obj - the obj

priority - the priority

cache - the cache

Throws:

IOException - Signals that an I/O exception has occurred.

publish

public void publish(String eventId,
                    Object obj,
                    EventPriority priority,
                    boolean cache,
                    Date postDate)
             throws IOException

Description copied from interface: MsbClientHandler

Publish a event of the registered service.

Specified by:

publish in interface MsbClientHandler

Parameters:

eventId - the event id

obj - the obj

priority - the priority

cache - the cache

postDate - the post date

Throws:

IOException - the io exception

publish

public void publish(String eventId,
                    Object obj,
                    EventPriority priority,
                    boolean cache,
                    Date postDate,
                    String correlationId)
             throws IOException

Description copied from interface: MsbClientHandler

Publish.

Specified by:

publish in interface MsbClientHandler

Parameters:

eventId - the event id

obj - the obj

priority - the priority

cache - the cache

postDate - the post date

correlationId - the correlation id

Throws:

IOException - the io exception

publishForService

public void publishForService(String serviceUuid,
                              String eventId)
                       throws IOException

Description copied from interface: MsbClientHandler

Publish a event for the given service uuid.

Specified by:

publishForService in interface MsbClientHandler

Parameters:

serviceUuid - the service uuid

eventId - the event id

Throws:

IOException - Signals that an I/O exception has occurred.

publishForService

public void publishForService(String serviceUuid,
                              String eventId,
                              Object obj)
                       throws IOException

Description copied from interface: MsbClientHandler

Publish a event for the given service uuid.

Specified by:

publishForService in interface MsbClientHandler

Parameters:

serviceUuid - the service uuid

eventId - the event id

obj - the obj

Throws:

IOException - Signals that an I/O exception has occurred.

publishForService

public void publishForService(String serviceUuid,
                              String eventId,
                              Object obj,
                              EventPriority priority)
                       throws IOException

Description copied from interface: MsbClientHandler

Publish a event for the given service uuid.

Specified by:

publishForService in interface MsbClientHandler

Parameters:

serviceUuid - the service uuid

eventId - the event id

obj - the obj

priority - the priority

Throws:

IOException - Signals that an I/O exception has occurred.

publishForService

public void publishForService(String serviceUuid,
                              String eventId,
                              Object obj,
                              EventPriority priority,
                              boolean cache)
                       throws IOException

Description copied from interface: MsbClientHandler

Publish a event for the given service uuid.

Specified by:

publishForService in interface MsbClientHandler

Parameters:

serviceUuid - the service uuid

eventId - the event id

obj - the obj

priority - the priority

cache - the cache

Throws:

IOException - Signals that an I/O exception has occurred.

publishForService

public void publishForService(String serviceUuid,
                              String eventId,
                              Object obj,
                              EventPriority priority,
                              boolean cache,
                              Date postDate)
                       throws IOException

Description copied from interface: MsbClientHandler

Publish a event for the given service uuid.

Specified by:

publishForService in interface MsbClientHandler

Parameters:

serviceUuid - the service uuid

eventId - the event id

obj - the obj

priority - the priority

cache - the cache

postDate - the post date

Throws:

IOException - the io exception

publishForService

public void publishForService(String serviceUuid,
                              String eventId,
                              Object obj,
                              EventPriority priority,
                              boolean cache,
                              Date postDate,
                              String correlationId)
                       throws IOException

Description copied from interface: MsbClientHandler

Publish for service.

Specified by:

publishForService in interface MsbClientHandler

Parameters:

serviceUuid - the service uuid

eventId - the event id

obj - the obj

priority - the priority

cache - the cache

postDate - the post date

correlationId - the correlation id

Throws:

IOException - the io exception

addFunctionCallsListener

public void addFunctionCallsListener(FunctionCallsListener functionCallsListener)

Description copied from interface: MsbClientHandler

Adds the function calls listener.

Specified by:

addFunctionCallsListener in interface MsbClientHandler

Parameters:

functionCallsListener - the function calls listener

removeFunctionCallsListener

public void removeFunctionCallsListener(FunctionCallsListener functionCallsListener)

Description copied from interface: MsbClientHandler

Removes the function calls listener.

Specified by:

removeFunctionCallsListener in interface MsbClientHandler

Parameters:

functionCallsListener - the function calls listener

addConnectionListener

public void addConnectionListener(ConnectionListener connectionListener)

Adds the connection listener.

Specified by:

addConnectionListener in interface MsbClientHandler

Parameters:

connectionListener - the connection listener

See Also:

MsbClientHandler.addConnectionListener(ConnectionListener)

removeConnectionListener

public void removeConnectionListener(ConnectionListener connectionListener)

Removes the connection listener.

Specified by:

removeConnectionListener in interface MsbClientHandler

Parameters:

connectionListener - the connection listener

See Also:

MsbClientHandler.removeConnectionListener(ConnectionListener)

addConfigurationListener

public void addConfigurationListener(ConfigurationListener configurationListener)

Adds the configuration listener.

Specified by:

addConfigurationListener in interface MsbClientHandler

Parameters:

configurationListener - the configuration listener

See Also:

MsbClientHandler.addConfigurationListener(ConfigurationListener)

removeConfigurationListener

public void removeConfigurationListener(ConfigurationListener configurationListener)

Removes the configuration listener.

Specified by:

removeConfigurationListener in interface MsbClientHandler

Parameters:

configurationListener - the configuration listener

See Also:

MsbClientHandler.removeConfigurationListener(ConfigurationListener)