rsb.introspection

Class IntrospectionModel

java.lang.Object

rsb.introspection.IntrospectionModel

public class IntrospectionModel
extends Object

A model of existing participants in an RSB-based system. The model is a collection of participant representations and can be observed. The implementation is thread-safe. In case multiple operations need to be atomic, clients can synchronize on this class.

Author:

swrede, ssharma, jwienke

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IntrospectionModel.IntrospectionModelObserver Interface to implement when observing an instance of IntrospectionModel.

Constructor Summary

Constructors

Constructor and Description
IntrospectionModel()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addObserver(IntrospectionModel.IntrospectionModelObserver observer) Adds an observer to this model.
void	addParticipant(Participant participant, Participant parent) Adds a participant to the model.
ParticipantInfo	getParticipant(ParticipantId participantId) Queries the database of known participants for the participant with the given uuid and returns the associated ParticipantInfo instance.
Set<ParticipantInfo>	getParticipants() Returns the collection of participants.
boolean	isEmpty() Indicates whether any participants are known.
boolean	removeObserver(IntrospectionModel.IntrospectionModelObserver observer) Removes an observer from this model.
void	removeParticipant(Participant participant) Removes a participant from the model.

Methods inherited from class java.lang.Object

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

Constructor Detail

IntrospectionModel

public IntrospectionModel()

Method Detail

addObserver

public boolean addObserver(IntrospectionModel.IntrospectionModelObserver observer)

Adds an observer to this model.

Parameters:

observer - observer to add, not null

Returns:

true if the oberserver was newly added

removeObserver

public boolean removeObserver(IntrospectionModel.IntrospectionModelObserver observer)

Removes an observer from this model.

Parameters:

observer - observer to remove, not null

Returns:

true if the observer existed and was removed

getParticipants

public Set<ParticipantInfo> getParticipants()

Returns the collection of participants. Clients need to ensure synchronization on this instance when using the returned collection.

Returns:

set of participants

isEmpty

public boolean isEmpty()

Indicates whether any participants are known.

Returns:

true if the model contains participants

getParticipant

public ParticipantInfo getParticipant(ParticipantId participantId)

Queries the database of known participants for the participant with the given uuid and returns the associated ParticipantInfo instance. Remember to synchronize on this instance in case you want to ensure that the participant still exists in the model when you operate with it.

Parameters:

participantId - the id of participant, not null

Returns:

the associated participant info or null in case there is no participant with the given id

addParticipant

public void addParticipant(Participant participant,
                  Participant parent)

Adds a participant to the model.

Parameters:

participant - the new participant, not null

parent - optionally the parent participant or null if no parent exists

removeParticipant

public void removeParticipant(Participant participant)

Removes a participant from the model.

Parameters:

participant - participant to remove, not null