com.sun.esb.eventmanagement.api

Interface NotificationEvent

All Superinterfaces:

Event

All Known Implementing Classes:

NotificationEventImpl

public interface NotificationEvent
extends Event

This class represents a Notification Event

Author:

bgebbie

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_TYPE_ALERT constant to represent the Alert event type
static String	EVENT_TYPE_EVENT constant to represent the Event event type
static String	EVENT_TYPE_TCA constant to represent the TCA event type
static int	OBSERVATIONAL_STATE_DELETED
static int	OBSERVATIONAL_STATE_OBSERVED
static int	OBSERVATIONAL_STATE_RESOLVED
static int	OBSERVATIONAL_STATE_UNOBSERVED
static int	OPERATIONAL_STATE_RUNNING
static int	OPERATIONAL_STATE_STARTED
static int	OPERATIONAL_STATE_STARTING
static int	OPERATIONAL_STATE_STOPPED
static int	OPERATIONAL_STATE_STOPPING
static int	OPERATIONAL_STATE_SUSPENDED
static int	OPERATIONAL_STATE_SUSPENDING
static int	OPERATIONAL_STATE_UNKNOWN
static int	SEVERITY_TYPE_CRITICAL constant to represent the CRITICAL severity type
static int	SEVERITY_TYPE_FATAL constant to represent the FATAL severity type
static int	SEVERITY_TYPE_INFO constant to represent the INFO severity type
static int	SEVERITY_TYPE_MAJOR constant to represent the MAJOR severity type
static int	SEVERITY_TYPE_MINOR constant to represent the MINOR severity type
static int	SEVERITY_TYPE_WARNING constant to represent the WARNING severity type

Fields inherited from interface com.sun.esb.eventmanagement.api.Event

COMPONENT_TYPE_BPEL, COMPONENT_TYPE_COLLABORATION, COMPONENT_TYPE_EWAY, COMPONENT_TYPE_STCMS, SERVER_TYPE_INTEGRATION, SERVER_TYPE_MESSAGE

Method Summary

Methods

Modifier and Type	Method and Description
String	createQuery(String notificationType, String environmentName, String logicalHostName, String serverType, String serverName, String componentType, String componentProjectPathName, String componentName, Integer observationalState)
String	createQuery2(String notificationType, String environmentName, String logicalHostName, String serverType, String serverName, String componentType, String componentProjectPathName, String componentName, Integer observationalState, String dateFrom, String dateTo, Integer severity, Integer operationalState, String messageDetail)
String	createQuery2(String notificationType, String deploymentName, String environmentName, String logicalHostName, String serverType, String serverName, String componentType, String componentProjectPathName, String componentName, Integer observationalState, String dateFrom, String dateTo, Integer severity, Integer operationalState, String messageDetail)
long	getId() The notification event id
boolean	getListenersNotified() The getter method for whether the listeners interested in the notifications event have been notified.
String	getMessageCode() The getter method for the message code which is a unique integer that is used to identify the root cause of the notification events as specifically as possible.
String[]	getMessageCodeArgs() The getter method for the message code arguments.
String	getMessageDetails() The getter method for the details about a notification event.
int	getObservationalState() The getter method to retrieve the observational state.
String	getObStateString(int observationalState) Convert a code into String representation
int	getOperationalState() The getter method for the operational state
String	getOpStateString(int operationalState) Convert a code into String representation
int	getSeverity() The getter method for the severity.
String	getSeverityString(int severity) Convert a code into String representation
String	getType() The getter method for the notification event type.
void	setId(long id) Set the id.
void	setListenersNotified(boolean listenersNotified) The setter method for whether the listeners interested in the notification events have been notified.
void	setMessageCode(String messageCode) The setter method for the message code.
void	setMessageCodeArgs(String[] messageCodeArgs) The setter method for the message code arguments.
void	setMessageDetails(String messageDetails) The setter method for the details about a notification event.
void	setObservationalState(int observationalState) Set the observational state.
void	setOperationalState(int operationalState) The setter method for the operational state.
void	setSeverity(int severity) The setter method for the severity.
void	setType(String type) The setter method for the notification event type.

Methods inherited from interface com.sun.esb.eventmanagement.api.Event

equals, getComponentName, getComponentProjectPathName, getComponentType, getDeploymentName, getEnvironmentName, getLogicalHostName, getPhysicalHostName, getServerName, getServerType, getTimeStamp, hashCode, setComponentName, setComponentProjectPathName, setComponentType, setDeploymentName, setEnvironmentName, setLogicalHostName, setPhysicalHostName, setServerName, setServerType, setTimeStamp, setTimeStamp, toString

Field Detail

EVENT_TYPE_ALERT

static final String EVENT_TYPE_ALERT

constant to represent the Alert event type

See Also:

Constant Field Values

EVENT_TYPE_TCA

static final String EVENT_TYPE_TCA

constant to represent the TCA event type

See Also:

Constant Field Values

EVENT_TYPE_EVENT

static final String EVENT_TYPE_EVENT

constant to represent the Event event type

See Also:

Constant Field Values

SEVERITY_TYPE_FATAL

static final int SEVERITY_TYPE_FATAL

constant to represent the FATAL severity type

See Also:

Constant Field Values

SEVERITY_TYPE_CRITICAL

static final int SEVERITY_TYPE_CRITICAL

constant to represent the CRITICAL severity type

See Also:

Constant Field Values

SEVERITY_TYPE_MAJOR

static final int SEVERITY_TYPE_MAJOR

constant to represent the MAJOR severity type

See Also:

Constant Field Values

SEVERITY_TYPE_MINOR

static final int SEVERITY_TYPE_MINOR

constant to represent the MINOR severity type

See Also:

Constant Field Values

SEVERITY_TYPE_WARNING

static final int SEVERITY_TYPE_WARNING

constant to represent the WARNING severity type

See Also:

Constant Field Values

SEVERITY_TYPE_INFO

static final int SEVERITY_TYPE_INFO

constant to represent the INFO severity type

See Also:

Constant Field Values

OPERATIONAL_STATE_UNKNOWN

static final int OPERATIONAL_STATE_UNKNOWN

See Also:

Constant Field Values

OPERATIONAL_STATE_STARTING

static final int OPERATIONAL_STATE_STARTING

See Also:

Constant Field Values

OPERATIONAL_STATE_STARTED

static final int OPERATIONAL_STATE_STARTED

See Also:

Constant Field Values

OPERATIONAL_STATE_SUSPENDING

static final int OPERATIONAL_STATE_SUSPENDING

See Also:

Constant Field Values

OPERATIONAL_STATE_SUSPENDED

static final int OPERATIONAL_STATE_SUSPENDED

See Also:

Constant Field Values

OPERATIONAL_STATE_STOPPING

static final int OPERATIONAL_STATE_STOPPING

See Also:

Constant Field Values

OPERATIONAL_STATE_STOPPED

static final int OPERATIONAL_STATE_STOPPED

See Also:

Constant Field Values

OPERATIONAL_STATE_RUNNING

static final int OPERATIONAL_STATE_RUNNING

See Also:

Constant Field Values

OBSERVATIONAL_STATE_UNOBSERVED

static final int OBSERVATIONAL_STATE_UNOBSERVED

See Also:

Constant Field Values

OBSERVATIONAL_STATE_OBSERVED

static final int OBSERVATIONAL_STATE_OBSERVED

See Also:

Constant Field Values

OBSERVATIONAL_STATE_RESOLVED

static final int OBSERVATIONAL_STATE_RESOLVED

See Also:

Constant Field Values

OBSERVATIONAL_STATE_DELETED

static final int OBSERVATIONAL_STATE_DELETED

See Also:

Constant Field Values

Method Detail

getId

long getId()

The notification event id

Specified by:

getId in interface Event

Returns:

the notification event id

setId

void setId(long id)

Set the id. This should never be called explicitly as persistance mechanism will override this value.

Parameters:

id - the id

getType

String getType()

The getter method for the notification event type.

Returns:

the event type: EVENT_TYPE_ALERT EVENT_TYPE_TCA EVENT_TYPE_EVENT

setType

void setType(String type)

The setter method for the notification event type.

Parameters:

type - the notification event type: EVENT_TYPE_ALERT EVENT_TYPE_TCA EVENT_TYPE_EVENT

getSeverity

int getSeverity()

The getter method for the severity.

Returns:

the severity: SEVERITY_TYPE_CRITICAL SEVERITY_TYPE_MAJOR SEVERITY_TYPE_MINOR SEVERITY_TYPE_WARNING SEVERITY_TYPE_INFO

setSeverity

void setSeverity(int severity)

The setter method for the severity.

Parameters:

severity - the severity: SEVERITY_TYPE_CRITICAL SEVERITY_TYPE_MAJOR SEVERITY_TYPE_MINOR SEVERITY_TYPE_WARNING SEVERITY_TYPE_INFO

getMessageDetails

String getMessageDetails()

The getter method for the details about a notification event.

Returns:

the details about a notification event

setMessageDetails

void setMessageDetails(String messageDetails)

The setter method for the details about a notification event.

Parameters:

messageDetails - the details about a notification event

getOperationalState

int getOperationalState()

The getter method for the operational state

Returns:

the operational state: OPERATIONAL_STATE_UNKNOWN OPERATIONAL_STATE_STARTING OPERATIONAL_STATE_SUSPENDING OPERATIONAL_STATE_SUSPENDED OPERATIONAL_STATE_STOPPING OPERATIONAL_STATE_STOPPED OPERATIONAL_STATE_RUNNING

setOperationalState

void setOperationalState(int operationalState)

The setter method for the operational state.

Parameters:

operationalState - the operational state: OPERATIONAL_STATE_UNKNOWN OPERATIONAL_STATE_STARTING OPERATIONAL_STATE_SUSPENDING OPERATIONAL_STATE_SUSPENDED OPERATIONAL_STATE_STOPPING OPERATIONAL_STATE_STOPPED OPERATIONAL_STATE_RUNNING

getObservationalState

int getObservationalState()

The getter method to retrieve the observational state.

Returns:

the observational state: OBSERVATIONAL_STATE_UNOBSERVED OBSERVATIONAL_STATE_OBSERVED OBSERVATIONAL_STATE_RESOLVED

setObservationalState

void setObservationalState(int observationalState)

Set the observational state.

Parameters:

observationalState - the observational state: OBSERVATIONAL_STATE_UNOBSERVED OBSERVATIONAL_STATE_OBSERVED OBSERVATIONAL_STATE_RESOLVED

getListenersNotified

boolean getListenersNotified()

The getter method for whether the listeners interested in the notifications event have been notified. Since a schemaorg_apache_xmlbeans.system failure may occur during this process, all of the notification events will need to be resent when the schemaorg_apache_xmlbeans.system is started up again. This field keeps track of this. Possible values are: TRUE - All the listeners have been notified FALSE - All the listeners may have not been notified Note that it is possible a listener may be called more then once whenever all the listeners could not be notified in an attempt.

Returns:

true if all the listeners have been notified and false if they may have not been notified

setListenersNotified

void setListenersNotified(boolean listenersNotified)

The setter method for whether the listeners interested in the notification events have been notified.

Parameters:

listenersNotified - true if all the listeners have been notified and false if they may have not been notified

getMessageCode

String getMessageCode()

The getter method for the message code which is a unique integer that is used to identify the root cause of the notification events as specifically as possible. It can be used by customer support to easily look up common problems and solutions in a knowledge base. It also helps track the cause of issues and helps duplicate issues to be found. This code will also be used to look up an i18n String from a resource bundle which will have any message code arguments applied to it.

Returns:

the message code

setMessageCode

void setMessageCode(String messageCode)

The setter method for the message code.

Parameters:

messageCode - the message code

getSeverityString

String getSeverityString(int severity)

Convert a code into String representation

Parameters:

severity - the code

Returns:

String representation

getOpStateString

String getOpStateString(int operationalState)

Convert a code into String representation

Parameters:

operationalState - the code

Returns:

String representation

getObStateString

String getObStateString(int observationalState)

Convert a code into String representation

Parameters:

observationalState - the code

Returns:

String representation

getMessageCodeArgs

String[] getMessageCodeArgs()

The getter method for the message code arguments.

Returns:

an array of Strings that represent the arguments to the message template specified by the message code. These strings will not be internationalized.

setMessageCodeArgs

void setMessageCodeArgs(String[] messageCodeArgs)

The setter method for the message code arguments.

Parameters:

messageCodeArgs - the arguments to the message template specified by the message code. These strings will not be internationalized.

createQuery

String createQuery(String notificationType,
                 String environmentName,
                 String logicalHostName,
                 String serverType,
                 String serverName,
                 String componentType,
                 String componentProjectPathName,
                 String componentName,
                 Integer observationalState)

createQuery2

String createQuery2(String notificationType,
                  String environmentName,
                  String logicalHostName,
                  String serverType,
                  String serverName,
                  String componentType,
                  String componentProjectPathName,
                  String componentName,
                  Integer observationalState,
                  String dateFrom,
                  String dateTo,
                  Integer severity,
                  Integer operationalState,
                  String messageDetail)

createQuery2

String createQuery2(String notificationType,
                  String deploymentName,
                  String environmentName,
                  String logicalHostName,
                  String serverType,
                  String serverName,
                  String componentType,
                  String componentProjectPathName,
                  String componentName,
                  Integer observationalState,
                  String dateFrom,
                  String dateTo,
                  Integer severity,
                  Integer operationalState,
                  String messageDetail)