com.entrust.toolkit.resourcemonitor

Class ResourceEvent

java.lang.Object

com.entrust.toolkit.resourcemonitor.ResourceEvent

Direct Known Subclasses:

HeartbeatEvent

public class ResourceEvent
extends java.lang.Object

The ResourceEvent is the base class for all types of ResourceEvents that can occur. It defines four basic event types:

• OKAY (0) - Resource is operating normally
• WARNING (100) - There may be a problem with the resource
• BUSY (200) - The resource is busy, and cannot respond
• FAILURE (300) - Some type of failure occured

If additional ResourceEvent types are required, this class can be extended to include the required types

Since:

7.2

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUSY Event type used to indicate that the resource is busy.
static int	FAILURE Event type used to indicate a failure in the resource.
static int	OKAY Event type used to indicate resource status is okay.
static int	WARNING Event type used to indicate a warning message from the resource.

Constructor Summary

Constructors

Constructor and Description
ResourceEvent(java.lang.String message, int eventType, Resource resource) A ResourceEvent requires a message indicating the status of the event, the type of event that occured, and the Resource that was the source of the event.

Method Summary

Methods

Modifier and Type	Method and Description
int	getEventType() Returns the eventType sent by the Resource
java.lang.String	getMessage() Returns the message sent by the Resource.
Resource	getResource() Returns the Resource

Methods inherited from class java.lang.Object

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

Field Detail

OKAY

public static final int OKAY

Event type used to indicate resource status is okay.

See Also:

Constant Field Values

WARNING

public static final int WARNING

Event type used to indicate a warning message from the resource.

See Also:

Constant Field Values

BUSY

public static final int BUSY

Event type used to indicate that the resource is busy.

See Also:

Constant Field Values

FAILURE

public static final int FAILURE

Event type used to indicate a failure in the resource.

See Also:

Constant Field Values

Constructor Detail

ResourceEvent

public ResourceEvent(java.lang.String message,
             int eventType,
             Resource resource)

A ResourceEvent requires a message indicating the status of the event, the type of event that occured, and the Resource that was the source of the event.

Parameters:

message - Defines a message received fron the Resource

eventType - the eventType of the ResourceEvent

resource - the Resource that caused this event to happen. Useful for event handling.

Method Detail

getMessage

public java.lang.String getMessage()

Returns the message sent by the Resource.

Returns:

the message sent by the Resource

getEventType

public int getEventType()

Returns the eventType sent by the Resource

Returns:

the eventType sent by the Resource

getResource

public Resource getResource()

Returns the Resource

Returns:

the Resource