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

All Superinterfaces:
CsapiInterface, java.io.Serializable

public interface SvcLoadManager
extends CsapiInterface

The service developer supplies the load manager service interface to handle requests, reports and other responses from the framework load manager function. The service instance supplies the identity of its callback interface at the time it obtains the framework's load manager interface, by use of the obtainInterfaceWithCallback() method on the IpAccess interface. If the IpSvcLoadManager interface is implemented by a Service, at least one of the methods shall be implemented as a minimum requirement. If load level notifications are supported, then loadLevelNotification() shall be implemented. If a the Service is capable of invoking the IpFwLoadManager.queryLoadStatsReq() method, then it shall implement queryLoadStatsRes() and queryLoadStatsErr() methods in this interface.


Method Summary
 void createLoadLevelNotification()
          The framework uses this method to register to receive notifications of load level changes associated with the service instance.
 void destroyLoadLevelNotification()
          The framework uses this method to unregister for notifications of load level changes associated with the service instance.
 void loadLevelNotification(org.csapi.jr.se.fw.LoadStatistic[] loadStatistics)
          Upon detecting load condition change, (for example load level changing from 0 to 1, 0 to 2, 1 to 0, for the application or framework which has been registered for load level notifications) this method is invoked on the SCF.
 void queryLoadErr(org.csapi.jr.se.fw.LoadStatisticError loadStatisticsError)
          Deprecated.  
 void queryLoadRes(org.csapi.jr.se.fw.LoadStatistic[] loadStatistics)
          Deprecated.  
 void queryLoadStatsErr(int loadStatsReqID, org.csapi.jr.se.fw.LoadStatisticError loadStatisticsError)
          The framework uses this method to return an error response to the service that requested the framework's load statistics information, when the framework is unsuccessful in obtaining any load statistic records; that is in response to an invocation of the queryLoadReq method on the IpFwLoadManager interface.
 void queryLoadStatsRes(int loadStatsReqID, org.csapi.jr.se.fw.LoadStatistic[] loadStatistics)
          The framework uses this method to send load statistic records back to the service instance that requested the information; that is in response to an invocation of the queryLoadReq method on the IpFwLoadManager interface.
 void querySvcLoadReq(org.csapi.jr.se.TimeInterval timeInterval)
          Deprecated.  
 void querySvcLoadStatsReq(int loadStatsReqID, org.csapi.jr.se.TimeInterval timeInterval)
          The framework uses this method to request the service instance to provide its load statistic records.
 void resumeNotification()
          The framework uses this method to request the service instance to resume sending it notifications: for example after a period of suspension during which the framework handled a temporary overload condition.
 void suspendNotification()
          The framework uses this method to request the service instance to suspend sending it any notifications: for example while the framework handles a temporary overload condition.
 

Method Detail

querySvcLoadReq

public void querySvcLoadReq(org.csapi.jr.se.TimeInterval timeInterval)
                     throws CommonException
Deprecated.  

This method is deprecated and will be removed in a later release. It is strongly recommended not to implement this method. The new method querySvcLoadStatsReq shall be used instead, using the new identifier to correlate requests and responses. The framework uses this method to request the service instance to provide its load statistic records.

Parameters:
timeInterval - Specifies the time interval for which load statistic records should be reported.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

queryLoadRes

public void queryLoadRes(org.csapi.jr.se.fw.LoadStatistic[] loadStatistics)
                  throws CommonException
Deprecated.  

This method is deprecated and will be removed in a later release. It is strongly recommended not to implement this method. The new method queryLoadStatsRes shall be used instead, using the new identifier to correlate requests and responses. The framework uses this method to send load statistic records back to the service instance that requested the information; that is in response to an invocation of the queryLoadReq method on the IpFwLoadManager interface.

Parameters:
loadStatistics - Specifies the framework-supplied load statistics
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

queryLoadErr

public void queryLoadErr(org.csapi.jr.se.fw.LoadStatisticError loadStatisticsError)
                  throws CommonException
Deprecated.  

This method is deprecated and will be removed in a later release. It is strongly recommended not to implement this method. The new method queryLoadStatsErr shall be used instead, using the new identifier to correlate requests and errors. The framework uses this method to return an error response to the service that requested the framework's load statistics information, when the framework is unsuccessful in obtaining any load statistic records; that is in response to an invocation of the queryLoadReq method on the IpFwLoadManager interface.

Parameters:
loadStatisticsError - Specifies the error code associated with the failed attempt to retrieve the framework's load statistics.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

loadLevelNotification

public void loadLevelNotification(org.csapi.jr.se.fw.LoadStatistic[] loadStatistics)
                           throws CommonException
Upon detecting load condition change, (for example load level changing from 0 to 1, 0 to 2, 1 to 0, for the application or framework which has been registered for load level notifications) this method is invoked on the SCF. In addition this method shall be invoked on the SCF in order to provide a notification of current load status, when load notifications are first requested, or resumed after suspension.

Parameters:
loadStatistics - Specifies the framework-supplied load statistics, which include the load level change(s).
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

suspendNotification

public void suspendNotification()
                         throws CommonException
The framework uses this method to request the service instance to suspend sending it any notifications: for example while the framework handles a temporary overload condition.

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

resumeNotification

public void resumeNotification()
                        throws CommonException
The framework uses this method to request the service instance to resume sending it notifications: for example after a period of suspension during which the framework handled a temporary overload condition. Upon receipt of this method the service instance shall inform the framework of the current load using the reportLoad method on the corresponding IpFwLoadManager.

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

createLoadLevelNotification

public void createLoadLevelNotification()
                                 throws CommonException
The framework uses this method to register to receive notifications of load level changes associated with the service instance. Upon receipt of this method the service instance shall inform the framework of the current load using the reportLoad method on the corresponding IpFwLoadManager.

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

destroyLoadLevelNotification

public void destroyLoadLevelNotification()
                                  throws CommonException
The framework uses this method to unregister for notifications of load level changes associated with the service instance.

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

querySvcLoadStatsReq

public void querySvcLoadStatsReq(int loadStatsReqID,
                                 org.csapi.jr.se.TimeInterval timeInterval)
                          throws CommonException
The framework uses this method to request the service instance to provide its load statistic records.

Parameters:
loadStatsReqID - The identifier provided by the framework to correlate the response (when it arrives) with this request.
timeInterval - Specifies the time interval for which load statistic records should be reported.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

queryLoadStatsRes

public void queryLoadStatsRes(int loadStatsReqID,
                              org.csapi.jr.se.fw.LoadStatistic[] loadStatistics)
                       throws CommonException
The framework uses this method to send load statistic records back to the service instance that requested the information; that is in response to an invocation of the queryLoadReq method on the IpFwLoadManager interface.

Parameters:
loadStatsReqID - Used by the service instance to correlate this response (when it arrives) with the original request.
loadStatistics - Specifies the framework-supplied load statistics
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

queryLoadStatsErr

public void queryLoadStatsErr(int loadStatsReqID,
                              org.csapi.jr.se.fw.LoadStatisticError loadStatisticsError)
                       throws CommonException
The framework uses this method to return an error response to the service that requested the framework's load statistics information, when the framework is unsuccessful in obtaining any load statistic records; that is in response to an invocation of the queryLoadReq method on the IpFwLoadManager interface.

Parameters:
loadStatsReqID - Used by the service instance to correlate this error (when it arrives) with the original request.
loadStatisticsError - Specifies the error code associated with the failed attempt to retrieve the framework's load statistics.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.