Openwings API Documentation (v1.1)

net.openwings.availability
Interface AvailabilityMBean

All Superinterfaces:
MBean

public interface AvailabilityMBean
extends MBean

This class is the availability Management Bean interface. This interface allows external users to access availability information for the component.


Method Summary
 void addHeartbeatListener(HeartbeatListener listener, float intervalInSeconds)
          This method is used to add a listener that receives periodic heartbeat events.
 void addPerformanceReportListener(PerformanceReportListener listener, float intervalInSeconds)
          This method is used to add a listener that receives periodic performance updates.
 void addUnitReportListener(UnitReportListener listener)
          This method is used to add a listener that receives unit fault reports.
 void removeHeartbeatListener(HeartbeatListener listener)
          This method is used to remove a listener that receives periodic heartbeat events.
 void removePerformanceReportListener(PerformanceReportListener listener)
          This method is used to remove a listener that receives periodic performance updates.
 void removeUnitReportListener(UnitReportListener listener)
          This method is used to remove a listener that receives unit fault reports.
 
Methods inherited from interface net.openwings.management.MBean
getMBeanInfo
 

Method Detail

addPerformanceReportListener

public void addPerformanceReportListener(PerformanceReportListener listener,
                                         float intervalInSeconds)
                                  throws java.rmi.RemoteException
This method is used to add a listener that receives periodic performance updates.

Parameters:
listener - callback for performance reports.
intervalInSeconds - interval between performance reports
Throws:
java.rmi.RemoteException - in the case of a network error.

removePerformanceReportListener

public void removePerformanceReportListener(PerformanceReportListener listener)
                                     throws java.rmi.RemoteException
This method is used to remove a listener that receives periodic performance updates.

Parameters:
listener - callback for performance reports.
Throws:
java.rmi.RemoteException - in the case of a network error.

addUnitReportListener

public void addUnitReportListener(UnitReportListener listener)
                           throws java.rmi.RemoteException
This method is used to add a listener that receives unit fault reports. A unit report indicates online, offline, and degraded status for a component or capability provided by a component. These reports are generated when faults occur, not at periodic intervals.

Parameters:
listener - callback for unit reports.
Throws:
java.rmi.RemoteException - in the case of a network error.

removeUnitReportListener

public void removeUnitReportListener(UnitReportListener listener)
                              throws java.rmi.RemoteException
This method is used to remove a listener that receives unit fault reports.

Parameters:
listener - callback for unit reports.
Throws:
java.rmi.RemoteException - in the case of a network error.

addHeartbeatListener

public void addHeartbeatListener(HeartbeatListener listener,
                                 float intervalInSeconds)
                          throws java.rmi.RemoteException
This method is used to add a listener that receives periodic heartbeat events. Heartbeats are events that are used to monitor critical components on a frequent basis. A missed heartbeat indicates an exception condition.

Parameters:
listener - callback for heartbeats.
intervalInSeconds - interval between heartbeats.
Throws:
java.rmi.RemoteException - in the case of a network error.

removeHeartbeatListener

public void removeHeartbeatListener(HeartbeatListener listener)
                             throws java.rmi.RemoteException
This method is used to remove a listener that receives periodic heartbeat events.

Parameters:
listener - callback for heartbeats.
Throws:
java.rmi.RemoteException - in the case of a network error.

Openwings API Documentation (v1.1)