org.sodeac.common.message.dispatcher.api

Class DispatcherChannelSetup

java.lang.Object

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DispatcherChannelSetup.BoundedByChannelConfiguration, DispatcherChannelSetup.BoundedByChannelId, DispatcherChannelSetup.ChannelServiceConfiguration

public abstract class DispatcherChannelSetup
extends Object
implements Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DispatcherChannelSetup.BoundedByChannelConfiguration Configuration to bind a IChannelComponent (a IChannelManager or a IChannelService) to existing IChannels whose properties match a ldapfilter.
static class	DispatcherChannelSetup.BoundedByChannelId Configuration to bind a IChannelComponent (a IChannelManager or a IChannelService) to the IChannel with specified channelId managed by IMessageDispatcher with specified id.
static class	DispatcherChannelSetup.ChannelServiceConfiguration Configuration for Channel Services

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

getScopes

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

specified scopes allowed to apply this configuration type

Returns:

array of allowed scope

copy

public abstract DispatcherChannelSetup copy()

getDispatcherId

protected String getDispatcherId()

getter for dispatcherId

Returns:

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

setDispatcherId

protected DispatcherChannelSetup setDispatcherId(String dispatcherId)

setter for dispatcher id

Parameters:

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

Returns:

channel component configuration

getName

protected String getName()

getter for name of channel component

Returns:

name of channel component

setName

protected DispatcherChannelSetup setName(String name)

setter for name of channel component

Parameters:

name - name of channel component

Returns:

component configuration

getMaxMessageSize

protected Long getMaxMessageSize()

getter for max channel size

Returns:

max channel size or null, if property not set

setMaxMessageSize

protected DispatcherChannelSetup setMaxMessageSize(Long maxMessageSize)

setter for max channel size

Parameters:

maxMessageSize - max size of messages

Returns:

channel component configuration

getPrivateChannelWorkerRequirement

protected PrivateChannelWorkerRequirement getPrivateChannelWorkerRequirement()

getter for private channel worker requirement

Returns:

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

setPrivateChannelWorkerRequirement

protected DispatcherChannelSetup setPrivateChannelWorkerRequirement(PrivateChannelWorkerRequirement privateChannelWorkerRequirement)

setter for private channel worker requirement

Parameters:

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

Returns:

channel component configuration

isOptional

public boolean isOptional()

getter for optional flag

Returns:

true, if setup item is processed by setup provider, otherwise false

setOptional

public DispatcherChannelSetup setOptional(boolean optional)

setter for optional flag

Parameters:

optional - defines that the setup item has to be processed by setup provider, or not

Returns:

channel component configuration