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

All Superinterfaces:
CsapiInterface, java.io.Serializable

public interface FwFaultManager
extends CsapiInterface

This interface is used by the service instance to inform the framework of events which affect the integrity of the API, and request fault management status information from the framework. The fault manager operations do not exchange callback interfaces as it is assumed that the service instance has supplied its Fault Management callback interface at the time it obtains the Framework's Fault Management interface, by use of the obtainInterfaceWithCallback operation on the IpAccess interface. If the IpFwFaultManager interface is implemented by a Framework, at least one of these methods shall be implemented. If the Framework is capable of invoking the IpSvcFaultManager.svcActivityTestReq() method, it shall implement svcActivityTestRes() and svcActivityTestErr() in this interface. If the Framework is capable of invoking IpSvcFaultManager.generateFaultStatisticsRecordReq(), it shall implement generateFaultStatisticsRecordRes() and generateFaultStatisticsRecordErr() in this interface. If the Framework is capable of invoking IpSvcFaultManager.generateFaultStatisticsRecordReq(), it shall implement generateFaultStatisticsRecordRes() and generateFaultStatisticsRecordErr() in this interface.


Method Summary
 void activityTestReq(int activityTestID, org.csapi.jr.se.fw.SubjectType testSubject)
          The service instance invokes this method to test that the framework or the client application is operational.
 void appUnavailableInd()
          This method is used by the service instance to inform the framework that the client application is not responding.
 void generateFaultStatisticsRecordErr(int faultStatsReqID, org.csapi.jr.se.fw.FaultStatisticsError faultStatisticsError)
          This method is used by the service to indicate an error fulfilling the request to provide fault statistics, in response to a generateFaultStatisticsRecordReq method invocation on the IpSvcFaultManager interface.
 void generateFaultStatisticsRecordReq(int faultStatsReqID, org.csapi.jr.se.TimeInterval timePeriod, org.csapi.jr.se.fw.SubjectType recordSubject)
          This method is used by the service instance to solicit fault statistics from the framework.
 void generateFaultStatisticsRecordRes(int faultStatsReqID, org.csapi.jr.se.fw.FaultStatsRecord faultStatistics)
          This method is used by the service to provide fault statistics to the framework in response to a generateFaultStatisticsRecordReq method invocation on the IpSvcFaultManager interface.
 void generateFaultStatsRecordErr(org.csapi.jr.se.fw.FaultStatisticsError faultStatisticsError)
          Deprecated.  
 void generateFaultStatsRecordRes(org.csapi.jr.se.fw.FaultStatsRecord faultStatistics)
          Deprecated.  
 void genFaultStatsRecordErr(org.csapi.jr.se.fw.FaultStatisticsError faultStatisticsError, java.lang.String[] serviceIDs)
          Deprecated.  
 void genFaultStatsRecordReq(org.csapi.jr.se.TimeInterval timePeriod, org.csapi.jr.se.fw.SubjectType recordSubject)
          Deprecated.  
 void genFaultStatsRecordRes(org.csapi.jr.se.fw.FaultStatsRecord faultStatistics, java.lang.String[] serviceIDs)
          Deprecated.  
 void svcActivityTestErr(int activityTestID)
          The service instance uses this method to indicate that an error occurred during a framework-requested activity test.
 void svcActivityTestRes(int activityTestID, java.lang.String activityTestResult)
          The service instance uses this method to return the result of a framework-requested activity test.
 void svcAvailStatusInd(org.csapi.jr.se.fw.SvcAvailStatusReason reason)
          This method is used by the service instance to inform the framework that it is about to become unavailable for use according to the provided reason and as well to inform the Framework when the Service instance becomes available again.
 void svcUnavailableInd(org.csapi.jr.se.fw.SvcUnavailReason reason)
          Deprecated.  
 

Method Detail

activityTestReq

public void activityTestReq(int activityTestID,
                            org.csapi.jr.se.fw.SubjectType testSubject)
                     throws CommonException,
                            PlatformException
The service instance invokes this method to test that the framework or the client application is operational. On receipt of this request, the framework must carry out a test on itself or on the application, to check that it is operating correctly. The framework reports the test result by invoking the activityTestRes method on the IpSvcFaultManager interface.

Parameters:
activityTestID - The identifier provided by the service instance to correlate the response (when it arrives) with this request.
testSubject - Identifies the subject for testing (framework or client application).
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
PlatformException - The implementation detected an internal (for example, communication) error

svcActivityTestRes

public void svcActivityTestRes(int activityTestID,
                               java.lang.String activityTestResult)
                        throws CommonException,
                               InvalidActivityTestIdException,
                               PlatformException
The service instance uses this method to return the result of a framework-requested activity test.

Parameters:
activityTestID - Used by the framework to correlate this response (when it arrives) with the original request.
activityTestResult - The result of the activity test.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
InvalidActivityTestIdException - ID does not correspond to a valid activity test request
PlatformException - The implementation detected an internal (for example, communication) error

appUnavailableInd

public void appUnavailableInd()
                       throws CommonException,
                              PlatformException
This method is used by the service instance to inform the framework that the client application is not responding. On receipt of this indication, the framework must act to inform the client application.

Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
PlatformException - The implementation detected an internal (for example, communication) error

genFaultStatsRecordReq

public void genFaultStatsRecordReq(org.csapi.jr.se.TimeInterval timePeriod,
                                   org.csapi.jr.se.fw.SubjectType recordSubject)
                            throws CommonException,
                                   PlatformException
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 generateFaultStatisticsRecordReq shall be used instead, using the new identifier to correlate requests and responses. This method is used by the service instance to solicit fault statistics from the framework. On receipt of this request, the framework must produce a fault statistics record, for the framework or for the application during the specified time interval, which is returned to the service instance using the genFaultStatsRecordRes operation on the IpSvcFaultManager interface.

Parameters:
timePeriod - The period over which the fault statistics are to be generated. Supplying both a start time and stop time as empty strings leaves the time period to the discretion of the framework.
recordSubject - Specifies the subject to be included in the general fault statistics record (framework or application).
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
PlatformException - The implementation detected an internal (for example, communication) error

svcUnavailableInd

public void svcUnavailableInd(org.csapi.jr.se.fw.SvcUnavailReason reason)
                       throws CommonException,
                              PlatformException
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 svcAvailStatusInd() shall be used instead, using the new and updated reason parameter to inform the Framework the reason why the Service has become unavailable and also when the Service instance becomes available again. This method is used by the service instance to inform the framework that it is about to become unavailable for use. The framework should inform the client application that is currently using this service instance that it is unavailable for use (via the svcUnavailableInd method on the IpAppFaultManager interface).

Parameters:
reason - Identifies the reason for the service instance's unavailability.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
PlatformException - The implementation detected an internal (for example, communication) error

svcActivityTestErr

public void svcActivityTestErr(int activityTestID)
                        throws CommonException,
                               InvalidActivityTestIdException,
                               PlatformException
The service instance uses this method to indicate that an error occurred during a framework-requested activity test.

Parameters:
activityTestID - Used by the framework to correlate this response (when it arrives) with the original request.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
InvalidActivityTestIdException - ID does not correspond to a valid activity test request
PlatformException - The implementation detected an internal (for example, communication) error

genFaultStatsRecordRes

public void genFaultStatsRecordRes(org.csapi.jr.se.fw.FaultStatsRecord faultStatistics,
                                   java.lang.String[] serviceIDs)
                            throws CommonException,
                                   PlatformException
Deprecated.  

This method is deprecated and will be removed in a later release. It cannot be used as described, since the serviceIDs parameter has no meaning. It is replaced with generateFaultStatsRecordRes(). This method is used by the service to provide fault statistics to the framework in response to a genFaultStatsRecordReq method invocation on the IpSvcFaultManager interface.

Parameters:
faultStatistics - The fault statistics record.
serviceIDs - Specifies the services that are included in the general fault statistics record. The serviceIDs parameter is not allowed to be an empty list.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
PlatformException - The implementation detected an internal (for example, communication) error

genFaultStatsRecordErr

public void genFaultStatsRecordErr(org.csapi.jr.se.fw.FaultStatisticsError faultStatisticsError,
                                   java.lang.String[] serviceIDs)
                            throws CommonException,
                                   PlatformException
Deprecated.  

This method is deprecated and will be removed in a later release. It cannot be used as described, since the serviceIDs parameter has no meaning. It is replaced with generateFaultStatsRecordErr(). This method is used by the service to indicate an error fulfilling the request to provide fault statistics, in response to a genFaultStatsRecordReq method invocation on the IpSvcFaultManager interface.

Parameters:
faultStatisticsError - The fault statistics error.
serviceIDs - Specifies the services that were included in the general fault statistics record request. The serviceIDs parameter is not allowed to be an empty list.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
PlatformException - The implementation detected an internal (for example, communication) error

generateFaultStatsRecordRes

public void generateFaultStatsRecordRes(org.csapi.jr.se.fw.FaultStatsRecord faultStatistics)
                                 throws CommonException,
                                        PlatformException
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 generateFaultStatisticsRecordRes shall be used instead, using the new identifier to correlate requests and responses. This method is used by the service to provide fault statistics to the framework in response to a genFaultStatsRecordReq method invocation on the IpSvcFaultManager interface.

Parameters:
faultStatistics - The fault statistics record.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
PlatformException - The implementation detected an internal (for example, communication) error

generateFaultStatsRecordErr

public void generateFaultStatsRecordErr(org.csapi.jr.se.fw.FaultStatisticsError faultStatisticsError)
                                 throws CommonException,
                                        PlatformException
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 generateFaultStatisticsRecordErr shall be used instead, using the new identifier to correlate requests and errors. This method is used by the service to indicate an error fulfilling the request to provide fault statistics, in response to a genFaultStatsRecordReq method invocation on the IpSvcFaultManager interface.

Parameters:
faultStatisticsError - The fault statistics error.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
PlatformException - The implementation detected an internal (for example, communication) error

svcAvailStatusInd

public void svcAvailStatusInd(org.csapi.jr.se.fw.SvcAvailStatusReason reason)
                       throws CommonException,
                              PlatformException
This method is used by the service instance to inform the framework that it is about to become unavailable for use according to the provided reason and as well to inform the Framework when the Service instance becomes available again. The framework should inform the client applications that are currently using this service instance that it is unavailable and as well when it becomes available again for use (via the svcAvailStatusInd method on the IpAppFaultManager interface).

Parameters:
reason - Identifies the reason for the service instance's unavailability and also the reason SERVICE_AVAILABLE to be used to inform the Framework when the Service instance becomes available again.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
PlatformException - The implementation detected an internal (for example, communication) error

generateFaultStatisticsRecordReq

public void generateFaultStatisticsRecordReq(int faultStatsReqID,
                                             org.csapi.jr.se.TimeInterval timePeriod,
                                             org.csapi.jr.se.fw.SubjectType recordSubject)
                                      throws CommonException,
                                             PlatformException
This method is used by the service instance to solicit fault statistics from the framework. On receipt of this request, the framework must produce a fault statistics record, for the framework or for the application during the specified time interval, which is returned to the service instance using the generateFaultStatisticsRecordRes operation on the IpSvcFaultManager interface.

Parameters:
faultStatsReqID - The identifier provided by the service instance to correlate the response (when it arrives) with this request.
timePeriod - The period over which the fault statistics are to be generated. Supplying both a start time and stop time as empty strings leaves the time period to the discretion of the framework.
recordSubject - Specifies the subject to be included in the general fault statistics record (framework or application).
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
PlatformException - The implementation detected an internal (for example, communication) error

generateFaultStatisticsRecordRes

public void generateFaultStatisticsRecordRes(int faultStatsReqID,
                                             org.csapi.jr.se.fw.FaultStatsRecord faultStatistics)
                                      throws CommonException,
                                             PlatformException
This method is used by the service to provide fault statistics to the framework in response to a generateFaultStatisticsRecordReq method invocation on the IpSvcFaultManager interface.

Parameters:
faultStatsReqID - Used by the framework to correlate this response (when it arrives) with the original request.
faultStatistics - The fault statistics record.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
PlatformException - The implementation detected an internal (for example, communication) error

generateFaultStatisticsRecordErr

public void generateFaultStatisticsRecordErr(int faultStatsReqID,
                                             org.csapi.jr.se.fw.FaultStatisticsError faultStatisticsError)
                                      throws CommonException,
                                             PlatformException
This method is used by the service to indicate an error fulfilling the request to provide fault statistics, in response to a generateFaultStatisticsRecordReq method invocation on the IpSvcFaultManager interface.

Parameters:
faultStatsReqID - Used by the framework to correlate this error (when it arrives) with the original request.
faultStatisticsError - The fault statistics error.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
PlatformException - The implementation detected an internal (for example, communication) error