org.sodeac.common.message.dispatcher.api

Class DispatcherChannelSetup.BoundedByChannelId

java.lang.Object

org.sodeac.common.message.dispatcher.api.DispatcherChannelSetup

org.sodeac.common.message.dispatcher.api.DispatcherChannelSetup.BoundedByChannelId

All Implemented Interfaces:

Serializable

Enclosing class:

DispatcherChannelSetup

public static final class DispatcherChannelSetup.BoundedByChannelId
extends DispatcherChannelSetup

Configuration to bind a IChannelComponent (a IChannelManager or a IChannelService) to the IChannel with specified channelId managed by IMessageDispatcher with specified id.

Author:

Sebastian Palarus

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.sodeac.common.message.dispatcher.api.DispatcherChannelSetup

DispatcherChannelSetup.BoundedByChannelConfiguration, DispatcherChannelSetup.BoundedByChannelId, DispatcherChannelSetup.ChannelServiceConfiguration

Constructor Summary

Constructors

Constructor and Description
BoundedByChannelId(String channelId) Constructor to bind a IChannelComponent to the IChannel with specified channelId.

Method Summary

Modifier and Type	Method and Description
DispatcherChannelSetup.BoundedByChannelId	copy()
String	getChannelId() getter for channel id
String	getDispatcherId() getter for dispatcherId
protected Long	getMaxMessageSize() getter for max channel size
String	getName() getter for name of channel component
PrivateChannelWorkerRequirement	getPrivateChannelWorkerRequirement() getter for private channel worker requirement
Class<? extends IChannelComponent>[]	getScopes() specified scopes allowed to apply this configuration type
boolean	isAutoCreateChannel() getter for auto create channel mode
DispatcherChannelSetup.BoundedByChannelId	setAutoCreateChannel(boolean autoCreateChannel) setter for auto create channel mode
DispatcherChannelSetup.BoundedByChannelId	setDispatcherId(String dispatcherId) setter for dispatcher id
protected DispatcherChannelSetup.BoundedByChannelId	setMaxMessageSize(Long maxMessageSize) setter for max channel size
DispatcherChannelSetup.BoundedByChannelId	setName(String name) setter for name of channel component
DispatcherChannelSetup.BoundedByChannelId	setPrivateChannelWorkerRequirement(PrivateChannelWorkerRequirement privateChannelWorkerRequirement) setter for private channel worker requirement

Methods inherited from class org.sodeac.common.message.dispatcher.api.DispatcherChannelSetup

isOptional, setOptional

Methods inherited from class java.lang.Object

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

Constructor Detail

BoundedByChannelId

public BoundedByChannelId(String channelId)

Constructor to bind a IChannelComponent to the IChannel with specified channelId.

Parameters:

channelId - id of channel

Method Detail

getChannelId

public String getChannelId()

getter for channel id

Returns:

id of channel

getName

public String getName()

Description copied from class: DispatcherChannelSetup

getter for name of channel component

Overrides:

getName in class DispatcherChannelSetup

Returns:

name of channel component

setName

public DispatcherChannelSetup.BoundedByChannelId setName(String name)

Description copied from class: DispatcherChannelSetup

setter for name of channel component

Overrides:

setName in class DispatcherChannelSetup

Parameters:

name - name of channel component

Returns:

component configuration

setAutoCreateChannel

public DispatcherChannelSetup.BoundedByChannelId setAutoCreateChannel(boolean autoCreateChannel)

setter for auto create channel mode

Parameters:

autoCreateChannel - if true, dispatcher creates automatically a channel with channelId if it still does not exist

Returns:

channel component configuration

isAutoCreateChannel

public boolean isAutoCreateChannel()

getter for auto create channel mode

Returns:

true, if channel should automatically create, if not exists. return false, if not

getScopes

public Class<? extends IChannelComponent>[] getScopes()

Description copied from class: DispatcherChannelSetup

specified scopes allowed to apply this configuration type

Specified by:

getScopes in class DispatcherChannelSetup

Returns:

array of allowed scope

setDispatcherId

public DispatcherChannelSetup.BoundedByChannelId setDispatcherId(String dispatcherId)

Description copied from class: DispatcherChannelSetup

setter for dispatcher id

Overrides:

setDispatcherId in class DispatcherChannelSetup

Parameters:

dispatcherId - id of dispatcher (NULL for all dispatchers ) managed the channel

Returns:

channel component configuration

setMaxMessageSize

protected DispatcherChannelSetup.BoundedByChannelId setMaxMessageSize(Long maxMessageSize)

Description copied from class: DispatcherChannelSetup

setter for max channel size

Overrides:

setMaxMessageSize in class DispatcherChannelSetup

Parameters:

maxMessageSize - max size of messages

Returns:

channel component configuration

setPrivateChannelWorkerRequirement

public DispatcherChannelSetup.BoundedByChannelId setPrivateChannelWorkerRequirement(PrivateChannelWorkerRequirement privateChannelWorkerRequirement)

Description copied from class: DispatcherChannelSetup

setter for private channel worker requirement

Overrides:

setPrivateChannelWorkerRequirement in class DispatcherChannelSetup

Parameters:

privateChannelWorkerRequirement - declares necessity to use same channel worker thread for synchronized channel activities at all times

Returns:

channel component configuration

getDispatcherId

public String getDispatcherId()

Description copied from class: DispatcherChannelSetup

getter for dispatcherId

Overrides:

getDispatcherId in class DispatcherChannelSetup

Returns:

id of dispatcher (NULL for all dispatchers ) managed the channel

getMaxMessageSize

protected Long getMaxMessageSize()

Description copied from class: DispatcherChannelSetup

getter for max channel size

Overrides:

getMaxMessageSize in class DispatcherChannelSetup

Returns:

max channel size or null, if property not set

getPrivateChannelWorkerRequirement

public PrivateChannelWorkerRequirement getPrivateChannelWorkerRequirement()

Description copied from class: DispatcherChannelSetup

getter for private channel worker requirement

Overrides:

getPrivateChannelWorkerRequirement in class DispatcherChannelSetup

Returns:

necessity to use same channel worker thread for synchronized channel activities at all times

copy

public DispatcherChannelSetup.BoundedByChannelId copy()

Specified by:

copy in class DispatcherChannelSetup