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

Interface MsbClientHandler

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

MsbClientWebSocketHandler

public interface MsbClientHandler
extends AutoCloseable

The Interface MsbClientHandler.

Author:

des

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	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.
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[] functionHandlers, 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[] functionHandlers, 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.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

addFunction

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

Adds a function to the given self-description.

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

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

Adds a event to the given self-description.

Parameters:

selfDescription - the self description

eventId - the event id

name - the name

description - the description

dataType - the data type

priority - the event priority

addConfigParam

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

Add configuration parameter.

Parameters:

configParamId - the configuration parameter id

value - the value

format - the format

addConfigParam

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

Add configuration parameter.

Parameters:

configParamId - the configuration parameter id

value - the value

type - the type

addManagedService

void addManagedService(Service subService)

Add managed service. Only useful for a gateway service.

Parameters:

subService - the sub service

register

void register(String packagePath)
       throws IOException

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

Parameters:

packagePath - the package path

Throws:

IOException - the io exception

register

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

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.

Parameters:

packagePath - the package path

functionHandler - the function handler

Throws:

IOException - the io exception

register

void register(Service selfDescription)
       throws IOException

Register a service.

Parameters:

selfDescription - the self description

Throws:

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

register

void register(Service selfDescription,
              String packagePath)
       throws IOException

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

Parameters:

selfDescription - the self description

packagePath - the package path

Throws:

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

register

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

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

Parameters:

selfDescription - the self description

functionHandler - the function handler

Throws:

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

register

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

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.

Parameters:

selfDescription - the self description

functionHandlers - the function handlers

packagePath - the package path

Throws:

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

register

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

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

Parameters:

selfDescription - the self description

functionHandlers - the function handlers

eventDeclarations - the event declarations

Throws:

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

publish

void publish(String eventId)
      throws IOException

Publish a event of the registered service.

Parameters:

eventId - the event id

Throws:

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

publish

void publish(String eventId,
             Object obj)
      throws IOException

Publish a event of the registered service.

Parameters:

eventId - the event id

obj - the obj

Throws:

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

publish

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

Publish a event of the registered service.

Parameters:

eventId - the event id

obj - the obj

priority - the priority

Throws:

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

publish

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

Publish a event of the registered service.

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

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

Publish a event of the registered service.

Parameters:

eventId - the event id

obj - the obj

priority - the priority

cache - the cache

postDate - the post date

Throws:

IOException - the io exception

publish

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

Publish.

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

void publishForService(String serviceUuid,
                       String eventId)
                throws IOException

Publish a event for the given service uuid.

Parameters:

serviceUuid - the service uuid

eventId - the event id

Throws:

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

publishForService

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

Publish a event for the given service uuid.

Parameters:

serviceUuid - the service uuid

eventId - the event id

obj - the obj

Throws:

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

publishForService

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

Publish a event for the given service uuid.

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

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

Publish a event for the given service uuid.

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

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

Publish a event for the given service uuid.

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

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

Publish for service.

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

void addFunctionCallsListener(FunctionCallsListener functionCallsListener)

Adds the function calls listener.

Parameters:

functionCallsListener - the function calls listener

removeFunctionCallsListener

void removeFunctionCallsListener(FunctionCallsListener functionCallsListener)

Removes the function calls listener.

Parameters:

functionCallsListener - the function calls listener

addConnectionListener

void addConnectionListener(ConnectionListener connectionListener)

Adds the connection listener.

Parameters:

connectionListener - the connection listener

removeConnectionListener

void removeConnectionListener(ConnectionListener connectionListener)

Removes the connection listener.

Parameters:

connectionListener - the connection listener

addConfigurationListener

void addConfigurationListener(ConfigurationListener configurationListener)

Adds the configuration listener.

Parameters:

configurationListener - the configuration listener

removeConfigurationListener

void removeConfigurationListener(ConfigurationListener configurationListener)

Removes the configuration listener.

Parameters:

configurationListener - the configuration listener