com.ibm.xdms.function
Interface AlarmAndFaultLogger
- All Superinterfaces:
- Function
public interface AlarmAndFaultLogger
- extends Function
The AlarmAndFaultLogger class handles the handoff of runtime generated
alarms and faults to the SOA Faults and Alarm web service.
Field Summary |
static java.lang.String |
COPYRIGHT
|
Method Summary |
void |
recordAlarm(java.lang.String msgCode,
com.ibm.soa.sp.fltalm.AlarmEnumeration type,
java.lang.String message,
java.lang.String detail,
java.lang.String suggestedAction)
Log an Alarm
As defined by the XDMS SDD an Alarm should be any
operational error that occurs and impede system operation
for future requests unless the administrator resolves
the issue immediately. |
void |
recordFault(java.lang.String msgCode,
com.ibm.soa.sp.fltalm.SeverityEnumeration severity,
java.lang.String message,
java.lang.String detail)
Log a Fault
Faults are logged for operational errors that occur but they do not
affect the long term operation of the system |
COPYRIGHT
static final java.lang.String COPYRIGHT
recordAlarm
void recordAlarm(java.lang.String msgCode,
com.ibm.soa.sp.fltalm.AlarmEnumeration type,
java.lang.String message,
java.lang.String detail,
java.lang.String suggestedAction)
- Log an Alarm
As defined by the XDMS SDD an Alarm should be any
operational error that occurs and impede system operation
for future requests unless the administrator resolves
the issue immediately.
- Parameters:
msgCode
- Specifies the alarm code (ie GLSXXXXXX)type
- Specifies the alarm severity (ie AlarmEnumeration.Medium)message
- Specifies the text of the alarm messagedetail
- Specifies the detail information to be included in the alarm.suggestedAction
- Specifies the suggested action information to be included in the alarm.
recordFault
void recordFault(java.lang.String msgCode,
com.ibm.soa.sp.fltalm.SeverityEnumeration severity,
java.lang.String message,
java.lang.String detail)
- Log a Fault
Faults are logged for operational errors that occur but they do not
affect the long term operation of the system
- Parameters:
msgCode
- Specifies the fault code (ie GLSXXXXXX)severity
- Specifies the fault severity (ie AlarmEnumeration.Medium)message
- Specifies the text of the fault messagedetail
- Specifies the detail information to be included in the fault.