rsb

Class Factory

java.lang.Object

rsb.Factory

public final class Factory
extends Object

A factory for RSB client-level objects. This class is a Singleton. It implements an observer pattern to notify about the creation and destruction of participants.

Author:

jwienke, swrede

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Factory.ParticipantObserverManager A utility class to manage registered ParticipantObserver instances.

Method Summary

Methods

Modifier and Type	Method and Description
void	addObserver(ParticipantObserver observer) Adds an observer to be notified on participant changes.
<DataType> Informer<DataType>	createInformer(InformerCreateArgs args) Creates a new informer instance.
<DataType> Informer<DataType>	createInformer(Scope scope) Creates a new informer instance.
<DataType> Informer<DataType>	createInformer(Scope scope, Class<?> type) Creates a new informer instance.
<DataType> Informer<DataType>	createInformer(Scope scope, Class<?> type, ParticipantConfig config) Creates a new informer instance.
<DataType> Informer<DataType>	createInformer(Scope scope, ParticipantConfig config) Creates a new informer instance.
<DataType> Informer<DataType>	createInformer(String scope) Creates a new informer instance.
<DataType> Informer<DataType>	createInformer(String scope, Class<?> type) Creates a new informer instance.
<DataType> Informer<DataType>	createInformer(String scope, Class<?> type, ParticipantConfig config) Creates a new informer instance.
<DataType> Informer<DataType>	createInformer(String scope, ParticipantConfig config) Creates a new informer instance.
Listener	createListener(ListenerCreateArgs args) Creates a new listener instance.
Listener	createListener(Scope scope) Creates a new listener instance.
Listener	createListener(Scope scope, ParticipantConfig config) Creates a new listener instance.
Listener	createListener(String scope) Creates a new listener instance.
Listener	createListener(String scope, ParticipantConfig config) Creates a new listener instance.
LocalServer	createLocalServer(LocalServerCreateArgs args) Creates a new LocalServer instance.
LocalServer	createLocalServer(Scope scope) Creates a new LocalServer object which exposes methods under the scope @a scope.
LocalServer	createLocalServer(Scope scope, ParticipantConfig config) Creates a new LocalServer object which exposes methods under the scope @a scope.
LocalServer	createLocalServer(String scope) Creates a new LocalServer object which exposes methods under the scope @a scope.
LocalServer	createLocalServer(String scope, ParticipantConfig config) Creates a new LocalServer object which exposes methods under the scope @a scope.
RemoteServer	createRemoteServer(RemoteServerCreateArgs args) Creates a new remote server instance.
RemoteServer	createRemoteServer(Scope scope) Creates a new RemoteServer object which is suitable for calling methods provided by a remote server under the scope @a scope.
RemoteServer	createRemoteServer(Scope scope, double timeout) Creates a new RemoteServer object which is suitable for calling methods provided by a remote server under the scope @a scope.
RemoteServer	createRemoteServer(Scope scope, ParticipantConfig config) Creates a new RemoteServer object which is suitable for calling methods provided by a remote server under the scope @a scope.
RemoteServer	createRemoteServer(String scope) Creates a new RemoteServer object which is suitable for calling methods provided by a remote server under the scope @a scope.
RemoteServer	createRemoteServer(String scope, double timeout) Creates a new RemoteServer object which is suitable for calling methods provided by a remote server under the scope @a scope.
RemoteServer	createRemoteServer(String scope, ParticipantConfig config) Creates a new RemoteServer object which is suitable for calling methods provided by a remote server under the scope @a scope.
ParticipantConfig	getDefaulParticipantconfig() Deprecated. use getDefaultParticipantConfig() (without typo in name)
ParticipantConfig	getDefaultParticipantConfig() Returns the participant config used per default for new participants.
static Factory	getInstance() Returns the one and only instance of this class.
Properties	getProperties() Returns the default configuration properties.
void	removeObserver(ParticipantObserver observer) Removes an observer in case it existed.
void	setDefaultParticipantConfig(ParticipantConfig config) Sets the default participant config used per default for new participants.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Factory getInstance()

Returns the one and only instance of this class.

Returns:

singleton factory instance

createInformer

public <DataType> Informer<DataType> createInformer(Scope scope,
                                           Class<?> type)
                                  throws InitializeException

Creates a new informer instance.

Type Parameters:

DataType - type of the data sent by this informer

Parameters:

scope - scope of the informer

type - type identifier of the informer

Returns:

new informer instance

Throws:

InitializeException - error initializing the informer

createInformer

public <DataType> Informer<DataType> createInformer(String scope,
                                           Class<?> type)
                                  throws InitializeException

Creates a new informer instance.

Type Parameters:

DataType - type of the data sent by this informer

Parameters:

scope - scope of the informer

type - type identifier of the informer

Returns:

new informer instance

Throws:

InitializeException - error initializing the informer

createInformer

public <DataType> Informer<DataType> createInformer(Scope scope,
                                           Class<?> type,
                                           ParticipantConfig config)
                                  throws InitializeException

Creates a new informer instance.

Type Parameters:

DataType - type of the data sent by this informer

Parameters:

scope - scope of the informer

type - type identifier of the informer

config - participant config to use

Returns:

new informer instance

Throws:

InitializeException - error initializing the informer

createInformer

public <DataType> Informer<DataType> createInformer(String scope,
                                           Class<?> type,
                                           ParticipantConfig config)
                                  throws InitializeException

Creates a new informer instance.

Type Parameters:

DataType - type of the data sent by this informer

Parameters:

scope - scope of the informer

type - type identifier of the informer

config - participant config to use

Returns:

new informer instance

Throws:

InitializeException - error initializing the informer

createInformer

public <DataType> Informer<DataType> createInformer(Scope scope)
                                  throws InitializeException

Creates a new informer instance.

Type Parameters:

DataType - type of the data sent by this informer

Parameters:

scope - scope of the informer

Returns:

new informer instance

Throws:

InitializeException - error initializing the informer

createInformer

public <DataType> Informer<DataType> createInformer(String scope)
                                  throws InitializeException

Creates a new informer instance.

Type Parameters:

DataType - type of the data sent by this informer

Parameters:

scope - scope of the informer

Returns:

new informer instance

Throws:

InitializeException - error initializing the informer

createInformer

public <DataType> Informer<DataType> createInformer(Scope scope,
                                           ParticipantConfig config)
                                  throws InitializeException

Creates a new informer instance.

Type Parameters:

DataType - type of the data sent by this informer

Parameters:

scope - scope of the informer

config - participant config to use

Returns:

new informer instance

Throws:

InitializeException - error initializing the informer

createInformer

public <DataType> Informer<DataType> createInformer(String scope,
                                           ParticipantConfig config)
                                  throws InitializeException

Creates a new informer instance.

Type Parameters:

DataType - type of the data sent by this informer

Parameters:

scope - scope of the informer

config - participant config to use

Returns:

new informer instance

Throws:

InitializeException - error initializing the informer

createInformer

public <DataType> Informer<DataType> createInformer(InformerCreateArgs args)
                                  throws InitializeException

Creates a new informer instance.

Type Parameters:

DataType - type of the data sent by this informer

Parameters:

args - Parameter object with create arguments for participant.

Returns:

new informer

Throws:

InitializeException - error initializing the informer

IllegalArgumentException - args is null

createListener

public Listener createListener(Scope scope)
                        throws InitializeException

Creates a new listener instance.

Parameters:

scope - scope of the listener

Returns:

new listener

Throws:

InitializeException - error initializing the listener

createListener

public Listener createListener(String scope)
                        throws InitializeException

Creates a new listener instance.

Parameters:

scope - scope of the listener

Returns:

new listener

Throws:

InitializeException - error initializing the listener

createListener

public Listener createListener(String scope,
                      ParticipantConfig config)
                        throws InitializeException

Creates a new listener instance.

Parameters:

scope - scope of the listener

config - participant configuration to use

Returns:

new listener

Throws:

InitializeException - error initializing the listener

createListener

public Listener createListener(Scope scope,
                      ParticipantConfig config)
                        throws InitializeException

Creates a new listener instance.

Parameters:

scope - scope of the listener

config - participant configuration to use

Returns:

new listener

Throws:

InitializeException - error initializing the listener

createListener

public Listener createListener(ListenerCreateArgs args)
                        throws InitializeException

Creates a new listener instance.

Parameters:

args - Parameter object with create arguments for participant.

Returns:

new listener

Throws:

InitializeException - error initializing the listener

IllegalArgumentException - args is null

createLocalServer

public LocalServer createLocalServer(Scope scope)

Creates a new LocalServer object which exposes methods under the scope @a scope.

Parameters:

scope - The scope under which methods of the LocalServer object should be exposed.

Returns:

The new LocalServer object.

createLocalServer

public LocalServer createLocalServer(Scope scope,
                            ParticipantConfig config)

Creates a new LocalServer object which exposes methods under the scope @a scope.

Parameters:

scope - The scope under which methods of the LocalServer object should be exposed.

config - participant configuration to use

Returns:

The new LocalServer object.

createLocalServer

public LocalServer createLocalServer(String scope,
                            ParticipantConfig config)

Creates a new LocalServer object which exposes methods under the scope @a scope.

Parameters:

scope - The scope under which methods of the LocalServer object should be exposed.

config - participant configuration to use

Returns:

The new LocalServer object.

createLocalServer

public LocalServer createLocalServer(String scope)

Creates a new LocalServer object which exposes methods under the scope @a scope.

Parameters:

scope - The scope under which methods of the LocalServer object should be exposed.

Returns:

The new LocalServer object.

createLocalServer

public LocalServer createLocalServer(LocalServerCreateArgs args)

Creates a new LocalServer instance.

Parameters:

args - Parameter object with create arguments for participant.

Returns:

new LocalServer

Throws:

IllegalArgumentException - args is null

createRemoteServer

public RemoteServer createRemoteServer(Scope scope)

Creates a new RemoteServer object which is suitable for calling methods provided by a remote server under the scope @a scope.

Parameters:

scope - The scope under which a remote server provides its methods.

Returns:

The new RemoteServer object.

createRemoteServer

public RemoteServer createRemoteServer(String scope)

Creates a new RemoteServer object which is suitable for calling methods provided by a remote server under the scope @a scope.

Parameters:

scope - The scope under which a remote server provides its methods.

Returns:

The new RemoteServer object.

createRemoteServer

public RemoteServer createRemoteServer(Scope scope,
                              ParticipantConfig config)

Creates a new RemoteServer object which is suitable for calling methods provided by a remote server under the scope @a scope.

Parameters:

scope - The scope under which a remote server provides its methods.

config - participant configuration to use

Returns:

The new RemoteServer object.

createRemoteServer

public RemoteServer createRemoteServer(String scope,
                              ParticipantConfig config)

Creates a new RemoteServer object which is suitable for calling methods provided by a remote server under the scope @a scope.

Parameters:

scope - The scope under which a remote server provides its methods.

config - participant configuration to use

Returns:

The new RemoteServer object.

createRemoteServer

public RemoteServer createRemoteServer(Scope scope,
                              double timeout)

Creates a new RemoteServer object which is suitable for calling methods provided by a remote server under the scope @a scope.

Parameters:

scope - The scope under which a remote server provides its methods.

timeout - The amount of seconds methods calls should wait for their replies to arrive before failing.

Returns:

The new RemoteServer object.

createRemoteServer

public RemoteServer createRemoteServer(String scope,
                              double timeout)

Creates a new RemoteServer object which is suitable for calling methods provided by a remote server under the scope @a scope.

Parameters:

scope - The scope under which a remote server provides its methods.

timeout - The amount of seconds methods calls should wait for their replies to arrive before failing.

Returns:

The new RemoteServer object.

createRemoteServer

public RemoteServer createRemoteServer(RemoteServerCreateArgs args)

Creates a new remote server instance.

Parameters:

args - Parameter object with create arguments for participant.

Returns:

new remote server

Throws:

IllegalArgumentException - args is null

getProperties

public Properties getProperties()

Returns the default configuration properties.

Returns:

property instances

getDefaultParticipantConfig

public ParticipantConfig getDefaultParticipantConfig()

Returns the participant config used per default for new participants. This instance might be modified but changes are only applied to newly created participants.

Returns:

default participant config

setDefaultParticipantConfig

public void setDefaultParticipantConfig(ParticipantConfig config)

Sets the default participant config used per default for new participants. This method is not thread-safe! Only use it when no other thread is creating participants!

Parameters:

config - the new config to use, not null

Throws:

IllegalArgumentException - if the given config is null

getDefaulParticipantconfig

@Deprecated
public ParticipantConfig getDefaulParticipantconfig()

Deprecated. use getDefaultParticipantConfig() (without typo in name)

Returns the participant config used per default for new participants. This instance might be modified but changes are only applied to newly created participants.

Returns:

default participant config

addObserver

public void addObserver(ParticipantObserver observer)

Adds an observer to be notified on participant changes.

Parameters:

observer - the observer to add, not null

removeObserver

public void removeObserver(ParticipantObserver observer)

Removes an observer in case it existed. Otherwise it does nothing.

Parameters:

observer - the observer to remove