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

All Superinterfaces:
CsapiInterface, java.io.Serializable

public interface FaultManager
extends CsapiInterface

This interface is used by the application to inform the framework of events that affect the integrity of the framework and services, and to request information about the integrity of the system. The fault manager operations do not exchange callback interfaces as it is assumed that the client application supplies 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 IpFaultManager interface is implemented by a Framework, at least one of these methods shall be implemented. If the Framework is capable of invoking the IpAppFaultManager.appActivityTestReq() method, it shall implement appActivityTestRes() and appActivityTestErr() in this interface. If the Framework is capable of invoking IpAppFaultManager.generateFaultStatisticsRecordReq(), it shall implement generateFaultStatisticsRecordRes() and generateFaultStatisticsRecordErr() in this interface.


Method Summary
 void activityTestReq(int activityTestID, java.lang.String svcID)
          The application invokes this method to test that the framework or its instance of a service is operational.
 void appActivityTestErr(int activityTestID)
          The client application uses this method to indicate that an error occurred during a framework-requested activity test.
 void appActivityTestRes(int activityTestID, java.lang.String activityTestResult)
          The client application uses this method to return the result of a framework-requested activity test.
 void appAvailStatusInd(org.csapi.jr.se.fw.AppAvailStatusReason reason)
          This method is used by the application to inform the framework of its availability status.
 void appUnavailableInd(java.lang.String serviceID)
          Deprecated.  
 void generateFaultStatisticsRecordErr(int faultStatsReqID, org.csapi.jr.se.fw.FaultStatisticsError faultStatisticsError)
          This method is used by the client application to indicate an error fulfilling the request to provide fault statistics, in response to a generateFaultStatisticsRecordReq method invocation on the IpAppFaultManager interface.
 void generateFaultStatisticsRecordReq(int faultStatsReqID, org.csapi.jr.se.TimeInterval timePeriod, java.lang.String[] serviceIDs)
          This method is used by the application to solicit fault statistics from the framework.
 void generateFaultStatisticsRecordRes(int faultStatsReqID, org.csapi.jr.se.fw.FaultStatsRecord faultStatistics)
          This method is used by the client application to provide fault statistics to the framework in response to a generateFaultStatisticsRecordReq method invocation on the IpAppFaultManager interface.
 void genFaultStatsRecordErr(org.csapi.jr.se.fw.FaultStatisticsError faultStatisticsError)
          Deprecated.  
 void genFaultStatsRecordReq(org.csapi.jr.se.TimeInterval timePeriod, java.lang.String[] serviceIDs)
          Deprecated.  
 void genFaultStatsRecordRes(org.csapi.jr.se.fw.FaultStatsRecord faultStatistics)
          Deprecated.  
 void svcUnavailableInd(java.lang.String serviceID)
          This method is used by the client application to inform the framework that it can no longer use its instance of the indicated service (either due to a failure in the client application or in the service instance itself).
 

Method Detail

activityTestReq

public void activityTestReq(int activityTestID,
                            java.lang.String svcID)
                     throws CommonException,
                            InvalidServiceIdException,
                            UnauthorisedParameterValueException,
                            PlatformException
The application invokes this method to test that the framework or its instance of a service is operational. On receipt of this request, the framework must carry out a test on itself or on the client's instance of the specified service, to check that it is operating correctly. The framework reports the test result by invoking the activityTestRes method on the IpAppFaultManager interface. If the application does not have access to a service instance with the specified serviceID, the P_UNAUTHORISED_PARAMETER_VALUE exception shall be thrown. The extraInformation field of the exception shall contain the corresponding serviceID. For security reasons the client application has access to the service ID rather than the service instance ID. However, as there is a one to one relationship between the client application and a service, that is there is only one service instance of the specified service per client application, it is the obligation of the framework to determine the service instance ID from the service ID.

Parameters:
activityTestID - The identifier provided by the client application to correlate the response (when it arrives) with this request.
svcID - Identifies either the framework or a service for testing. The framework is designated by an empty string.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
InvalidServiceIdException - Invalid service ID
UnauthorisedParameterValueException - A method parameter value violates the Service Level Agreement.
PlatformException - The implementation detected an internal (for example, communication) error

appActivityTestRes

public void appActivityTestRes(int activityTestID,
                               java.lang.String activityTestResult)
                        throws CommonException,
                               InvalidActivityTestIdException,
                               PlatformException
The client application 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

svcUnavailableInd

public void svcUnavailableInd(java.lang.String serviceID)
                       throws CommonException,
                              InvalidServiceIdException,
                              UnauthorisedParameterValueException,
                              PlatformException
This method is used by the client application to inform the framework that it can no longer use its instance of the indicated service (either due to a failure in the client application or in the service instance itself). On receipt of this request, the framework should take the appropriate corrective action.

Parameters:
serviceID - Identifies the service that the application can no longer use.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
InvalidServiceIdException - Invalid service ID
UnauthorisedParameterValueException - A method parameter value violates the Service Level Agreement.
PlatformException - The implementation detected an internal (for example, communication) error

genFaultStatsRecordReq

public void genFaultStatsRecordReq(org.csapi.jr.se.TimeInterval timePeriod,
                                   java.lang.String[] serviceIDs)
                            throws CommonException,
                                   InvalidServiceIdException,
                                   UnauthorisedParameterValueException,
                                   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 application to solicit fault statistics from the framework. On receipt of this request the framework must produce a fault statistics record, for either the framework or for the client's instances of the specified services during the specified time interval, which is returned to the client application using the genFaultStatsRecordRes operation on the IpAppFaultManager interface. If the application does not have access to a service instance with the specified serviceID, the P_UNAUTHORISED_PARAMETER_VALUE exception shall be thrown. The extraInformation field of the exception shall contain the corresponding serviceID.

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.
serviceIDs - Specifies either the framework or services to be included in the general fault statistics record. If this parameter is not an empty list, the fault statistics records of the client's instances of the specified services are returned, otherwise the fault statistics record of the framework is returned.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
InvalidServiceIdException - Invalid service ID
UnauthorisedParameterValueException - A method parameter value violates the Service Level Agreement.
PlatformException - The implementation detected an internal (for example, communication) error

appActivityTestErr

public void appActivityTestErr(int activityTestID)
                        throws CommonException,
                               InvalidActivityTestIdException,
                               PlatformException
The client application 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

appUnavailableInd

public void appUnavailableInd(java.lang.String serviceID)
                       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. Applications can indicate they no longer use a particular service instance using IpServiceAgreementManagement.terminateServiceAgreement(). Applications can indicate a fault with a particular service instance using IpFaultManager.svcUnavailableInd(). This method is used by the application to inform the framework that it is ceasing its use of the service instance. This may a result of the application detecting a failure. The framework assumes that the session between this client application and service instance is to be closed and updates its own records appropriately as well as attempting to inform the service instance and/or its administrator.

Parameters:
serviceID - Identifies the affected 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

genFaultStatsRecordRes

public void genFaultStatsRecordRes(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 client application to provide fault statistics to the framework in response to a genFaultStatsRecordReq method invocation on the IpAppFaultManager 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

genFaultStatsRecordErr

public void genFaultStatsRecordErr(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 client application to indicate an error fulfilling the request to provide fault statistics, in response to a genFaultStatsRecordReq method invocation on the IpAppFaultManager 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

appAvailStatusInd

public void appAvailStatusInd(org.csapi.jr.se.fw.AppAvailStatusReason reason)
                       throws CommonException,
                              PlatformException
This method is used by the application to inform the framework of its availability status. If the Application has detected a failure it uses one of the APP_UNAVAILABLE reason types to indicate the problem and that it is ceasing its use of all of its subscribed service instances. When the Application is working again it shall call this method again with the APP_AVAILABLE reason to inform the Framework that it is working properly again. The Framework shall also attempt to inform all of the service instances used by the specific application and/or its administrator about the problem.

Parameters:
reason - Identifies the reason why the application is no longer available. APP_AVAILABLE is used to inform the Framework and the Service that the Application is 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,
                                             java.lang.String[] serviceIDs)
                                      throws CommonException,
                                             InvalidServiceIdException,
                                             UnauthorisedParameterValueException,
                                             PlatformException
This method is used by the application to solicit fault statistics from the framework. On receipt of this request the framework must produce a fault statistics record, for either the framework or for the client's instances of the specified services during the specified time interval, which is returned to the client application using the generateFaultStatisticsRecordRes operation on the IpAppFaultManager interface. If the application does not have access to a service instance with the specified serviceID, the P_UNAUTHORISED_PARAMETER_VALUE exception shall be thrown. The extraInformation field of the exception shall contain the corresponding serviceID.

Parameters:
faultStatsReqID - The identifier provided by the application 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.
serviceIDs - Specifies either the framework or services to be included in the general fault statistics record. If this parameter is not an empty list, the fault statistics records of the client's instances of the specified services are returned, otherwise the fault statistics record of the framework is returned.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.
InvalidServiceIdException - Invalid service ID
UnauthorisedParameterValueException - A method parameter value violates the Service Level Agreement.
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 client application to provide fault statistics to the framework in response to a generateFaultStatisticsRecordReq method invocation on the IpAppFaultManager 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 client application to indicate an error fulfilling the request to provide fault statistics, in response to a generateFaultStatisticsRecordReq method invocation on the IpAppFaultManager 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