rsb.eventprocessing

Class DefaultOutRouteConfigurator

java.lang.Object

rsb.eventprocessing.DefaultOutRouteConfigurator

All Implemented Interfaces:

Activatable, OutRouteConfigurator, RouteConfigurator<OutConnector>

public class DefaultOutRouteConfigurator
extends Object
implements OutRouteConfigurator

Class implementing the basic out route configuration based on a push strategy.

Author:

jwienke

Nested Class Summary

Nested classes/interfaces inherited from interface rsb.Activatable

Activatable.State

Constructor Summary

Constructors

Constructor and Description
DefaultOutRouteConfigurator(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(OutConnector 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.
Set<URI>	getTransportUris() Returns URIs describing the transports configured for this configurator.
boolean	isActive() Tells whether this class is currently active or not.
void	publishSync(Event event) Sends an event.
boolean	removeConnector(OutConnector connector) Removes a connector, which will not receive events for sending afterwards.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultOutRouteConfigurator

public DefaultOutRouteConfigurator(Scope scope)

Constructor.

Parameters:

scope - the scope the out route operates 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,
                       InterruptedException

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

InterruptedException - interrupted while waiting for proper deactivation. Object might be in an undefined state now

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

addConnector

public void addConnector(OutConnector 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<OutConnector>

Parameters:

connector - connector to add

removeConnector

public boolean removeConnector(OutConnector 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<OutConnector>

Parameters:

connector - the connector to remove

Returns:

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

publishSync

public void publishSync(Event event)
                 throws RSBException

Description copied from interface: OutRouteConfigurator

Sends an event. This method must only be called after activating the object with Activatable.activate().

Specified by:

publishSync in interface OutRouteConfigurator

Parameters:

event - event to send

Throws:

RSBException - sending error. e.g. impossible to convert data, transport error

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<OutConnector>

Returns:

set of transport URIs, not null