|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public void activityTestRes(int activityTestID, java.lang.String activityTestResult) throws CommonException, InvalidActivityTestIdException
activityTestID
- Used by the service to correlate this response (when it arrives) with the original request.activityTestResult
- The result of the activity test.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
InvalidActivityTestIdException
- ID does not correspond to a valid activity test requestpublic void svcActivityTestReq(int activityTestID) throws CommonException
activityTestID
- The identifier provided by the framework to correlate the response (when it arrives) with this request.
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void fwFaultReportInd(org.csapi.jr.se.fw.InterfaceFault fault) throws CommonException
fault
- Specifies the fault that has been detected by the framework.
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void fwFaultRecoveryInd(org.csapi.jr.se.fw.InterfaceFault fault) throws CommonException
fault
- Specifies the fault from which the framework has recovered.
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void fwUnavailableInd(org.csapi.jr.se.fw.FwUnavailReason reason) throws CommonException
reason
- Identifies the reason why the framework is no longer available
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void svcUnavailableInd() throws CommonException
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void appUnavailableInd() throws CommonException
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void genFaultStatsRecordRes(org.csapi.jr.se.fw.FaultStatsRecord faultStatistics, org.csapi.jr.se.fw.SubjectType recordSubject) throws CommonException
faultStatistics
- The fault statistics record.recordSubject
- Specifies the entity (framework or application) whose fault statistics record has been provided.
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void activityTestErr(int activityTestID) throws CommonException, InvalidActivityTestIdException
activityTestID
- Used by the service instance to correlate this response (when it arrives) with the original request.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
InvalidActivityTestIdException
- ID does not correspond to a valid activity test requestpublic void genFaultStatsRecordErr(org.csapi.jr.se.fw.FaultStatisticsError faultStatisticsError, org.csapi.jr.se.fw.SubjectType recordSubject) throws CommonException
faultStatisticsError
- The fault statistics error.recordSubject
- Specifies the entity (framework or application) whose fault statistics record was requested.
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void genFaultStatsRecordReq(org.csapi.jr.se.TimeInterval timePeriod, java.lang.String[] serviceIDs) throws CommonException, InvalidServiceIdException, UnauthorisedParameterValueException
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.
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.public void generateFaultStatsRecordReq(org.csapi.jr.se.TimeInterval timePeriod) throws CommonException
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.
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void appAvailStatusInd(org.csapi.jr.se.fw.AppAvailStatusReason reason) throws CommonException
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.
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void generateFaultStatisticsRecordRes(int faultStatsReqID, org.csapi.jr.se.fw.FaultStatsRecord faultStatistics, org.csapi.jr.se.fw.SubjectType recordSubject) throws CommonException
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.
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void generateFaultStatisticsRecordErr(int faultStatsReqID, org.csapi.jr.se.fw.FaultStatisticsError faultStatisticsError, org.csapi.jr.se.fw.SubjectType recordSubject) throws CommonException
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.
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void generateFaultStatisticsRecordReq(int faultStatsReqID, org.csapi.jr.se.TimeInterval timePeriod) throws CommonException
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.
CommonException
- Defines the structure of the exception class which is applicable to all methods.public void fwAvailStatusInd(org.csapi.jr.se.fw.FwAvailStatusReason reason)
reason
- Identifies the reason why the framework is no longer available or that it has become available again.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |