org.sodeac.common.message.dispatcher.api

Class DispatcherChannelSetup.BoundedByChannelConfiguration

java.lang.Object

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

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

All Implemented Interfaces:

Serializable

Enclosing class:

DispatcherChannelSetup

public static final class DispatcherChannelSetup.BoundedByChannelConfiguration
extends DispatcherChannelSetup

Configuration to bind a IChannelComponent (a IChannelManager or a IChannelService) to existing IChannels whose properties match a ldapfilter.

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
BoundedByChannelConfiguration(String ldapFilter) Constructor to bind a IChannelComponent to existing IChannels whose properties match the specified ldap-filter.

Method Summary

Modifier and Type	Method and Description
DispatcherChannelSetup.BoundedByChannelConfiguration	copy()
String	getDispatcherId() getter for dispatcherId
String	getLdapFilter() getter for ldap filter
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
DispatcherChannelSetup.BoundedByChannelConfiguration	setDispatcherId(String dispatcherId) setter for dispatcher id
protected DispatcherChannelSetup.BoundedByChannelConfiguration	setMaxMessageSize(Long maxMessageSize) setter for max channel size
DispatcherChannelSetup.BoundedByChannelConfiguration	setName(String name) setter for name of channel component
DispatcherChannelSetup.BoundedByChannelConfiguration	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

BoundedByChannelConfiguration

public BoundedByChannelConfiguration(String ldapFilter)

Constructor to bind a IChannelComponent to existing IChannels whose properties match the specified ldap-filter.

Method Detail

getLdapFilter

public String getLdapFilter()

getter for ldap filter

Returns:

ldap filter

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.BoundedByChannelConfiguration 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.BoundedByChannelConfiguration 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.BoundedByChannelConfiguration 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

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.BoundedByChannelConfiguration 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

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.BoundedByChannelConfiguration copy()

Specified by:

copy in class DispatcherChannelSetup