rsb.patterns

Class Server<MethodType extends Method>

java.lang.Object

rsb.Participant

rsb.patterns.Server<MethodType>

Type Parameters:

MethodType - The type of methods used in the subclasses

All Implemented Interfaces:

Activatable

Direct Known Subclasses:

LocalServer, RemoteServer

public abstract class Server<MethodType extends Method>
extends Participant

Objects of this class represent local or remote serves. A server is basically a collection of named methods that are bound to a specific scope. This class is primarily intended as a superclass for local and remote server classes.

Author:

jmoringe

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Server(ParticipantCreateArgs<?> args) Constructs a new server.

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activates all resources that belong to a specific object.
protected void	addMethod(String name, MethodType method, boolean overwrite) Adds a method to the server.
void	deactivate() Deactivate all resources that are owned by a specific object in order to correctly tear down.
MethodType	getMethod(String name) Returns the method with the given name.
Collection<MethodType>	getMethods() Return all methods of the server.
Set<URI>	getTransportUris() Returns URIs describing the transports configured for this participants.
boolean	hasMethod(String name) Indicates whether a method with the given name is already registered.
boolean	isActive() Tells whether this class is currently active or not.

Methods inherited from class rsb.Participant

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Server

protected Server(ParticipantCreateArgs<?> args)

Constructs a new server.

Parameters:

args - arguments used for this server

Method Detail

getMethods

public Collection<MethodType> getMethods()

Return all methods of the server.

Returns:

A Collection containing all methods.

getMethod

public MethodType getMethod(String name)

Returns the method with the given name.

Parameters:

name - method name

Returns:

Method instance or null if no method exists with this name

hasMethod

public boolean hasMethod(String name)

Indicates whether a method with the given name is already registered.

Parameters:

name - name of the method

Returns:

true if a method is registered with the given name, else false

addMethod

protected void addMethod(String name,
             MethodType method,
             boolean overwrite)

Adds a method to the server.

Parameters:

name - name under which the method should be registered

method - the method instance

overwrite - if true, overwrite an existing method with that name, else raise an exception

Throws:

IllegalArgumentException - method with the given name already exists and shall not be overwritten

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

getTransportUris

public Set<URI> getTransportUris()

Description copied from class: Participant

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

Specified by:

getTransportUris in class Participant

Returns:

set of transport URIs, not null