org.csapi.jr.se.fw.fw_application.integrity
Interface AppLoadManager

All Superinterfaces:
CsapiInterface, java.io.Serializable

public interface AppLoadManager
extends CsapiInterface

The client application developer supplies the load manager application interface to handle requests, reports and other responses from the framework load manager function. The application supplies the identity of this callback interface at the time it obtains the framework's load manager interface, by use of the obtainInterfaceWithCallback() method on the IpAccess interface.


Method Summary
 void createLoadLevelNotification()
          The framework uses this method to register to receive notifications of load level changes associated with the application.
 void destroyLoadLevelNotification()
          The framework uses this method to unregister for notifications of load level changes associated with the application.
 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 SCFs or framework which have been registered for load level notifications) this method is invoked on the application.
 void queryAppLoadReq(org.csapi.jr.se.TimeInterval timeInterval)
          Deprecated.  
 void queryAppLoadStatsReq(int loadStatsReqID, org.csapi.jr.se.TimeInterval timeInterval)
          The framework uses this method to request the application to provide load statistics records for the application.
 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 application 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 IpLoadManager 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 application that requested the information; that is in response to an invocation of the queryLoadReq method on the IpLoadManager interface.
 void resumeNotification()
          The framework uses this method to request the application 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 application to suspend sending it any notifications: for example while the framework handles a temporary overload condition.
 

Method Detail

queryAppLoadReq

public void queryAppLoadReq(org.csapi.jr.se.TimeInterval timeInterval)
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 queryAppLoadStatsReq shall be used instead, using the new identifier to correlate requests and responses. The framework uses this method to request the application to provide load statistics records for the application.

Parameters:
timeInterval - Specifies the time interval for which load statistic records should be reported.

queryLoadRes

public void queryLoadRes(org.csapi.jr.se.fw.LoadStatistic[] loadStatistics)
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 application that requested the information; that is in response to an invocation of the queryLoadReq method on the IpLoadManager interface.

Parameters:
loadStatistics - Specifies the framework-supplied load statistics

queryLoadErr

public void queryLoadErr(org.csapi.jr.se.fw.LoadStatisticError loadStatisticsError)
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 application 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 IpLoadManager interface.

Parameters:
loadStatisticsError - Specifies the error code associated with the failed attempt to retrieve the framework's load statistics.

loadLevelNotification

public 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 SCFs or framework which have been registered for load level notifications) this method is invoked on the application. In addition this method shall be invoked on the application 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).

resumeNotification

public void resumeNotification()
The framework uses this method to request the application 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 client application shall inform the framework of the current load using the reportLoad method on the corresponding IpLoadManager.


suspendNotification

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


createLoadLevelNotification

public void createLoadLevelNotification()
The framework uses this method to register to receive notifications of load level changes associated with the application. Upon receipt of this method the client application shall inform the framework of the current load using the reportLoad method on the corresponding IpLoadManager.


destroyLoadLevelNotification

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


queryAppLoadStatsReq

public void queryAppLoadStatsReq(int loadStatsReqID,
                                 org.csapi.jr.se.TimeInterval timeInterval)
The framework uses this method to request the application to provide load statistics records for the application.

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.

queryLoadStatsRes

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

Parameters:
loadStatsReqID - Used by the client application to correlate this response (when it arrives) with the original request.
loadStatistics - Specifies the framework-supplied load statistics.

queryLoadStatsErr

public void queryLoadStatsErr(int loadStatsReqID,
                              org.csapi.jr.se.fw.LoadStatisticError loadStatisticsError)
The framework uses this method to return an error response to the application 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 IpLoadManager interface.

Parameters:
loadStatsReqID - Used by the client application 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.