org.csapi.jr.se.fw.fw_service.integrity
Interface SvcHeartBeatMgmt

All Superinterfaces:
CsapiInterface, java.io.Serializable

public interface SvcHeartBeatMgmt
extends CsapiInterface

This interface allows the initialisation of a heartbeat supervision of the service instance by the framework. If the IpSvcHeartBeatMgmt interface is implemented by a Service, as a minimum enableHeartBeat() and disableHeartBeat() shall be implemented.


Method Summary
 void changeInterval(int interval)
          Allows the administrative change of the heartbeat interval.
 void disableSvcHeartBeat()
          Instructs the service instance to cease the sending of its heartbeat.
 void enableSvcHeartBeat(int interval, org.csapi.jr.se.fw.fw_service.integrity.FwHeartBeat fwInterface)
          With this method, the framework instructs the service instance to begin sending its heartbeat to the specified interface at the specified interval.
 

Method Detail

enableSvcHeartBeat

public void enableSvcHeartBeat(int interval,
                               org.csapi.jr.se.fw.fw_service.integrity.FwHeartBeat fwInterface)
                        throws CommonException,
                               InvalidInterfaceTypeException
With this method, the framework instructs the service instance to begin sending its heartbeat to the specified interface at the specified interval.

Parameters:
interval - The time interval in milliseconds between the heartbeats.
fwInterface - This parameter refers to the callback interface the heartbeat is calling.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
InvalidInterfaceTypeException - The interface reference supplied by the client is the wrong type.

disableSvcHeartBeat

public void disableSvcHeartBeat()
                         throws CommonException
Instructs the service instance to cease the sending of its heartbeat.

Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

changeInterval

public void changeInterval(int interval)
                    throws CommonException
Allows the administrative change of the heartbeat interval.

Parameters:
interval - The time interval in milliseconds between the heartbeats.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.