|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The Alarm Facility is used by SBBs (and other components as determined by
the SLEE vendor) to generate alarm notifications intended for consumption by
management clients external to the SLEE. For example, a management client
such as a network management console or a management policy engine may
monitor and act upon alarm notifications generated by the SLEE. Management
clients register interest in receiving alarm notifictions using the
SLEE's AlarmMBean
object.
The Alarm Facility is non-transactional. The effects of operations invoked on this facility occur immediately regardless of the state or outcome of any enclosing transaction.
java:comp/env/slee/facilities/alarm
AlarmMBean
,
AlarmNotification
Method Summary | |
void |
createAlarm(ComponentID alarmSource,
Level alarmLevel,
java.lang.String alarmType,
java.lang.String message,
long timeStamp)
Emit an alarm notification containing the specified alarm message. |
void |
createAlarm(ComponentID alarmSource,
Level alarmLevel,
java.lang.String alarmType,
java.lang.String message,
java.lang.Throwable cause,
long timeStamp)
Emit an alarm notification containing the specified alarm message and cause throwable. |
Method Detail |
public void createAlarm(ComponentID alarmSource, Level alarmLevel, java.lang.String alarmType, java.lang.String message, long timeStamp) throws java.lang.NullPointerException, java.lang.IllegalArgumentException, UnrecognizedComponentException, FacilityException
This method is a non-transactional method.
alarmSource
- the identifer of the component that is emitting the alarm.alarmLevel
- the level of the alarm.alarmType
- a string denoting the type of the alarm. Refer to the
SLEE specification for recommended formatting of alarm type strings.message
- the alarm message.timeStamp
- the time (in ms since January 1, 1970 UTC) that the alarm was generated.java.lang.NullPointerException
- if any parameter is null
.java.lang.IllegalArgumentException
- if alarmLevel ==
Level.OFF
.UnrecognizedComponentException
- if alarmSource
is not a recognizable
ComponentID
object for the SLEE or it does not correspond
with a component installed in the SLEE.FacilityException
- if the alarm could not be generated due to a system-level failure.public void createAlarm(ComponentID alarmSource, Level alarmLevel, java.lang.String alarmType, java.lang.String message, java.lang.Throwable cause, long timeStamp) throws java.lang.NullPointerException, java.lang.IllegalArgumentException, UnrecognizedComponentException, FacilityException
This method is a non-transactional method.
alarmSource
- the identifer of the component that is emitting the alarm.alarmLevel
- the level of the alarm.alarmType
- a string denoting the type of the alarm. Refer to the
SLEE specification for recommended formatting of alarm type strings.message
- the alarm message.cause
- the reason (if any) this alarm was generated.timeStamp
- the time (in ms since January 1, 1970 UTC) that the alarm was generated.java.lang.NullPointerException
- if any parameter is null
.java.lang.IllegalArgumentException
- if alarmLevel ==
Level.OFF
.UnrecognizedComponentException
- if alarmSource
is not a recognizable
ComponentID
object for the SLEE or it does not correspond
with a component installed in the SLEE.FacilityException
- if the alarm could not be generated due to a system-level failure.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |