com.cisco.services.alarm
Interface AlarmWriter

All Known Implementing Classes:
DefaultAlarmWriter

public interface AlarmWriter

An AlarmWriter receives alarm messages and transmits it to the receiving AlarmService on a TCP link. This interface can be used to implement other AlarmWriters to be used with this implementation of com.cisco.service.alarm A DefaultAlarmWriter is provided with this implementation and can be obtained from the AlarmManager.


Method Summary
 void close()
          close the AlarmWriter
 java.lang.String getDescription()
           
 boolean getEnabled()
           
 java.lang.String getName()
           
 void send(java.lang.String alarmMessage)
          Send out the alarm message to the AlarmService.
 void setEnabled(boolean enable)
          Enable or disable the AlarmWriter
 

Method Detail

send

void send(java.lang.String alarmMessage)
Send out the alarm message to the AlarmService.

Parameters:
alarmMessage - The Alarm to be sent

close

void close()
close the AlarmWriter


getEnabled

boolean getEnabled()
Returns:
the current enabled or diabled state of the AlarmWriter

setEnabled

void setEnabled(boolean enable)
Enable or disable the AlarmWriter

Parameters:
enable - Enable or disable the AlarmWriter

getName

java.lang.String getName()
Returns:
the AlarmWriter name

getDescription

java.lang.String getDescription()
Returns:
the AlarmWriter description