org.commonreality.participant.impl

Class AbstractParticipant

java.lang.Object

org.commonreality.participant.impl.AbstractParticipant

All Implemented Interfaces:

IIdentifiable, IParticipant

Direct Known Subclasses:

AbstractAgent, AbstractSensor, DefaultReality

public abstract class AbstractParticipant
extends java.lang.Object
implements IParticipant

Skeleton participant that handles the majority of tasks. A participants life cycle works like this: Sometime after instantiation, connect will be called which will establish the connection to CommonReality. When common reality is ready to start, it will signal that all sensors and agents should initialize. afetr initializing, start will be signaled. suspend and resume may be called while running The simulation will run for some amount of time, until stop will be called. then either reset or shutdown may be called. shutdown should then disconnect.

Author:

developer

Nested Class Summary

Nested classes/interfaces inherited from interface org.commonreality.participant.IParticipant

IParticipant.State

Constructor Summary

Constructors

Constructor and Description
AbstractParticipant(IIdentifier.Type type)

Method Summary

Modifier and Type	Method and Description
void	addClientService(org.commonreality.mina.transport.IMINATransportProvider transport, org.commonreality.mina.protocol.IMINAProtocolConfiguration configuration, java.net.SocketAddress address) specify what transport, protocol and address we can use to connect to another participant (usually, just common reality)
void	addServerService(org.commonreality.mina.transport.IMINATransportProvider transport, org.commonreality.mina.protocol.IMINAProtocolConfiguration configuration, java.net.SocketAddress address) specify what transport, protocol and address we can accessed on
protected void	checkState(IParticipant.State... states) checks the state to see if it matches one of these, if not, it fires an exception
protected void	clearObjectManagers()
void	configure(java.util.Map<java.lang.String,java.lang.String> options) configure the participant.
void	connect() connect
protected IAfferentObjectManager	createAfferentObjectManager()
protected IAgentObjectManager	createAgentObjectManager()
protected IEfferentCommandManager	createEfferentCommandManager()
protected IEfferentObjectManager	createEfferentObjectManager()
protected java.util.concurrent.ExecutorService	createIOExecutorService() creates a single thread pool executor from Mina's orderd thread pool executor so that we can be sure the messages do actually arrive in order.
protected org.apache.mina.core.service.IoHandler	createIOHandler(IIdentifier.Type type)
protected INotificationManager	createNotificationManager()
protected IRealObjectManager	createRealObjectManager()
protected ISensorObjectManager	createSensorObjectManager()
void	disconnect() disconnect, reverting to unknown
void	disconnect(boolean force) force the system to disconnect, regardless of its current state
abstract IAddressingInformation	getAddressingInformation()
IAfferentObjectManager	getAfferentObjectManager()
IAgentObjectManager	getAgentObjectManager()
protected GeneralThreadFactory	getCentralThreadFactory()
IClock	getClock() return the clock that this participant has access to
IIdentifier	getCommonRealityIdentifier()
abstract ICredentials	getCredentials()
IEfferentCommandManager	getEfferentCommandManager()
IEfferentObjectManager	getEfferentObjectManager()
IIdentifier	getIdentifier() we don't have a valid identifier until we have connected to reality
protected java.util.concurrent.Executor	getIOExecutor()
protected org.apache.mina.core.service.IoHandler	getIOHandler()
protected GeneralThreadFactory	getIOThreadFactory()
abstract java.lang.String	getName()
INotificationManager	getNotificationManager()
static java.util.concurrent.ScheduledExecutorService	getPeriodicExecutor() return a shared periodic executor that can be useful in many circumstances for periodic events
IRealObjectManager	getRealObjectManager()
ISensorObjectManager	getSensorObjectManager()
protected java.util.Collection<IAddressingInformation>	getServerAddressInformation()
IParticipant.State	getState() return the current state of the participant, and, if initialized, the state of the simulation
void	initialize() called in response to a command from Reality to get everything ready to run.
void	reset(boolean clockWillBeReset) called when we are to reset to a post-initialize state.
void	resume() resume a suspended participant and return state to started.
java.util.concurrent.Future<IAcknowledgement>	send(IMessage message) send a message to common reality.
protected void	setClock(IClock clock)
void	setCommonRealityIdentifier(IIdentifier crId)
void	setIdentifier(IIdentifier identifier) called after the connection has been established..
void	shutdown() shutdown the participant if it is stopped and disconnect
void	shutdown(boolean force) shutdown, disconnect, without checking states
void	start() called to actually start this participant
boolean	stateMatches(IParticipant.State... states)
void	stop() called when this participant needs to stop
void	suspend() suspend the participant if it is started.
IParticipant.State	waitForState(IParticipant.State... states) wait until the participant's state is one of these.
IParticipant.State	waitForState(long waitTime, IParticipant.State... states)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractParticipant

public AbstractParticipant(IIdentifier.Type type)

Method Detail

getPeriodicExecutor

public static java.util.concurrent.ScheduledExecutorService getPeriodicExecutor()

return a shared periodic executor that can be useful in many circumstances for periodic events

Returns:

createSensorObjectManager

protected ISensorObjectManager createSensorObjectManager()

createRealObjectManager

protected IRealObjectManager createRealObjectManager()

createAgentObjectManager

protected IAgentObjectManager createAgentObjectManager()

createAfferentObjectManager

protected IAfferentObjectManager createAfferentObjectManager()

createEfferentObjectManager

protected IEfferentObjectManager createEfferentObjectManager()

createEfferentCommandManager

protected IEfferentCommandManager createEfferentCommandManager()

createNotificationManager

protected INotificationManager createNotificationManager()

getNotificationManager

public INotificationManager getNotificationManager()

Specified by:

getNotificationManager in interface IParticipant

getEfferentCommandManager

public IEfferentCommandManager getEfferentCommandManager()

Specified by:

getEfferentCommandManager in interface IParticipant

Returns:

getRealObjectManager

public IRealObjectManager getRealObjectManager()

Specified by:

getRealObjectManager in interface IParticipant

setCommonRealityIdentifier

public void setCommonRealityIdentifier(IIdentifier crId)

getCommonRealityIdentifier

public IIdentifier getCommonRealityIdentifier()

getAddressingInformation

public abstract IAddressingInformation getAddressingInformation()

getCredentials

public abstract ICredentials getCredentials()

getName

public abstract java.lang.String getName()

getCentralThreadFactory

protected GeneralThreadFactory getCentralThreadFactory()

getIOThreadFactory

protected GeneralThreadFactory getIOThreadFactory()

createIOExecutorService

protected java.util.concurrent.ExecutorService createIOExecutorService()

creates a single thread pool executor from Mina's orderd thread pool executor so that we can be sure the messages do actually arrive in order.

Returns:

getIOExecutor

protected final java.util.concurrent.Executor getIOExecutor()

addServerService

public void addServerService(org.commonreality.mina.transport.IMINATransportProvider transport,
                             org.commonreality.mina.protocol.IMINAProtocolConfiguration configuration,
                             java.net.SocketAddress address)

specify what transport, protocol and address we can accessed on

Parameters:

service -

address -

addClientService

public void addClientService(org.commonreality.mina.transport.IMINATransportProvider transport,
                             org.commonreality.mina.protocol.IMINAProtocolConfiguration configuration,
                             java.net.SocketAddress address)

specify what transport, protocol and address we can use to connect to another participant (usually, just common reality)

Parameters:

service -

address -

waitForState

public final IParticipant.State waitForState(IParticipant.State... states)
                                      throws java.lang.InterruptedException

Description copied from interface: IParticipant

wait until the participant's state is one of these.

Specified by:

waitForState in interface IParticipant

Returns:

Throws:

java.lang.InterruptedException

waitForState

public final IParticipant.State waitForState(long waitTime,
                                             IParticipant.State... states)
                                      throws java.lang.InterruptedException

Specified by:

waitForState in interface IParticipant

Throws:

java.lang.InterruptedException

getState

public final IParticipant.State getState()

Description copied from interface: IParticipant

return the current state of the participant, and, if initialized, the state of the simulation

Specified by:

getState in interface IParticipant

Returns:

stateMatches

public boolean stateMatches(IParticipant.State... states)

Specified by:

stateMatches in interface IParticipant

checkState

protected void checkState(IParticipant.State... states)

checks the state to see if it matches one of these, if not, it fires an exception

Parameters:

states -

setIdentifier

public void setIdentifier(IIdentifier identifier)

called after the connection has been established..

Parameters:

identifier -

getIdentifier

public IIdentifier getIdentifier()

we don't have a valid identifier until we have connected to reality

Specified by:

getIdentifier in interface IIdentifiable

Returns:

identifier

See Also:

IIdentifiable.getIdentifier()

configure

public void configure(java.util.Map<java.lang.String,java.lang.String> options)
               throws java.lang.Exception

Description copied from interface: IParticipant

configure the participant. this may be called at while UNKNOWN, CONNECTED, INITIALIZED, or STOPPED

Specified by:

configure in interface IParticipant

Throws:

java.lang.Exception

initialize

public void initialize()
                throws java.lang.Exception

called in response to a command from Reality to get everything ready to run. we must be connected first.

Specified by:

initialize in interface IParticipant

Throws:

java.lang.Exception

start

public void start()
           throws java.lang.Exception

called to actually start this participant

Specified by:

start in interface IParticipant

Throws:

java.lang.Exception

stop

public void stop()
          throws java.lang.Exception

called when this participant needs to stop

Specified by:

stop in interface IParticipant

Throws:

java.lang.Exception

suspend

public void suspend()
             throws java.lang.Exception

Description copied from interface: IParticipant

suspend the participant if it is started. if not, it will throw an IllegalStateException

Specified by:

suspend in interface IParticipant

Throws:

java.lang.Exception

resume

public void resume()
            throws java.lang.Exception

Description copied from interface: IParticipant

resume a suspended participant and return state to started.

Specified by:

resume in interface IParticipant

Throws:

java.lang.Exception

reset

public void reset(boolean clockWillBeReset)
           throws java.lang.Exception

called when we are to reset to a post-initialize state. this impl attempts to reset the clock if it is INetworked or ISettabl

Specified by:

reset in interface IParticipant

Throws:

java.lang.Exception

shutdown

public void shutdown(boolean force)
              throws java.lang.Exception

Description copied from interface: IParticipant

shutdown, disconnect, without checking states

Specified by:

shutdown in interface IParticipant

Throws:

java.lang.Exception

shutdown

public void shutdown()
              throws java.lang.Exception

Description copied from interface: IParticipant

shutdown the participant if it is stopped and disconnect

Specified by:

shutdown in interface IParticipant

Throws:

java.lang.Exception

clearObjectManagers

protected void clearObjectManagers()

connect

public void connect()
             throws java.lang.Exception

Description copied from interface: IParticipant

connect

Specified by:

connect in interface IParticipant

Throws:

java.lang.Exception

See Also:

IParticipant.connect()

disconnect

public void disconnect()
                throws java.lang.Exception

Description copied from interface: IParticipant

disconnect, reverting to unknown

Specified by:

disconnect in interface IParticipant

Throws:

java.lang.Exception

disconnect

public void disconnect(boolean force)
                throws java.lang.Exception

Description copied from interface: IParticipant

force the system to disconnect, regardless of its current state

Specified by:

disconnect in interface IParticipant

Throws:

java.lang.Exception

getServerAddressInformation

protected java.util.Collection<IAddressingInformation> getServerAddressInformation()

getClock

public IClock getClock()

return the clock that this participant has access to

Specified by:

getClock in interface IParticipant

Returns:

setClock

protected void setClock(IClock clock)

send

public java.util.concurrent.Future<IAcknowledgement> send(IMessage message)

send a message to common reality. We also cache any data requests going out and store them temporarily. they will not be applied to the respective object manager until we get confirmation from CR

Specified by:

send in interface IParticipant

Parameters:

message -

Returns:

createIOHandler

protected org.apache.mina.core.service.IoHandler createIOHandler(IIdentifier.Type type)

getIOHandler

protected final org.apache.mina.core.service.IoHandler getIOHandler()

getSensorObjectManager

public ISensorObjectManager getSensorObjectManager()

Specified by:

getSensorObjectManager in interface IParticipant

getAfferentObjectManager

public IAfferentObjectManager getAfferentObjectManager()

Specified by:

getAfferentObjectManager in interface IParticipant

getEfferentObjectManager

public IEfferentObjectManager getEfferentObjectManager()

Specified by:

getEfferentObjectManager in interface IParticipant

getAgentObjectManager

public IAgentObjectManager getAgentObjectManager()

Specified by:

getAgentObjectManager in interface IParticipant