org.sodeac.common.message.dispatcher.api

Class DispatcherChannelSetup.ChannelServiceConfiguration

java.lang.Object

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

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

All Implemented Interfaces:

Serializable

Enclosing class:

DispatcherChannelSetup

public static class DispatcherChannelSetup.ChannelServiceConfiguration
extends DispatcherChannelSetup

Configuration for Channel Services

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
ChannelServiceConfiguration(String serviceId)

Method Summary

Modifier and Type	Method and Description
DispatcherChannelSetup.ChannelServiceConfiguration	copy()
String	getDispatcherId() getter for dispatcherId
long	getHeartbeatTimeOutInMS() getter for service heartbeat timeout in ms
protected Long	getMaxMessageSize() getter for max channel size
String	getName() getter for name of channel component
long	getPeriodicRepetitionIntervalMS() getter for periodic repetition interval of service in ms
PrivateChannelWorkerRequirement	getPrivateChannelWorkerRequirement() getter for private channel worker requirement
Class<? extends IChannelComponent>[]	getScopes() specified scopes allowed to apply this configuration type
String	getServiceId() getter for service id
long	getStartDelayInMS() getter for start delay of service in ms
long	getTimeOutInMS() getter for service timeout in ms
DispatcherChannelSetup.ChannelServiceConfiguration	setHeartbeatTimeOutInMS(long heartbeatTimeOutInMS) setter for service heartbeat timeout in ms
protected DispatcherChannelSetup.ChannelServiceConfiguration	setMaxMessageSize(Long maxMessageSize) setter for max channel size
DispatcherChannelSetup.ChannelServiceConfiguration	setName(String name) setter for name of channel component
DispatcherChannelSetup.ChannelServiceConfiguration	setPeriodicRepetitionIntervalMS(long periodicRepetitionIntervalMS) setter for periodic repetition interval of service in ms
DispatcherChannelSetup.ChannelServiceConfiguration	setPrivateChannelWorkerRequirement(PrivateChannelWorkerRequirement privateChannelWorkerRequirement) setter for private channel worker requirement
DispatcherChannelSetup.ChannelServiceConfiguration	setStartDelayInMS(long startDelayInMS) setter for start delay of service in ms
DispatcherChannelSetup.ChannelServiceConfiguration	setTimeOutInMS(long timeOutInMS) setter for service timeout in ms

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

isOptional, setDispatcherId, setOptional

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelServiceConfiguration

public ChannelServiceConfiguration(String serviceId)

Method Detail

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

getTimeOutInMS

public long getTimeOutInMS()

getter for service timeout in ms

Returns:

service timeout in ms

setTimeOutInMS

public DispatcherChannelSetup.ChannelServiceConfiguration setTimeOutInMS(long timeOutInMS)

setter for service timeout in ms

Parameters:

timeOutInMS - service timeout in ms

Returns:

channel service configuration

getHeartbeatTimeOutInMS

public long getHeartbeatTimeOutInMS()

getter for service heartbeat timeout in ms

Returns:

service heartbeat timeout

setHeartbeatTimeOutInMS

public DispatcherChannelSetup.ChannelServiceConfiguration setHeartbeatTimeOutInMS(long heartbeatTimeOutInMS)

setter for service heartbeat timeout in ms

Parameters:

heartbeatTimeOutInMS - service heartbeat timeout in ms

Returns:

channel service configuration

getStartDelayInMS

public long getStartDelayInMS()

getter for start delay of service in ms

Returns:

start delay of service in ms

setStartDelayInMS

public DispatcherChannelSetup.ChannelServiceConfiguration setStartDelayInMS(long startDelayInMS)

setter for start delay of service in ms

Parameters:

startDelayInMS - start delay of service in ms

Returns:

channel service configuration

getPeriodicRepetitionIntervalMS

public long getPeriodicRepetitionIntervalMS()

getter for periodic repetition interval of service in ms

Returns:

periodic repetition interval of service in ms

setPeriodicRepetitionIntervalMS

public DispatcherChannelSetup.ChannelServiceConfiguration setPeriodicRepetitionIntervalMS(long periodicRepetitionIntervalMS)

setter for periodic repetition interval of service in ms

Parameters:

periodicRepetitionIntervalMS - repetition interval of service in ms

Returns:

channel service configuration

setMaxMessageSize

protected DispatcherChannelSetup.ChannelServiceConfiguration 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.ChannelServiceConfiguration 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

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

getServiceId

public String getServiceId()

getter for service id

Returns:

id of service

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

copy

public DispatcherChannelSetup.ChannelServiceConfiguration copy()

Specified by:

copy in class DispatcherChannelSetup