org.olat.system.event

类 AbstractEventBus

java.lang.Object

org.olat.system.event.AbstractEventBus

所有已实现的接口:

EventBus

直接已知子类:

ClusterEventBus, SingleVMEventBus

public abstract class AbstractEventBus
extends java.lang.Object
implements EventBus

abstract class for common services of the system bus

作者:

Felix Jost

构造器概要

构造器

构造器和说明
AbstractEventBus()

方法概要

方法

限定符和类型	方法和说明
void	deregisterFor(GenericEventListener gel, OLATResourceable ores) deregisters/removes a GenericEventListener to listen to events concerning the OLATResourceable ores
abstract void	fireEventToListenersOf(MultiUserEvent event, OLATResourceable ores) fires an event to all listeners interested in events concerning this OLATResourceable ores.
abstract int	getListeningIdentityCntFor(OLATResourceable ores) Note for cluster: this method is cluster-safe. in a cluster, it takes the latest counts received from all cluster nodes and sums them up.
java.util.Set	getListeningIdentityNamesFor(OLATResourceable ores) returns a Set of Identities which had at the very moment controllers which were listening to the OLATResourceable ores.
java.util.Map<java.lang.String,org.olat.system.event.EventAgency>	getUnmodifiableInfoCenter() used only for monitoring purposes
void	registerFor(GenericEventListener gel, OLATPrincipal principal, OLATResourceable ores) registers a GenericEventListener to listen to events concerning the OLATResourceable ores
java.lang.String	toString()

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

构造器详细资料

AbstractEventBus

public AbstractEventBus()

方法详细资料

registerFor

public void registerFor(GenericEventListener gel,
               OLATPrincipal principal,
               OLATResourceable ores)

从接口复制的说明: EventBus

registers a GenericEventListener to listen to events concerning the OLATResourceable ores

指定者:

registerFor 在接口中 EventBus

参数:

gel - the GenericEventListener / the class implementing it

ores - the OLATResourceable

deregisterFor

public void deregisterFor(GenericEventListener gel,
                 OLATResourceable ores)

从接口复制的说明: EventBus

deregisters/removes a GenericEventListener to listen to events concerning the OLATResourceable ores

指定者:

deregisterFor 在接口中 EventBus

getListeningIdentityNamesFor

public java.util.Set getListeningIdentityNamesFor(OLATResourceable ores)

从接口复制的说明: EventBus

returns a Set of Identities which had at the very moment controllers which were listening to the OLATResourceable ores. Useful to e.g. warn a power-user which wants to delete a resource (e.g. a course) that there are users using this resource right at this time. NOTE: please use only for OLAT admin tools in order to protect the privacy of users. If you would like to say "the resource you want to delete is currently used by 10 users", but not say which users, then please use method getListeningIdentityCntFor(OLATResourceable ores)..
Note for cluster: this method returns only the names of listeners within one node/vm. However, the cnt of listeners is broadcasted amongst cluster nodes - see getListeningIdentityCntFor(OLATResourceable ores);

指定者:

getListeningIdentityNamesFor 在接口中 EventBus

参数:

ores - the OLATResourceable

返回:

the listening names on a resource - only use for admin purposes!

getListeningIdentityCntFor

public abstract int getListeningIdentityCntFor(OLATResourceable ores)

从接口复制的说明: EventBus

Note for cluster: this method is cluster-safe. in a cluster, it takes the latest counts received from all cluster nodes and sums them up.

指定者:

getListeningIdentityCntFor 在接口中 EventBus

参数:

ores - the resourceable

返回:

the number of people currently using this resource

fireEventToListenersOf

public abstract void fireEventToListenersOf(MultiUserEvent event,
                          OLATResourceable ores)

从接口复制的说明: EventBus

fires an event to all listeners interested in events concerning this OLATResourceable ores. The events may be fired and received synchronously or asynchronously, depending on the concrete implementation.

指定者:

fireEventToListenersOf 在接口中 EventBus

参数:

event - the OLATResourceableEvent (must be serializable!, for multiple server olat installations)

ores - the OLATResourceable

getUnmodifiableInfoCenter

public java.util.Map<java.lang.String,org.olat.system.event.EventAgency> getUnmodifiableInfoCenter()

used only for monitoring purposes

指定者:

getUnmodifiableInfoCenter 在接口中 EventBus

返回:

the whole infocenter map

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object