rsb.patterns

Class Method

java.lang.Object

rsb.patterns.Method

All Implemented Interfaces:

RSBObject

Direct Known Subclasses:

AbstractRemoteMethod

public abstract class Method
extends java.lang.Object
implements RSBObject

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.

Author:

jmoringe, swrede

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Method.MethodState
protected class	Method.MethodStateActive
protected class	Method.MethodStateInactive

Field Summary

Fields

Modifier and Type	Field and Description
protected Factory	factory
protected Informer<?>	informer
protected Listener	listener
protected static java.util.logging.Logger	LOG
protected Scope	REPLY_SCOPE
protected Scope	REQUEST_SCOPE

Constructor Summary

Constructors

Constructor and Description
Method(Server server, java.lang.String name) Create a new Method object for the method named @a name provided by @a server.

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activates all network resources that belong to a specific object.
void	deactivate() Deactivate all network resources that are owned by a specific object in order to reactivate it.
Informer<?>	getInformer() Return the Informer object associated to this method.
Listener	getListener() Return the Listener object associated to this method.
java.lang.String	getName() Return the name of this method.
Server	getServer() Return the Server object to which this method is associated.
boolean	isActive() Tells wether this class is currently active or not.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final java.util.logging.Logger LOG

factory

protected Factory factory

informer

protected Informer<?> informer

listener

protected Listener listener

REQUEST_SCOPE

protected final Scope REQUEST_SCOPE

REPLY_SCOPE

protected final Scope REPLY_SCOPE

Constructor Detail

Method

public Method(Server server,
      java.lang.String name)

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

Parameters:

server - The remote or local server to which the method is associated.

name - The name of the method. Unique within a server.

Method Detail

getServer

public Server getServer()

Return the Server object to which this method is associated.

Returns:

The Server object.

getName

public java.lang.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: RSBObject

Tells wether this class is currently active or not.

Specified by:

isActive in interface RSBObject

Returns:

true if active

activate

public void activate()
              throws InitializeException

Description copied from interface: RSBObject

Activates all network resources that belong to a specific object.

Specified by:

activate in interface RSBObject

Throws:

InitializeException

deactivate

public void deactivate()

Description copied from interface: RSBObject

Deactivate all network resources that are owned by a specific object in order to reactivate it.

Specified by:

deactivate in interface RSBObject

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object