rsb.patterns

Class Method

java.lang.Object

rsb.Participant

rsb.patterns.Method

All Implemented Interfaces:

Activatable

Direct Known Subclasses:

RemoteMethod

public abstract class Method
extends Participant

Objects of this class are methods which are associated to a local or remote server. Within a server, each method has a unique name. This class is primarily intended as a superclass for local and remote method classes. This class manages the Listener and Informer instances used to communicate between methods as well as a state pattern for activating them.

Author:

jmoringe, swrede

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Method(ParticipantCreateArgs<?> args) Create a new Method object for the method named @a name.

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activates all resources that belong to a specific object.
void	deactivate() Deactivate all resources that are owned by a specific object in order to correctly tear down.
protected Factory	getFactory() Returns the factory instance to use by this method for creating internal participants.
Informer<?>	getInformer() Return the Informer object associated to this method.
Listener	getListener() Return the Listener object associated to this method.
String	getName() Return the name of this method.
boolean	isActive() Tells whether this class is currently active or not.
protected void	setInformer(Informer<?> informer) Sets the informer instances used by this method communicate with counterparts.
protected void	setListener(Listener listener) Sets the listener instance used by this method to communicate with counterparts.
String	toString()

Methods inherited from class rsb.Participant

getConfig, getDataType, getId, getKind, getObserverManager, getScope, getTransportUris, setObserverManager

Methods inherited from class java.lang.Object

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

Constructor Detail

Method

protected Method(ParticipantCreateArgs<?> args)

Create a new Method object for the method named @a name.

Parameters:

args - Arguments used to create a method instances. The last scope fragment is assumed to be the method name.

Method Detail

getFactory

protected Factory getFactory()

Returns the factory instance to use by this method for creating internal participants.

Returns:

factory instance

getName

public String getName()

Return the name of this method.

Returns:

The name of this method.

getInformer

public Informer<?> getInformer()

Return the Informer object associated to this method. The Informer object may be created lazily.

Returns:

The Informer object.

getListener

public Listener getListener()

Return the Listener object associated to this method. The Listener object may be created lazily.

Returns:

The Listener object.

isActive

public boolean isActive()

Description copied from interface: Activatable

Tells whether this class is currently active or not.

Returns:

true if active

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

Overrides:

activate in class Participant

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

Overrides:

deactivate in class Participant

Throws:

RSBException - generic error related to RSB

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

toString

public String toString()

Overrides:

toString in class Object

setInformer

protected void setInformer(Informer<?> informer)

Sets the informer instances used by this method communicate with counterparts.

Parameters:

informer - the new informer instances

setListener

protected void setListener(Listener listener)

Sets the listener instance used by this method to communicate with counterparts.

Parameters:

listener - the new listeners