com.sun.esb.eventmanagement.impl

Class NotificationEventImpl

java.lang.Object

com.sun.esb.eventmanagement.impl.EventImpl

com.sun.esb.eventmanagement.impl.NotificationEventImpl

All Implemented Interfaces:

Event, NotificationEvent, Serializable

public class NotificationEventImpl
extends EventImpl
implements NotificationEvent

This class represents a Notification Event

Author:

bgebbie

See Also:

Serialized Form

Field Summary

Fields inherited from class com.sun.esb.eventmanagement.impl.EventImpl

mComponentName, mComponentProjectPathName, mComponentType, mDeploymentName, mEnvironmentName, mLogicalHostName, mPhysicalHostName, mServerName, mServerType, mTimeStamp

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

EVENT_TYPE_ALERT, EVENT_TYPE_EVENT, EVENT_TYPE_TCA, OBSERVATIONAL_STATE_DELETED, OBSERVATIONAL_STATE_OBSERVED, OBSERVATIONAL_STATE_RESOLVED, OBSERVATIONAL_STATE_UNOBSERVED, OPERATIONAL_STATE_RUNNING, OPERATIONAL_STATE_STARTED, OPERATIONAL_STATE_STARTING, OPERATIONAL_STATE_STOPPED, OPERATIONAL_STATE_STOPPING, OPERATIONAL_STATE_SUSPENDED, OPERATIONAL_STATE_SUSPENDING, OPERATIONAL_STATE_UNKNOWN, SEVERITY_TYPE_CRITICAL, SEVERITY_TYPE_FATAL, SEVERITY_TYPE_INFO, SEVERITY_TYPE_MAJOR, SEVERITY_TYPE_MINOR, SEVERITY_TYPE_WARNING

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

Constructor Summary

Constructors

Constructor and Description
NotificationEventImpl() NotificationEvent Constructor.
NotificationEventImpl(String componentType, String componentProjectPathName, String componentName, long timeStamp)
NotificationEventImpl(String physicalHostName, String environmentName, String logicalHostName, String serverType, String serverName, String componentType, String componentProjectPathName, String componentName, String type, int severity, int operationalState, String messageCode, String[] messageCodeArgs, String messageDetails) NotificationEvent Constructor.

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) Create a query for Notifications
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) Create a query for Notifications
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) Create a query for Notifications
boolean	equals(Object o) Compare two notification event objects.
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 obState) Convert a code into String representation
int	getOperationalState() The getter method for the operational state
String	getOpStateString(int opState) 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.
int	hashCode() Generate a hashcode for the notification event.
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.
String	toString() Generate a string representation of the notification event.

Methods inherited from class com.sun.esb.eventmanagement.impl.EventImpl

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

Constructor Detail

NotificationEventImpl

public NotificationEventImpl()

NotificationEvent Constructor.

NotificationEventImpl

public NotificationEventImpl(String componentType,
                     String componentProjectPathName,
                     String componentName,
                     long timeStamp)

NotificationEventImpl

public NotificationEventImpl(String physicalHostName,
                     String environmentName,
                     String logicalHostName,
                     String serverType,
                     String serverName,
                     String componentType,
                     String componentProjectPathName,
                     String componentName,
                     String type,
                     int severity,
                     int operationalState,
                     String messageCode,
                     String[] messageCodeArgs,
                     String messageDetails)

NotificationEvent Constructor.

Parameters:

physicalHostName - the name of the physical host

environmentName - the name of the environment

logicalHostName - the name of the logical host

serverType - the type of the server (INTEGRATION, MESSAGE)

serverName - the name of the server

componentType - the type of the component (COLLABORATION_COMPONENT)

componentProjectPathName - full path name of the project in which the component is in. Note the names of the project and its sub-projects, if any, are separated by '/'.

componentName - the name of the component . . . . .

Method Detail

getId

public long getId()

The notification event id

Specified by:

getId in interface Event

Specified by:

getId in interface NotificationEvent

Overrides:

getId in class EventImpl

Returns:

the notification event id

setId

public void setId(long id)

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

Specified by:

setId in interface NotificationEvent

Overrides:

setId in class EventImpl

Parameters:

id - the id

getType

public String getType()

The getter method for the notification event type.

Specified by:

getType in interface NotificationEvent

Returns:

the event type: EVENT_TYPE_ALERT EVENT_TYPE_TCA EVENT_TYPE_EVENT

setType

public void setType(String type)

The setter method for the notification event type.

Specified by:

setType in interface NotificationEvent

Parameters:

type - the notification event type: EVENT_TYPE_ALERT EVENT_TYPE_TCA EVENT_TYPE_EVENT

getSeverity

public int getSeverity()

The getter method for the severity.

Specified by:

getSeverity in interface NotificationEvent

Returns:

the severity: SEVERITY_TYPE_FATAL SEVERITY_TYPE_CRITICAL SEVERITY_TYPE_MAJOR SEVERITY_TYPE_MINOR SEVERITY_TYPE_WARNING SEVERITY_TYPE_INFO S

getSeverityString

public String getSeverityString(int severity)

Description copied from interface: NotificationEvent

Convert a code into String representation

Specified by:

getSeverityString in interface NotificationEvent

Parameters:

severity - the code

Returns:

a String representation of the Severity This String is not localized, it is one of the following: "FATAL", "CRITICAL","MAJOR","MINOR","WARNING","INFO"

setSeverity

public void setSeverity(int severity)

The setter method for the severity.

Specified by:

setSeverity in interface NotificationEvent

Parameters:

severity - the severity: SEVERITY_TYPE_FATAL SEVERITY_TYPE_CRITICAL SEVERITY_TYPE_MAJOR SEVERITY_TYPE_MINOR SEVERITY_TYPE_WARNING SEVERITY_TYPE_INFO

getMessageDetails

public String getMessageDetails()

The getter method for the details about a notification event.

Specified by:

getMessageDetails in interface NotificationEvent

Returns:

the details about a notification event

setMessageDetails

public void setMessageDetails(String messageDetails)

The setter method for the details about a notification event.

Specified by:

setMessageDetails in interface NotificationEvent

Parameters:

messageDetails - the details about a notification event

getOperationalState

public int getOperationalState()

The getter method for the operational state

Specified by:

getOperationalState in interface NotificationEvent

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

getOpStateString

public String getOpStateString(int opState)

Description copied from interface: NotificationEvent

Convert a code into String representation

Specified by:

getOpStateString in interface NotificationEvent

Parameters:

opState - the code

Returns:

a String representation of the OperationalState. This String is not localized, it is one of the following: "UNKNOWN", "STARTING", "SUSPENDING", "SUSPENDED", "STOPPING", "STOPPED", "RUNNING"

setOperationalState

public void setOperationalState(int operationalState)

The setter method for the operational state.

Specified by:

setOperationalState in interface NotificationEvent

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

public int getObservationalState()

The getter method to retrieve the observational state.

Specified by:

getObservationalState in interface NotificationEvent

Returns:

the observational state: OBSERVATIONAL_STATE_UNOBSERVED OBSERVATIONAL_STATE_OBSERVED OBSERVATIONAL_STATE_RESOLVED

getObStateString

public String getObStateString(int obState)

Description copied from interface: NotificationEvent

Convert a code into String representation

Specified by:

getObStateString in interface NotificationEvent

Parameters:

obState - the code

Returns:

a String representation of the ObservationalState This String is not localized, it is one of the following: "UNOBSERVED", "OBSERVED", "RESOLVED"

setObservationalState

public void setObservationalState(int observationalState)

Set the observational state.

Specified by:

setObservationalState in interface NotificationEvent

Parameters:

observationalState - the observational state: OBSERVATIONAL_STATE_UNOBSERVED OBSERVATIONAL_STATE_OBSERVED OBSERVATIONAL_STATE_RESOLVED

getListenersNotified

public 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.

Specified by:

getListenersNotified in interface NotificationEvent

Returns:

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

setListenersNotified

public void setListenersNotified(boolean listenersNotified)

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

Specified by:

setListenersNotified in interface NotificationEvent

Parameters:

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

getMessageCode

public 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.

Specified by:

getMessageCode in interface NotificationEvent

Returns:

the message code

setMessageCode

public void setMessageCode(String messageCode)

The setter method for the message code.

Specified by:

setMessageCode in interface NotificationEvent

Parameters:

messageCode - the message code

getMessageCodeArgs

public String[] getMessageCodeArgs()

The getter method for the message code arguments.

Specified by:

getMessageCodeArgs in interface NotificationEvent

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

public void setMessageCodeArgs(String[] messageCodeArgs)

The setter method for the message code arguments.

Specified by:

setMessageCodeArgs in interface NotificationEvent

Parameters:

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

equals

public boolean equals(Object o)

Compare two notification event objects.

Specified by:

equals in interface Event

Overrides:

equals in class EventImpl

Parameters:

o - the other notification event to compare to

Returns:

true if they are equivalent and false if they are not

hashCode

public int hashCode()

Generate a hashcode for the notification event.

Specified by:

hashCode in interface Event

Overrides:

hashCode in class EventImpl

Returns:

the hashcode for the notification event

toString

public String toString()

Generate a string representation of the notification event.

Specified by:

toString in interface Event

Overrides:

toString in class EventImpl

Returns:

the string representation of the notification event

createQuery

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

Create a query for Notifications

Specified by:

createQuery in interface NotificationEvent

Parameters:

notificationType - the type of notification to query for

environmentName - the domainHostName to retrieve notifications for. Pass null if this may be any value.

logicalHostName - the logicalHostName to retrieve nofitications for. Pass null if this may be any value.

serverType - the type of server to retrieve notifications for. Pass null if this may be any value.

serverName - the type of server type to retrieve notifications for. Pass null if this may be any value.

componentType - the componentType to retrieve nofitications for. Pass null if this may be any value.

componentProjectPathName - the full project path name. the full path name of the project in which the component is in. Note the names of the project and its sub-projects, if any, are separated by '/'.

componentName - the componentName to retrieve nofitications for. Pass null if this may be any value.

observationalState - the acknowledged state to retrieve nofitications for. Pass null if this may be any value.

createQuery2

public 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)

Create a query for Notifications

Specified by:

createQuery2 in interface NotificationEvent

Parameters:

notificationType - the type of notification to query for

deploymentName - the deploymentName to retrieve notifications for. Pass null if this may be any value.

environmentName - the environmentName to retrieve notifications for. Pass null if this may be any value.

logicalHostName - the logicalHostName to retrieve nofitications for. Pass null if this may be any value.

serverType - the type of server to retrieve notifications for. Pass null if this may be any value.

serverName - the type of server type to retrieve notifications for. Pass null if this may be any value.

componentType - the componentType to retrieve nofitications for. Pass null if this may be any value.

componentProjectPathName - the full project path name. the full path name of the project in which the component is in. Note the names of the project and its sub-projects, if any, are separated by '/'.

componentName - the componentName to retrieve nofitications for. Pass null if this may be any value.

observationalState - the acknowledged state to retrieve nofitications for. Pass null if this may be any value.

dateFrom - include events starting from this date

dateTo - include events ending with this date

severity - severity - CRITICAL, MAJOR, MINOR, WARN, INFO

operationalState - status - UNKNOWN, STOPPED, RUNNING

messageDetail - the devil is in the details

createQuery2

public 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)

Create a query for Notifications

Specified by:

createQuery2 in interface NotificationEvent

Parameters:

notificationType - the type of notification to query for

environmentName - the domainHostName to retrieve notifications for. Pass null if this may be any value.

logicalHostName - the logicalHostName to retrieve nofitications for. Pass null if this may be any value.

serverType - the type of server to retrieve notifications for. Pass null if this may be any value.

serverName - the type of server type to retrieve notifications for. Pass null if this may be any value.

componentType - the componentType to retrieve nofitications for. Pass null if this may be any value.

componentProjectPathName - the full project path name. the full path name of the project in which the component is in. Note the names of the project and its sub-projects, if any, are separated by '/'.

componentName - the componentName to retrieve nofitications for. Pass null if this may be any value.

observationalState - the acknowledged state to retrieve nofitications for. Pass null if this may be any value.

dateFrom - include events starting from this date

dateTo - include events ending with this date

severity - severity - CRITICAL, MAJOR, MINOR, WARN, INFO

operationalState - status - UNKNOWN, STOPPED, RUNNING

messageDetail - the devil is in the details