com.prosyst.mprm.backend.event

Interface EventService

public interface EventService

Service interface intended for event generator objects. It provides methods for sending synchronous and asynchronous events to registered event listeners. Event listeners can resides on any mPRM Backend Host or on external applications connected through mPRM Remote Access Client.

Method Summary

Modifier and Type	Method and Description
void	event(java.lang.String eventType, byte[] externalizedEventData) The same as event(java.lang.String eventType, java.lang.Object eventData) but the event data argument is passed in an externalized form.
void	event(java.lang.String eventType, java.lang.Object eventData) Sends an event.
void	event(java.lang.String eventType, java.lang.Object eventData, java.util.Dictionary eventProperties, java.lang.String userRoleFilter) Sends an event.
boolean	existsListener(java.lang.String eventType, java.util.Dictionary eventProperties, java.lang.String userRoleFilter) Returns whether there is any listener registered for the events of the specified type, custom filter properties and user role (for RAC listeners only).

Method Detail

event

void event(java.lang.String eventType,
           java.lang.Object eventData)
    throws EventListenerException

Sends an event. This method delivers event to appropriate event listeners. The event can be deliverd synchronously or asynchronously depending of event listeners registration properties. If there is no registered synchronous listeners then the method returns immediately - the event delivery is accomplished in separate thread.

Parameters:

eventType - the type of the event. Cannot be null.

eventData - event specific object, implementing Externalizable interface. Can be null.

Throws:

EventListenerException - the exception is thrown if some of the synchronous event listeners has thrown EventListenerException in result of the event processing.

event

void event(java.lang.String eventType,
           java.lang.Object eventData,
           java.util.Dictionary eventProperties,
           java.lang.String userRoleFilter)
    throws EventListenerException

Sends an event. This method delivers event to appropriate event listeners. The event can be delivered synchronously or asynchronously depending of event listeners registration properties. If there is no registered synchronous listeners then the method returns immediately - the event delivery is accomplished in separate thread.

Parameters:

eventType - the type of the event. Cannot be null.

eventData - event specific object, implementing Externalizable interface. Can be null.

eventProperties - additional properties of the event used for custom filtering of the event delivered to the listeners specified EventListener.EVENT_CUSTOM_FILTER registration property.

userRoleFilter - passing non-null value to this parameter, will deliver the event only to those RAC listeners, which are registered in a remote session of an user having the specified role. This parameter do not apply to backend listeners.

Throws:

EventListenerException - the exception is thrown if some of the synchronous event listeners has thrown EventListenerException in result of the event processing.

event

void event(java.lang.String eventType,
           byte[] externalizedEventData)
    throws EventListenerException

The same as event(java.lang.String eventType, java.lang.Object eventData) but the event data argument is passed in an externalized form. The listeners will receive the corresponding deserialized object.

Parameters:

eventType - the type of the event. Cannot be null.

externalizedEventData - the externalized form of the event data object. Can't be null.

Throws:

EventListenerException - the exception is thrown if some of the synchronous event listeners has thrown EventListenerException in result of the event processing.

existsListener

boolean existsListener(java.lang.String eventType,
                       java.util.Dictionary eventProperties,
                       java.lang.String userRoleFilter)

Returns whether there is any listener registered for the events of the specified type, custom filter properties and user role (for RAC listeners only).

Parameters:

eventType - the type of the event

eventProperties - the custom filter properties, which are evaluated for listeners registered with EventListener.EVENT_CUSTOM_FILTER property. This argument may be null, which means that the method will return if there is a listener without custom filter.

userRoleFilter - the role of the users, allowed to get such events. This filter applies to those listeners which are registered through an mPRM Remote Access Client session. This argument may be null.

Returns:

true if such event would be delivered to at least one listener.