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

All Superinterfaces:
CsapiInterface, java.io.Serializable

public interface SvcFaultManager
extends CsapiInterface

This interface is used to inform the service instance of events that affect the integrity of the Framework, Service or Client Application. The Framework will invoke methods on the Fault Management Service Interface that is specified when the service instance obtains the Fault Management Framework interface: that is by use of the obtainInterfaceWithCallback operation on the IpAccess interface. If the IpSvcFaultManager interface is implemented by a Service, at least one of these methods shall be implemented. If the Service is capable of invoking the IpFwFaultManager.activityTestReq() method, it shall implement activityTestRes() and activityTestErr() in this interface. If the Service is capable of invoking IpFwFaultManager.generateFaultStatisticsRecordReq(), it shall implement generateFaultStatisticsRecordRes() and generateFaultStatisticsRecordErr() in this interface.


Method Summary
 void activityTestErr(int activityTestID)
          The framework uses this method to indicate that an error occurred during a service-requested activity test.
 void activityTestRes(int activityTestID, java.lang.String activityTestResult)
          The framework uses this method to return the result of a service-requested activity test.
 void appAvailStatusInd(org.csapi.jr.se.fw.AppAvailStatusReason reason)
          The framework invokes this method to inform the service instance that the client application is no longer available using different reasons for the unavailability.
 void appUnavailableInd()
          Deprecated.  
 void fwAvailStatusInd(org.csapi.jr.se.fw.FwAvailStatusReason reason)
          The framework invokes this method to inform the service instance about the Framework availability status, that is that it can no longer use the Framework according to the reason parameter or that the Framework has become available again.
 void fwFaultRecoveryInd(org.csapi.jr.se.fw.InterfaceFault fault)
          Deprecated.  
 void fwFaultReportInd(org.csapi.jr.se.fw.InterfaceFault fault)
          Deprecated.  
 void fwUnavailableInd(org.csapi.jr.se.fw.FwUnavailReason reason)
          Deprecated.  
 void generateFaultStatisticsRecordErr(int faultStatsReqID, org.csapi.jr.se.fw.FaultStatisticsError faultStatisticsError, org.csapi.jr.se.fw.SubjectType recordSubject)
          This method is used by the framework to indicate an error fulfilling the request to provide fault statistics, in response to a generateFaultStatisticsRecordReq method invocation on the IpFwFaultManager interface.
 void generateFaultStatisticsRecordReq(int faultStatsReqID, org.csapi.jr.se.TimeInterval timePeriod)
          This method is used by the framework to solicit fault statistics from the service instance, for example when the framework was asked for these statistics by the client application using the generateFaultStatisticsRecordReq operation on the IpFaultManager interface.
 void generateFaultStatisticsRecordRes(int faultStatsReqID, org.csapi.jr.se.fw.FaultStatsRecord faultStatistics, org.csapi.jr.se.fw.SubjectType recordSubject)
          This method is used by the framework to provide fault statistics to a service instance in response to a generateFaultStatisticsRecordReq method invocation on the IpFwFaultManager interface.
 void generateFaultStatsRecordReq(org.csapi.jr.se.TimeInterval timePeriod)
          Deprecated.  
 void genFaultStatsRecordErr(org.csapi.jr.se.fw.FaultStatisticsError faultStatisticsError, org.csapi.jr.se.fw.SubjectType recordSubject)
          Deprecated.  
 void genFaultStatsRecordReq(org.csapi.jr.se.TimeInterval timePeriod, java.lang.String[] serviceIDs)
          Deprecated.  
 void genFaultStatsRecordRes(org.csapi.jr.se.fw.FaultStatsRecord faultStatistics, org.csapi.jr.se.fw.SubjectType recordSubject)
          Deprecated.  
 void svcActivityTestReq(int activityTestID)
          The framework invokes this method to test that the service instance is operational.
 void svcUnavailableInd()
          The framework invokes this method to inform the service instance that the client application has reported that it can no longer use the service instance.
 

Method Detail

activityTestRes

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

Parameters:
activityTestID - Used by the service 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

svcActivityTestReq

public void svcActivityTestReq(int activityTestID)
                        throws CommonException
The framework invokes this method to test that the service instance is operational. On receipt of this request, the service instance must carry out a test on itself, to check that it is operating correctly. The service instance reports the test result by invoking the svcActivityTestRes method on the IpFwFaultManager interface.

Parameters:
activityTestID - The identifier provided by the framework to correlate the response (when it arrives) with this request.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

fwFaultReportInd

public void fwFaultReportInd(org.csapi.jr.se.fw.InterfaceFault fault)
                      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 fwAvailStatusInd shall be used instead, using the new type of reason parameter to inform the Service the reason why the Framework is unavailable. The framework invokes this method to notify the service instance of a failure within the framework. The service instance must not continue to use the framework until it has recovered (as indicated by a fwFaultRecoveryInd).

Parameters:
fault - Specifies the fault that has been detected by the framework.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

fwFaultRecoveryInd

public void fwFaultRecoveryInd(org.csapi.jr.se.fw.InterfaceFault fault)
                        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 fwAvailStatusInd shall be used instead, using the new type of reason parameter to inform the Service when the Framework becomes available again. The framework invokes this method to notify the service instance that a previously reported fault has been rectified. The service instance may then resume using the framework.

Parameters:
fault - Specifies the fault from which the framework has recovered.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

fwUnavailableInd

public void fwUnavailableInd(org.csapi.jr.se.fw.FwUnavailReason reason)
                      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 fwAvailStatusInd shall be used instead, using the new type of reason parameter to inform the Application the reason why the Framework is unavailable and also when the Framework becomes available again. The framework invokes this method to inform the service instance that it is no longer available.

Parameters:
reason - Identifies the reason why the framework is no longer available
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

svcUnavailableInd

public void svcUnavailableInd()
                       throws CommonException
The framework invokes this method to inform the service instance that the client application has reported that it can no longer use the service instance.

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

appUnavailableInd

public void appUnavailableInd()
                       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 appAvailStatusInd shall be used instead, using the new reason parameter to inform the Service the reason why the Application is unavailable and also when the application becomes available again. The framework invokes this method to inform the service instance that the framework may have detected that the application has failed: for example non-response from an activity test, failure to return heartbeats.

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

genFaultStatsRecordRes

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

Parameters:
faultStatistics - The fault statistics record.
recordSubject - Specifies the entity (framework or application) whose fault statistics record has been provided.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

activityTestErr

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

Parameters:
activityTestID - Used by the service instance 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

genFaultStatsRecordErr

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

Parameters:
faultStatisticsError - The fault statistics error.
recordSubject - Specifies the entity (framework or application) whose fault statistics record was requested.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

genFaultStatsRecordReq

public void genFaultStatsRecordReq(org.csapi.jr.se.TimeInterval timePeriod,
                                   java.lang.String[] serviceIDs)
                            throws CommonException,
                                   InvalidServiceIdException,
                                   UnauthorisedParameterValueException
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 generateFaultStatsRecordReq(). This method is used by the framework to solicit fault statistics from the service, for example when the framework was asked for these statistics by the client application using the genFaultStatsRecordReq operation on the IpFaultManager interface. On receipt of this request the service 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 framework using the genFaultStatsRecordRes operation on the IpFwFaultManager interface. If the framework 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 service.
serviceIDs - Specifies the services to be included in the general fault statistics record. This parameter is not allowed to be an empty list.
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.

generateFaultStatsRecordReq

public void generateFaultStatsRecordReq(org.csapi.jr.se.TimeInterval timePeriod)
                                 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 generateFaultStatisticsRecordReq shall be used instead, using the new identifier to correlate requests and responses. This method is used by the framework to solicit fault statistics from the service instance, for example when the framework was asked for these statistics by the client application using the genFaultStatsRecordReq operation on the IpFaultManager interface. On receipt of this request the service instance must produce a fault statistics record during the specified time interval, which is returned to the framework using the genFaultStatsRecordRes operation on the IpFwFaultManager 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 service.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

appAvailStatusInd

public void appAvailStatusInd(org.csapi.jr.se.fw.AppAvailStatusReason reason)
                       throws CommonException
The framework invokes this method to inform the service instance that the client application is no longer available using different reasons for the unavailability. This may be a result of the application reporting a failure. Alternatively, the framework may have detected that the application has failed: for example non-response from an activity test, failure to return heartbeats, using the reason APP_UNAVAILABLE_NO_RESPONSE. When the application becomes available again the reason APP_AVAILABLE shall be used to inform the Service about that.

Parameters:
reason - Identifies the reason why the application is no longer available. APP_AVAILABLE is used to inform the Service that the Application is available again.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

generateFaultStatisticsRecordRes

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

Parameters:
faultStatsReqID - Used by the service instance to correlate this response (when it arrives) with the original request.
faultStatistics - The fault statistics record.
recordSubject - Specifies the entity (framework or application) whose fault statistics record has been provided.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

generateFaultStatisticsRecordErr

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

Parameters:
faultStatsReqID - Used by the service instance to correlate this error (when it arrives) with the original request.
faultStatisticsError - The fault statistics error.
recordSubject - Specifies the entity (framework or application) whose fault statistics record was requested.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

generateFaultStatisticsRecordReq

public void generateFaultStatisticsRecordReq(int faultStatsReqID,
                                             org.csapi.jr.se.TimeInterval timePeriod)
                                      throws CommonException
This method is used by the framework to solicit fault statistics from the service instance, for example when the framework was asked for these statistics by the client application using the generateFaultStatisticsRecordReq operation on the IpFaultManager interface. On receipt of this request the service instance must produce a fault statistics record during the specified time interval, which is returned to the framework using the generateFaultStatisticsRecordRes operation on the IpFwFaultManager interface.

Parameters:
faultStatsReqID - The identifier provided by the framework 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 service.
Throws:
CommonException - Defines the structure of the exception class which is applicable to all methods.

fwAvailStatusInd

public void fwAvailStatusInd(org.csapi.jr.se.fw.FwAvailStatusReason reason)
The framework invokes this method to inform the service instance about the Framework availability status, that is that it can no longer use the Framework according to the reason parameter or that the Framework has become available again. The service instance may wait for the problem to be solved and just stop the usage of the Framework until the fwAvailStatusInd() is called again with the reason FRAMEWORK_AVAILABLE.

Parameters:
reason - Identifies the reason why the framework is no longer available or that it has become available again.