|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISubscriber
Common interface for all implementation of EAI Subscribers. An EAI Subscriber doesn't reply to an event, it only deals with it.
Method Summary | |
---|---|
void |
addEventHandler(IEventHandler pNewHandler)
Adds an Event Handler to this subscriber. |
IPublisher |
getErrorPublisher()
Extracts the publisher used for publising internal errors. |
java.lang.String |
getEventSubject()
The subject/topic to which this instance is subscribed to. |
java.lang.Object |
getNativeSub()
Returns the embedded subscriber. |
long |
getNbMsgReceived()
The number of messages received by this subscriber since it has been started. |
void |
removeEventHandler(java.lang.String pHandlerName)
Removes an EventHandler from this subscriber. |
void |
setErrorPublisher(IPublisher pErrorPublisher)
Defines the error publisher to be used by this instance. |
void |
setNativeSub(java.lang.Object pSubscriber)
Assigns the native subscriber to this element. |
Method Detail |
---|
void addEventHandler(IEventHandler pNewHandler) throws RaccoonException
pNewHandler
- the new event handler
RaccoonException
- if the key of the Event Handler has already been
inserted into this subscriber.IEventHandler
void removeEventHandler(java.lang.String pHandlerName) throws RaccoonException
pHandlerName
- the logical name of the handler
RaccoonException
- if the handler couldn't be found.java.lang.Object getNativeSub()
void setNativeSub(java.lang.Object pSubscriber) throws RaccoonException, java.lang.IllegalArgumentException
pSubscriber
- the native subscriber.
RaccoonException
- if this component is already running: the component can't be changed.
Error code is ErrorCodes.COMPONENT_INITIALISED
java.lang.IllegalArgumentException
- if the parameter is null
, the message is obtained via
MsgHelper.formatNullParamter(java.lang.String, java.lang.Class)
java.lang.String getEventSubject()
IPublisher getErrorPublisher()
void setErrorPublisher(IPublisher pErrorPublisher) throws RaccoonException, java.lang.IllegalArgumentException, java.lang.InternalError
pErrorPublisher
- the error publisher instance
RaccoonException
- if this component is already running: the component can't be changed.
Error code is ErrorCodes.COMPONENT_INITIALISED
java.lang.IllegalArgumentException
- if the parameter is null
, the message is obtained via
MsgHelper.formatNullParamter(java.lang.String, java.lang.Class)
java.lang.InternalError
- if the property pParamName
hasn't been defined.long getNbMsgReceived()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |