com.entrust.toolkit.resourcemonitor

Class ResourceEventProcessor

java.lang.Object

com.entrust.toolkit.resourcemonitor.ResourceEventProcessor

All Implemented Interfaces:

ResourceListener

Direct Known Subclasses:

ResourceMonitor

public class ResourceEventProcessor
extends java.lang.Object
implements ResourceListener

The ResourceEventProcessor is a ResourceListener that can be used to process ResourceEvent notifications. A ResourceEvent is processed whenever the Notification() method is called by a Resource which has registered this ResourceEventProcessor.

ResourceEvents are processed by calling a ResourceEventHandler using the information contained in the ResourceEvent. Events can be processed using one of the following user defined modes which are set using method setProcessingMode(int).

• ALL_EVENT_HANDLERS (0) - Mode used to specify that all event handlers should be used.
• RESOURCE_HANDLERS_ONLY (1) - Mode use to specify that only events contained in the Resource should be used.
• LOCAL_HANDLER_ONLY (2) - Mode used to specify that only the handler specified in this class should be used.
• GENERIC_HANDLER (3) - Mode used to specify that only a generic ResourceOutputHandler handler should be used.
• NO_HANDLER (4) - Mode used to specify that no handler should be used.

Since:

7.2

See Also:

Resource, ResourceListener, ResourceEvent

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_EVENT_HANDLERS Mode used to specify that all event handlers should be used.
static int	GENERIC_HANDLER Mode used to specify that only the generic ResourceOutputHandler handler should be used.
static int	LOCAL_HANDLER_ONLY Mode used to specify that only the handler specified in this class should be used.
ResourceEventHandler	m_handler The Event Handler which can be used for all Resources that are using this Listener.
static int	NO_HANDLER Mode used to specify that no handler should be used.
static int	RESOURCE_HANDLERS_ONLY Mode use to specify that only events contained in the Resource should be used.

Constructor Summary

Constructors

Constructor and Description
ResourceEventProcessor()

Method Summary

Modifier and Type	Method and Description
ResourceEventHandler	getEventHandler() Get the ResourceEventHandler which has been locally configured using setEventHandler(ResourceEventHandler) to handle Event Notification for a Resource.
int	getProcessingMode() Return the processing mode set by this ResourceEventProcessor
void	Notification(ResourceEvent event) This method is called by a Resource when it is determined that an event notification should be triggered.
void	removeEventHandler() Remove the local ResourceEventHandler specified by this ResourceEventProcessor.
void	setEventHandler(ResourceEventHandler handler) A local ResourceEventHandler can be specified by this ResourceEventProcessor.
void	setProcessingMode(int Mode) Sets the processing mode.

Methods inherited from class java.lang.Object

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

Field Detail

ALL_EVENT_HANDLERS

public static final int ALL_EVENT_HANDLERS

Mode used to specify that all event handlers should be used. Events will be processed as follows:

• If the ResourceEvent contained a Resource, any event handlers that were contained in the resource will be used to handle the event.
• If this ResourceEventProcessor contained a ResourceEventHandler, it will be used to handle the event
• If no handlers could be found, then a generic ResourceOutputHandler will be used to handle the event. In this case, the event messages will be sent to System.out

Note: If both the Resource handlers and the handler specified by this class contain the same ResourceEventHandler, the same event will be handled twice.

See Also:

Constant Field Values

RESOURCE_HANDLERS_ONLY

public static final int RESOURCE_HANDLERS_ONLY

Mode use to specify that only events contained in the Resource should be used. Events will be processed as follows:

• If the ResourceEvent contained a Resource, any event handlers that were contained in the resource will be used to handle the event.
• If no handlers could be found, then a generic ResourceOutputHandler will be used to handle the event. In this case, the event messages will be sent to System.out

See Also:

Constant Field Values

LOCAL_HANDLER_ONLY

public static final int LOCAL_HANDLER_ONLY

Mode used to specify that only the handler specified in this class should be used. Events will be processed as follows:

• If this ResourceEventProcessor contained a ResourceEventHandler, it will be used to handle the event
• If no handlers could be found, then a generic ResourceOutputHandler will be used to handle the event. In this case, the event messages will be sent to System.out

See Also:

Constant Field Values

GENERIC_HANDLER

public static final int GENERIC_HANDLER

Mode used to specify that only the generic ResourceOutputHandler handler should be used. Events will be processed as follows:

• A generic ResourceOutputHandler will be used to handle the event. In this case, the event messages will be sent to System.out

See Also:

Constant Field Values

NO_HANDLER

public static final int NO_HANDLER

Mode used to specify that no handler should be used. No Events will be processed.

See Also:

Constant Field Values

m_handler

public ResourceEventHandler m_handler

The Event Handler which can be used for all Resources that are using this Listener. This handler will be used if the

Constructor Detail

ResourceEventProcessor

public ResourceEventProcessor()

Method Detail

Notification

public void Notification(ResourceEvent event)
                  throws ResourceEventException

This method is called by a Resource when it is determined that an event notification should be triggered. The purpose of this method is to process the ResourceEvent which is used to convey the Notification information.

The Processing of events is determined by setting the processing mode using the setProcessingMode(int) to one of the following modes:

• ALL_EVENT_HANDLERS (0) - Mode used to specify that all event handlers should be used.
• RESOURCE_HANDLERS_ONLY (1) - Mode use to specify that only events contained in the Resource should be used.
• LOCAL_HANDLER_ONLY (2) - Mode used to specify that only the handler specified in this class should be used.
• GENERIC_HANDLER (3) - Mode used to specify that only a generic ResourceOutputHandlert handler should be used.
• NO_HANDLER (4) - Mode used to specify that no handler should be used.

Specified by:

Notification in interface ResourceListener

Throws:

ResourceEventException

See Also:

Resource

setEventHandler

public void setEventHandler(ResourceEventHandler handler)

A local ResourceEventHandler can be specified by this ResourceEventProcessor. This ResourceEventHandler will be used when the processing mode is set to ALL_EVENT_HANDLERS (0) or LOCAL_HANDLER_ONLY (2).

Parameters:

handler - the ResourceEventHandler which will be used to handle a ResourceEvent

See Also:

ALL_EVENT_HANDLERS, LOCAL_HANDLER_ONLY

removeEventHandler

public void removeEventHandler()

Remove the local ResourceEventHandler specified by this ResourceEventProcessor.

Note: If the processing mode is set to LOCAL_HANDLER_ONLY, then the default ResourceOutputHandler will be used to handle events. Effectively it is the same as using the processing mode GENERIC_HANDLER

See Also:

LOCAL_HANDLER_ONLY, GENERIC_HANDLER

getEventHandler

public ResourceEventHandler getEventHandler()

Get the ResourceEventHandler which has been locally configured using setEventHandler(ResourceEventHandler) to handle Event Notification for a Resource.

Returns:

the ResourceEventHandler

setProcessingMode

public void setProcessingMode(int Mode)

Sets the processing mode. Choices are:

• ALL_EVENT_HANDLERS (0) - Mode used to specify that all event handlers should be used.
• RESOURCE_HANDLERS_ONLY (1) - Mode use to specify that only events contained in the Resource should be used.
• LOCAL_HANDLER_ONLY (2) - Mode used to specify that only the handler specified in this class should be used.
• GENERIC_HANDLER (3) - Mode used to specify that only the default handler should be used.
• NO_HANDLER (4) - Mode used to specify that no handler should be used.

The default is ALL_EVENT_HANDLERS. If no handers are specified, the Default ResourceOutputHandler will handle the events by writing the message to System.out.

Parameters:

Mode - the processing mode to be used

getProcessingMode

public int getProcessingMode()

Return the processing mode set by this ResourceEventProcessor

Returns:

the processsing mode

See Also:

setProcessingMode(int)