rsb

Class Informer<DataType>

java.lang.Object

rsb.AbstractActivatable

rsb.Participant

rsb.Informer<DataType>

Type Parameters:

DataType - The type of data sent by this informer

All Implemented Interfaces:

Closeable, AutoCloseable, Activatable

public class Informer<DataType>
extends Participant

This class offers a method to publish events to a channel, reaching all participating Listeners. This n:m-communication is one of the basic communication patterns offered by RSB.

Author:

swrede, rgaertne, jschaefe, jwienke

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activates all resources that belong to a specific object.
void	deactivate() Deactivate all resources that are owned by a specific object in order to correctly tear down.
Class<?>	getDataType() Returns the data type transfered by this participant.
String	getKind() Returns kind of participant in RSB terminology.
Set<URI>	getTransportUris() Returns URIs describing the transports configured for this participants.
Class<?>	getTypeInfo() Returns the class describing the type of data sent by this informer.
boolean	isActive() Tells whether this class is currently active or not.
Event	publish(DataType data) Publish data (of type DataType) to all subscribed participants.
Event	publish(Event event) Publish an Event to all subscribed participants.
Event	send(DataType data) Deprecated. Use publish(Object) instead to be consistent across implementations
Event	send(Event event) Deprecated. Use publish(Event) instead to be consistent across implementations
void	setTypeInfo(Class<?> typeInfo) Set the class object describing the type of data sent by this informer.

Methods inherited from class rsb.Participant

getConfig, getId, getObserverManager, getScope, setObserverManager

Methods inherited from class rsb.AbstractActivatable

close

Methods inherited from class java.lang.Object

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

Method Detail

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

send

@Deprecated
public Event send(Event event)
           throws RSBException

Deprecated. Use publish(Event) instead to be consistent across implementations

Send an Event to all subscribed participants.

Parameters:

event - the event to send

Returns:

modified event with set timing information

Throws:

RSBException - error sending event

IllegalArgumentException - if the event is not complete or does not match the type or scope settings of the informer

publish

public Event publish(Event event)
              throws RSBException

Publish an Event to all subscribed participants.

Parameters:

event - the event to send

Returns:

modified event with set timing information

Throws:

RSBException - error sending event

IllegalArgumentException - if the event is not complete or does not match the type or scope settings of the informer

send

@Deprecated
public Event send(DataType data)
           throws RSBException

Deprecated. Use publish(Object) instead to be consistent across implementations

Send data (of type DataType) to all subscribed participants.

Parameters:

data - data to send with default setting from the informer

Returns:

generated event

Throws:

RSBException - error sending event

publish

public Event publish(DataType data)
              throws RSBException

Publish data (of type DataType) to all subscribed participants.

Parameters:

data - data to send with default setting from the informer

Returns:

generated event

Throws:

RSBException - error sending event

getTypeInfo

public Class<?> getTypeInfo()

Returns the class describing the type of data sent by this informer.

Returns:

class

setTypeInfo

public void setTypeInfo(Class<?> typeInfo)

Set the class object describing the type of data sent by this informer.

Parameters:

typeInfo - a Class instance describing the sent data

isActive

public boolean isActive()

Description copied from interface: Activatable

Tells whether this class is currently active or not.

Returns:

true if active

getKind

public String getKind()

Description copied from class: Participant

Returns kind of participant in RSB terminology.

Specified by:

getKind in class Participant

Returns:

Key describing participant. One of listener, informer, local-server, local-method, remote-server, remote-method

getDataType

public Class<?> getDataType()

Description copied from class: Participant

Returns the data type transfered by this participant.

Specified by:

getDataType in class Participant

Returns:

type class, null if not applicable for this type of participant

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