|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public void activityTestReq(int activityTestID, org.csapi.jr.se.fw.SubjectType testSubject) throws CommonException, PlatformException
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).
CommonException
- Defines the structure of the exception class which is applicable to all methods.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void svcActivityTestRes(int activityTestID, java.lang.String activityTestResult) throws CommonException, InvalidActivityTestIdException, PlatformException
activityTestID
- Used by the framework 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 request
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void appUnavailableInd() throws CommonException, PlatformException
CommonException
- Defines the structure of the exception class which is applicable to all methods.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void genFaultStatsRecordReq(org.csapi.jr.se.TimeInterval timePeriod, org.csapi.jr.se.fw.SubjectType recordSubject) throws CommonException, PlatformException
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).
CommonException
- Defines the structure of the exception class which is applicable to all methods.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void svcUnavailableInd(org.csapi.jr.se.fw.SvcUnavailReason reason) throws CommonException, PlatformException
reason
- Identifies the reason for the service instance's unavailability.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void svcActivityTestErr(int activityTestID) throws CommonException, InvalidActivityTestIdException, PlatformException
activityTestID
- Used by the framework 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 request
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void genFaultStatsRecordRes(org.csapi.jr.se.fw.FaultStatsRecord faultStatistics, java.lang.String[] serviceIDs) throws CommonException, PlatformException
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.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void genFaultStatsRecordErr(org.csapi.jr.se.fw.FaultStatisticsError faultStatisticsError, java.lang.String[] serviceIDs) throws CommonException, PlatformException
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.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void generateFaultStatsRecordRes(org.csapi.jr.se.fw.FaultStatsRecord faultStatistics) throws CommonException, PlatformException
faultStatistics
- The fault statistics record.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void generateFaultStatsRecordErr(org.csapi.jr.se.fw.FaultStatisticsError faultStatisticsError) throws CommonException, PlatformException
faultStatisticsError
- The fault statistics error.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void svcAvailStatusInd(org.csapi.jr.se.fw.SvcAvailStatusReason reason) throws CommonException, PlatformException
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.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void generateFaultStatisticsRecordReq(int faultStatsReqID, org.csapi.jr.se.TimeInterval timePeriod, org.csapi.jr.se.fw.SubjectType recordSubject) throws CommonException, PlatformException
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).
CommonException
- Defines the structure of the exception class which is applicable to all methods.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void generateFaultStatisticsRecordRes(int faultStatsReqID, org.csapi.jr.se.fw.FaultStatsRecord faultStatistics) throws CommonException, PlatformException
faultStatsReqID
- Used by the framework to correlate this response (when it arrives) with the original request.faultStatistics
- The fault statistics record.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void generateFaultStatisticsRecordErr(int faultStatsReqID, org.csapi.jr.se.fw.FaultStatisticsError faultStatisticsError) throws CommonException, PlatformException
faultStatsReqID
- Used by the framework to correlate this error (when it arrives) with the original request.faultStatisticsError
- The fault statistics error.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
PlatformException
- The implementation detected an internal (for example, communication) error
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |