org.universAAL.middleware.bus.member

Class BusMember

java.lang.Object

org.universAAL.middleware.bus.member.BusMember

Direct Known Subclasses:

Callee, Caller, Publisher, Subscriber

public abstract class BusMember
extends Object

A SpaceParticipant can connect to the different buses of the universAAL middleware by becoming a member, i.e., by creating instances of this class. Each instance of BusMember represents exactly one connection with a specific role on one specific bus: on call-based buses either as a caller or as a callee and on event-based buses either as a publisher or as a subscriber. However, there is no limitation for the number of instances of BusMember that an SpaceParticipant can create; i.e., an SpaceParticipant can create different instances of BusMember to connect to different buses; it is also possible to connect with different roles to the same bus or even create, say, several publishers on one and the same event-based bus while at the same time creating even several subscribers on that very bus. BusMember is an abstract class with the idea that for each concrete role on each concrete bus a specific subclass is created. It also forces that the creation of an instance is bound to a specific SpaceParticipant.

Author:

mtazari - Saied Tazari

Field Summary

Fields

Modifier and Type	Field and Description
protected String	busResourceURI
protected ModuleContext	owner
protected AbstractBus	theBus

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BusMember(ModuleContext owner, Object[] busFetchParams, BusMemberType type)

Method Summary

Modifier and Type	Method and Description
abstract void	busDyingOut(AbstractBus b) This method is called when the bus is stopped to announce this to the bus members.
void	close() Unregisters the Subscriber from the bus.
String	getComment() Get the human-readable comment for this bus member.
String	getLabel() Get the human-readable label for this bus member.
BusMemberType	getType() Get the type of this bus member.
String	getURI() URI of this bus member.
void	setComment(String comment) Set a human-readable comment for this bus member.
void	setLabel(String label) Set a human-readable label for this bus member.

Methods inherited from class java.lang.Object

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

Field Detail

owner

protected final ModuleContext owner

theBus

protected final AbstractBus theBus

busResourceURI

protected final String busResourceURI

Constructor Detail

BusMember

protected BusMember(ModuleContext owner,
                    Object[] busFetchParams,
                    BusMemberType type)

Method Detail

close

public void close()

Unregisters the Subscriber from the bus.

busDyingOut

public abstract void busDyingOut(AbstractBus b)

This method is called when the bus is stopped to announce this to the bus members.

Parameters:

b - bus on which this member has been registered

See Also:

AbstractBus

getURI

public final String getURI()

URI of this bus member. The URI is created by the bus and set during registration of the the bus member at the bus.

getType

public BusMemberType getType()

Get the type of this bus member.

Returns:

the type of this bus member.

setLabel

public void setLabel(String label)

Set a human-readable label for this bus member.

Parameters:

label - the new label.

getLabel

public String getLabel()

Get the human-readable label for this bus member.

Returns:

the label.

setComment

public void setComment(String comment)

Set a human-readable comment for this bus member.

Parameters:

comment - the new comment.

getComment

public String getComment()

Get the human-readable comment for this bus member.

Returns:

the comment.