public class EventBroker extends Object implements IEventBroker
IEventBroker
Modifier and Type | Field and Description |
---|---|
protected List |
receivers |
protected HashMap |
senderMap |
PRIO_MAX, PRIO_MIN
Constructor and Description |
---|
EventBroker()
Construct object of class EventBroker.
|
Modifier and Type | Method and Description |
---|---|
IEventList |
clearHoldEvents(IEventReceiver receiver)
Remove all hold but not yet sent events for the given receiver.
|
IEventList |
getEvents()
Returns a list of event templates for all possible events this broker can
send (determined by querying all registered senders).
|
IEventList |
getHoldEvents(IEventReceiver receiver)
Get all hold but not yet sent events for the given receiver.
|
ReceiverMode |
getMode(IEventReceiver receiver)
Get the receiver mode of the receiver, i.e. off, sending and so on.
|
void |
hold(IEventReceiver receiver,
boolean collect)
TBD: Unknown function.
|
void |
register(IEventReceiver receiver,
IEvent template)
Registers an event receiver.
|
void |
register(IEventReceiver receiver,
IEvent template,
IEventMapper mapper)
See the general contract of the
register(IEventReceiver, IEvent)
method. |
void |
register(IEventReceiver receiver,
IEvent template,
IEventMapper mapper,
int priority,
boolean async)
See the general contract of the
register(IEventReceiver, IEvent,
IEventMapper) and register(IEventReceiver, IEvent, int, boolean)
method. |
void |
register(IEventReceiver receiver,
IEvent template,
int priority,
boolean async)
See the general contract of the
register(IEventReceiver, IEvent)
method. |
void |
register(IEventSender sender)
Registers an event sender instance.
|
void |
resume(IEventReceiver receiver)
Resumes a previously suspended event receiver.
|
void |
send(IEvent event,
IEventSender sender)
Sends the specified event to all receivers that have registered for this
kind of event.
|
void |
suspend(IEventReceiver receiver)
Suspend the event receiver.
|
void |
unregister(IEventReceiver receiver,
IEvent template)
Unregisters an event receiver instance.
|
void |
unregister(IEventSender sender)
Unregisters an event sender instance.
|
public void send(IEvent event, IEventSender sender) throws BaseException
send
in interface IEventBroker
event
- event to be sentsender
- event sender instance sending the eventBaseException
- when the event sender is not registeredpublic void register(IEventSender sender) throws BaseException
register
in interface IEventBroker
sender
- event sender to be registeredBaseException
- when the registration failspublic void register(IEventReceiver receiver, IEvent template) throws BaseException
IEvent.isLike(com.sap.netweaver.bc.rf.util.event.IEvent)
method. Usually the event's instance and
type are relevant. It is allowed to register the same event receiver
instance several times with different templates.register
in interface IEventBroker
receiver
- event receiver to be registeredtemplate
- event template on which the event receiver will receive
eventsBaseException
- when the registration failspublic void register(IEventReceiver receiver, IEvent template, IEventMapper mapper) throws BaseException
register(IEventReceiver, IEvent)
method. This registration method has an additional IEventMapper
argument, i.e. that the mapper will be called prior to giving the event to
the receiver.register
in interface IEventBroker
receiver
- event receiver to be registeredtemplate
- event template on which the event receiver will receive
eventsmapper
- event mapper to be called prior to giving the event to the
receiverBaseException
- when the registration failsIEventMapper
public void register(IEventReceiver receiver, IEvent template, int priority, boolean async) throws BaseException
register(IEventReceiver, IEvent)
method. This registration method has two additional arguments for priority
and asynchronous events. The priority controls the order of multiple receivers which have registered for the same event(s). Receivers with higher priority (smaller values) will receive an event before receivers with lower priority (greater values).
An event receiver can choose to receive events asynchronously. This means that a dedicated event queue and sender thread is created for each receiver and template. The event sender will not be blocked, that means the send() method puts the event into the queue and returns immediately.
register
in interface IEventBroker
receiver
- event receiver to be registeredtemplate
- event template on which the event receiver will receive
eventspriority
- priority of this receiver and templateasync
- true when the receiver would receive the events on a separate
threadBaseException
- when the registration failspublic void register(IEventReceiver receiver, IEvent template, IEventMapper mapper, int priority, boolean async) throws BaseException
register(IEventReceiver, IEvent,
IEventMapper)
and register(IEventReceiver, IEvent, int, boolean)
method.register
in interface IEventBroker
receiver
- event receiver to be registeredtemplate
- event template on which the event receiver will receive
eventsmapper
- event mapper to be called prior to giving the event to the
receiverpriority
- priority of this receiver and templateasync
- true when the receiver would receive the events on a separate
threadBaseException
- when the registration failsIEventMapper
public void unregister(IEventSender sender) throws BaseException
unregister
in interface IEventBroker
sender
- event sender to be unregisteredBaseException
- when the unregistration failspublic void unregister(IEventReceiver receiver, IEvent template) throws BaseException
unregister
in interface IEventBroker
receiver
- event receiver to be unregisteredtemplate
- event template on which the event receiver will no longer
receive eventsBaseException
- when the unregistration failspublic void suspend(IEventReceiver receiver)
resume(com.sap.netweaver.bc.rf.util.event.IEventReceiver)
is called.suspend
in interface IEventBroker
receiver
- event receiverpublic void resume(IEventReceiver receiver)
resume
in interface IEventBroker
receiver
- event receiverpublic void hold(IEventReceiver receiver, boolean collect)
hold
in interface IEventBroker
receiver
- TBD: Unknown parametercollect
- TBD: Unknown parameterpublic ReceiverMode getMode(IEventReceiver receiver)
getMode
in interface IEventBroker
receiver
- event receiverReceiverMode
public IEventList getHoldEvents(IEventReceiver receiver)
getHoldEvents
in interface IEventBroker
receiver
- event receiverpublic IEventList clearHoldEvents(IEventReceiver receiver)
clearHoldEvents
in interface IEventBroker
receiver
- event receiverpublic IEventList getEvents()
getEvents
in interface IEventBroker
Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice