org.sodeac.common.message.dispatcher.api

Interface IChannel<T>

All Known Subinterfaces:

ISubChannel<T>

All Known Implementing Classes:

ChannelImpl, SubChannelImpl

public interface IChannel<T>

API for channels. IChannels are configured by one or more IChannelManagers. All collected IMessages can be processed by IChannelTasks.

Author:

Sebastian Palarus

Method Summary

Modifier and Type	Method and Description
default ISubChannel<?>	createChildScope(UUID scopeId, String scopeName, ISubChannel<?> parentScope, Map<String,Object> configurationProperties, Map<String,Object> stateProperties) create ISubChannel for IChannel
ISubChannel	createChildScope(UUID scopeId, String scopeName, ISubChannel parentScope, Map<String,Object> configurationProperties, Map<String,Object> stateProperties, boolean adoptContoller, boolean adoptServices) create ISubChannel for IChannel
default <T> T	getAdapter(Class<T> adapterClass) get registered adapter
default <T> T	getAdapter(Class<T> adapterClass, Supplier<T> adapterFactoryIfNotExists) get registered adapter
ISubChannel	getChildScope(UUID scopeId) returns scope with given scopeId
List<ISubChannel>	getChildScopes() getter for child scope list.
IPropertyBlock	getConfigurationPropertyBlock() getter for configuration propertyblock of queue
IMessageDispatcher	getDispatcher() getter for global dispatchter service
String	getId() getter for channel id
IMessage	getMessage(String uuid) returns IMessage queued with uuid
DequeSnapshot<IMessage<T>>	getMessageSnapshot() return message snapshot
DequeSnapshot<IMessage<T>>	getMessageSnapshotPoll() return message snapshot-poll (remove returned elements from channel)
IChannel<?>	getRootChannel() returns root scope
IPropertyBlock	getStatePropertyBlock() getter for state propertyblock of queue
IChannelTask	getTask(String id) returns IChannelTask scheduled under registration id
IPropertyBlock	getTaskPropertyBlock(String id) returns properties of IChannelTask scheduled under registration id
default <T> void	removeAdapter(Class<T> adapterClass) remove registered adapter
boolean	removeMessage(String uuid) remove IMessage queued with uuid
boolean	removeMessageList(List<String> uuidList) remove list of IMessages queued with one of uuids
IChannelTask	removeTask(String id) removeIChannelTask scheduled under registration id
IChannelTask	rescheduleTask(String id, long executionTimeStamp, long timeOutValue, long heartBeatTimeOut) reset execution plan for an existing IChannelTask
String	scheduleTask(IChannelTask task) schedule a anonymous IChannelTask to IChannel equivalent to scheduleTask(null,task, null, -1, -1, -1);
String	scheduleTask(String id, IChannelTask task) schedule a IChannelTask to IChannel.
String	scheduleTask(String id, IChannelTask task, IPropertyBlock propertyBlock, long executionTimeStamp, long timeOutValue, long heartBeatTimeOut) schedule a IChannelTask to IChannel.
String	scheduleTask(String id, IChannelTask task, IPropertyBlock propertyBlock, long executionTimeStamp, long timeOutValue, long heartBeatTimeOut, boolean stopOnTimeOut) schedule a IChannelTask to IChannel.
default <T> void	setAdapter(Class<T> adapterClass, T adapter) register an adapter
void	signal(String signal) Sends a signal.
default void	storeMessage(T messagePayload) store a message with default header
void	storeMessage(T messagePayload, Consumer<MessageHeader> messageHeaderSetter) store a message
default Future<IOnMessageStoreResult>	storeMessageWithResult(T messagePayload) store a message with result
Future<IOnMessageStoreResult>	storeMessageWithResult(T messagePayload, Consumer<MessageHeader> messageHeaderSetter) store a message with result

Method Detail

getId

String getId()

getter for channel id

Returns:

id of channel

storeMessage

default void storeMessage(T messagePayload)
                   throws ChannelIsFullException

store a message with default header

Parameters:

messagePayload - payload of message to store in channel

Throws:

ChannelIsFullException - is thrown if message channel exceeds max allowed message size

storeMessage

void storeMessage(T messagePayload,
                  Consumer<MessageHeader> messageHeaderSetter)
           throws ChannelIsFullException

store a message

Parameters:

messagePayload - payload of message to store in channel

messageHeaderSetter - consumer to set message header properties

Throws:

ChannelIsFullException - is thrown if message channel exceeds max allowed message size

storeMessageWithResult

default Future<IOnMessageStoreResult> storeMessageWithResult(T messagePayload)
                                                      throws ChannelIsFullException

store a message with result

Parameters:

messagePayload - payload of message to store in channel

Returns:

Future of IOnMessageStoreResult

Throws:

ChannelIsFullException

storeMessageWithResult

Future<IOnMessageStoreResult> storeMessageWithResult(T messagePayload,
                                                     Consumer<MessageHeader> messageHeaderSetter)
                                              throws ChannelIsFullException

store a message with result

Parameters:

messagePayload - payload of message to store in channel

messageHeaderSetter - consumer to set message header properties

Returns:

Future of IOnMessageStoreResult

Throws:

ChannelIsFullException

getConfigurationPropertyBlock

IPropertyBlock getConfigurationPropertyBlock()

getter for configuration propertyblock of queue

Returns:

IPropertyBlock of queue for configuration details

getStatePropertyBlock

IPropertyBlock getStatePropertyBlock()

getter for state propertyblock of queue

Returns:

IPropertyBlock of queue for work state

getDispatcher

IMessageDispatcher getDispatcher()

getter for global dispatchter service

Returns:

IMessageDispatcher

getMessage

IMessage getMessage(String uuid)

returns IMessage queued with uuid

Parameters:

uuid - searchfilter

Returns:

IQueuedEvent queued with uuid or null if not present

removeMessage

boolean removeMessage(String uuid)

remove IMessage queued with uuid

Parameters:

uuid - identifier for IMessage to remove

Returns:

true if IMessage was found and remove, otherwise false

getMessageSnapshot

DequeSnapshot<IMessage<T>> getMessageSnapshot()

return message snapshot

Returns:

snapshot for chain

getMessageSnapshotPoll

DequeSnapshot<IMessage<T>> getMessageSnapshotPoll()

return message snapshot-poll (remove returned elements from channel)

Returns:

snapshot for chain

setAdapter

default <T> void setAdapter(Class<T> adapterClass,
                            T adapter)
                     throws PropertyIsLockedException

register an adapter

Parameters:

adapterClass - type of adapter

adapter - implementation of adapter

Throws:

PropertyIsLockedException

getAdapter

default <T> T getAdapter(Class<T> adapterClass)

get registered adapter

Parameters:

adapterClass - type of adapter

Returns:

registered adapter with specified adapterClass

getAdapter

default <T> T getAdapter(Class<T> adapterClass,
                         Supplier<T> adapterFactoryIfNotExists)

get registered adapter

Parameters:

adapterClass - type of adapter

adapterFactoryIfNotExists - factory to create adapter if not exists , and store with specified key

Returns:

registered adapter with specified adapterClass

removeAdapter

default <T> void removeAdapter(Class<T> adapterClass)
                        throws PropertyIsLockedException

remove registered adapter

Parameters:

adapterClass - type of adapter

Throws:

PropertyIsLockedException

removeMessageList

boolean removeMessageList(List<String> uuidList)

remove list of IMessages queued with one of uuids

Parameters:

uuidList - list of identifiers for IMessage to remove

Returns:

true if one of IMessage was found and remove, otherwise false

scheduleTask

String scheduleTask(IChannelTask task)

schedule a anonymous IChannelTask to IChannel equivalent to scheduleTask(null,task, null, -1, -1, -1);

Parameters:

task - IChannelTask to schedule

Returns:

generated taskid

scheduleTask

String scheduleTask(String id,
                    IChannelTask task)

schedule a IChannelTask to IChannel.

Parameters:

id - registration-id for IChannelTask to schedule

task - IChannelTask to schedule

Returns:

taskid (generated, if parameter id is null)

scheduleTask

String scheduleTask(String id,
                    IChannelTask task,
                    IPropertyBlock propertyBlock,
                    long executionTimeStamp,
                    long timeOutValue,
                    long heartBeatTimeOut)

schedule a IChannelTask to IChannel.

Parameters:

id - registration-id for IChannelTask to schedule

task - IChannelTask to schedule

propertyBlock - IChannelTask-properties (factory in IMessageDispatcher)

executionTimeStamp - execution time millis

timeOutValue - timeout value in ms, before notify for timeout

heartBeatTimeOut - heartbeat-timeout value in ms, before notify for timeout

Returns:

taskid (generated, in parameter id is null)

scheduleTask

String scheduleTask(String id,
                    IChannelTask task,
                    IPropertyBlock propertyBlock,
                    long executionTimeStamp,
                    long timeOutValue,
                    long heartBeatTimeOut,
                    boolean stopOnTimeOut)

schedule a IChannelTask to IChannel.

Parameters:

id - registration-id for IChannelTask to schedule

task - IChannelTask to schedule

propertyBlock - IChannelTask-properties (factory in IMessageDispatcher)

executionTimeStamp - execution time millis

timeOutValue - timeout value in ms, before notify for timeout

heartBeatTimeOut - heartbeat-timeout value in ms, before notify for timeout

stopOnTimeOut - stop unlinked worker-thread on timeout. This option is NOT necessary to create new worker running other tasks. Attention: can be dangerous

Returns:

taskid (generated, in parameter id is null)

rescheduleTask

IChannelTask rescheduleTask(String id,
                            long executionTimeStamp,
                            long timeOutValue,
                            long heartBeatTimeOut)

reset execution plan for an existing IChannelTask

The execution timestamp is ignored if current execution plan requires earlier execution in the future and was requested by trigger, tasks control and periodic service configuration

Parameters:

id - registration-id of IChannelTask in which reset execution plan

executionTimeStamp - new execution time millis

timeOutValue - new timeout value in ms, before notify for timeout

heartBeatTimeOut - heartbeat-timeout value in ms, before notify for timeout

Returns:

affected IChannelTask or null if not found

getTask

IChannelTask getTask(String id)

returns IChannelTask scheduled under registration id

Parameters:

id - registration-id for IChannelTask

Returns:

IChannelTask scheduled under registration id

removeTask

IChannelTask removeTask(String id)

removeIChannelTask scheduled under registration id

Parameters:

id - registration-id for IChannelTask to remove

Returns:

removed IChannelTask or null if no scheduled with id found

getTaskPropertyBlock

IPropertyBlock getTaskPropertyBlock(String id)

returns properties of IChannelTask scheduled under registration id

Parameters:

id - registration-id for IChannelTask

Returns:

properties of IChannelTask scheduled under registration id

signal

void signal(String signal)

Sends a signal. All IChannelManager manage this IChannel and implements IOnChannelSignal will notify asynchronously by queueworker.

Parameters:

signal -

getRootChannel

IChannel<?> getRootChannel()

returns root scope

Returns:

global scope

createChildScope

default ISubChannel<?> createChildScope(UUID scopeId,
                                        String scopeName,
                                        ISubChannel<?> parentScope,
                                        Map<String,Object> configurationProperties,
                                        Map<String,Object> stateProperties)

create ISubChannel for IChannel

Parameters:

scopeId - unique id of scope (unique by queue) or null for auto-generation

scopeName - human readable name of scope (nullable)

parentScope - parent scope to define tree structure for scopes

configurationProperties - blue print for configuration propertyblock of new scope (nullable)

stateProperties - blue print for state propertyblock of new scope (nullable)

Returns:

new scope, or null, if scope already exists

createChildScope

ISubChannel createChildScope(UUID scopeId,
                             String scopeName,
                             ISubChannel parentScope,
                             Map<String,Object> configurationProperties,
                             Map<String,Object> stateProperties,
                             boolean adoptContoller,
                             boolean adoptServices)

create ISubChannel for IChannel

Parameters:

scopeId - unique id of scope (unique by queue) or null for auto-generation

scopeName - human readable name of scope (nullable)

parentScope - parent scope to define tree structure for scopes

configurationProperties - blue print for configuration propertyblock of new scope (nullable)

stateProperties - blue print for state propertyblock of new scope (nullable)

adoptContoller - keep controller of parent queue

adoptServices - keep services of parent queue

Returns:

new scope, or null, if scope already exists

getChildScopes

List<ISubChannel> getChildScopes()

getter for child scope list. The child scopes list is defined by virtual tree structure.

Returns:

immutable list of child scopes

getChildScope

ISubChannel getChildScope(UUID scopeId)

returns scope with given scopeId

Parameters:

scopeId - id of scope to return

Returns:

scope with given scopeId or null, if scope not found