rsb.eventprocessing

Class DefaultPushInRouteConfigurator

java.lang.Object

rsb.AbstractActivatable

rsb.eventprocessing.DefaultPushInRouteConfigurator

All Implemented Interfaces:

Closeable, AutoCloseable, Activatable, InRouteConfigurator<InPushConnector>, PushInRouteConfigurator, RouteConfigurator<InPushConnector>

public class DefaultPushInRouteConfigurator
extends AbstractActivatable
implements PushInRouteConfigurator

Default implementation of a PushInRouteConfigurator.

Author:

jwienke, swrede

Nested Class Summary

Nested classes/interfaces inherited from interface rsb.Activatable

Activatable.State

Constructor Summary

Constructors

Constructor and Description
DefaultPushInRouteConfigurator(Scope scope) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activates all resources that belong to a specific object.
void	addConnector(InPushConnector connector) Adds a connector which will subsequently be used for for sending events.
void	deactivate() Deactivate all resources that are owned by a specific object in order to correctly tear down.
void	filterAdded(Filter filter) Called in case a new filter was added and should be reflected by this route.
boolean	filterRemoved(Filter filter) Called in a case a filter should be removed from the route.
Set<URI>	getTransportUris() Returns URIs describing the transports configured for this configurator.
void	handlerAdded(Handler handler, boolean wait) Called in case a Handler was added to the participant for which the route is being configured.
boolean	handlerRemoved(Handler handler, boolean wait) Called in case a Handler was remove from the participant for which the route is being configured.
boolean	isActive() Tells whether this class is currently active or not.
boolean	removeConnector(InPushConnector connector) Removes a connector, which will not receive events for sending afterwards.
void	setEventReceivingStrategy(EventReceivingStrategy strategy) Defines the EventReceivingStrategy to use by the configurator.

Methods inherited from class rsb.AbstractActivatable

close

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

DefaultPushInRouteConfigurator

public DefaultPushInRouteConfigurator(Scope scope)

Constructor.

Parameters:

scope - the scope events are received on

Method Detail

activate

public void activate()
              throws RSBException

Description copied from interface: Activatable

Activates all resources that belong to a specific object.

Specified by:

activate in interface Activatable

Throws:

RSBException - generic error related to RSB

deactivate

public void deactivate()
                throws RSBException

Description copied from interface: Activatable

Deactivate all resources that are owned by a specific object in order to correctly tear down. The method should only return once the object is completely deactivated including possible background threads.

Specified by:

deactivate in interface Activatable

Throws:

RSBException - generic error related to RSB

filterAdded

public void filterAdded(Filter filter)

Description copied from interface: InRouteConfigurator

Called in case a new filter was added and should be reflected by this route.

Specified by:

filterAdded in interface InRouteConfigurator<InPushConnector>

Parameters:

filter - the added filter

filterRemoved

public boolean filterRemoved(Filter filter)

Description copied from interface: InRouteConfigurator

Called in a case a filter should be removed from the route.

Specified by:

filterRemoved in interface InRouteConfigurator<InPushConnector>

Parameters:

filter - the filter to remove

Returns:

true if the filter was already active and was removed now, else false

handlerAdded

public void handlerAdded(Handler handler,
                boolean wait)
                  throws InterruptedException

Description copied from interface: PushInRouteConfigurator

Called in case a Handler was added to the participant for which the route is being configured. This method should incorporate that handler into the route.

Specified by:

handlerAdded in interface PushInRouteConfigurator

Parameters:

handler - the added handler

wait - if true, this method must wait with returning until the handler is fully active and can receive the next event. Otherwise it might return earlier.

Throws:

InterruptedException - interrupted while waiting for the handler to be fully removed

handlerRemoved

public boolean handlerRemoved(Handler handler,
                     boolean wait)
                       throws InterruptedException

Description copied from interface: PushInRouteConfigurator

Called in case a Handler was remove from the participant for which the route is being configured. This method should remove that handler from the route.

Specified by:

handlerRemoved in interface PushInRouteConfigurator

Parameters:

handler - the removed handler

wait - if true, this method must wait with returning until the handler is fully removed and will not receive any more events.. Otherwise it might return earlier.

Returns:

true if the handler was already available and is now removed, else false

Throws:

InterruptedException - interrupted while waiting for the handler to be fully removed

addConnector

public void addConnector(InPushConnector connector)

Description copied from interface: RouteConfigurator

Adds a connector which will subsequently be used for for sending events. This method must only be called before the object is being activated using Activatable.activate().

Specified by:

addConnector in interface RouteConfigurator<InPushConnector>

Parameters:

connector - connector to add

removeConnector

public boolean removeConnector(InPushConnector connector)

Description copied from interface: RouteConfigurator

Removes a connector, which will not receive events for sending afterwards. This method must only be called before the object is being activated using Activatable.activate().

Specified by:

removeConnector in interface RouteConfigurator<InPushConnector>

Parameters:

connector - the connector to remove

Returns:

true if the connector was previously installed and hence remove now, else false

isActive

public boolean isActive()

Description copied from interface: Activatable

Tells whether this class is currently active or not.

Specified by:

isActive in interface Activatable

Returns:

true if active

setEventReceivingStrategy

public void setEventReceivingStrategy(EventReceivingStrategy strategy)

Description copied from interface: PushInRouteConfigurator

Defines the EventReceivingStrategy to use by the configurator. Must be called directly after construction before any other method was called.

Specified by:

setEventReceivingStrategy in interface PushInRouteConfigurator

Parameters:

strategy - the new strategy

getTransportUris

public Set<URI> getTransportUris()

Description copied from interface: RouteConfigurator

Returns URIs describing the transports configured for this configurator. Only valid if activated.

Specified by:

getTransportUris in interface RouteConfigurator<InPushConnector>

Returns:

set of transport URIs, not null