|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public void activityTestReq(int activityTestID, java.lang.String svcID) throws CommonException, InvalidServiceIdException, UnauthorisedParameterValueException, PlatformException
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.
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) errorpublic void appActivityTestRes(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 svcUnavailableInd(java.lang.String serviceID) throws CommonException, InvalidServiceIdException, UnauthorisedParameterValueException, PlatformException
serviceID
- Identifies the service that the application can no longer use.
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) errorpublic void genFaultStatsRecordReq(org.csapi.jr.se.TimeInterval timePeriod, java.lang.String[] serviceIDs) throws CommonException, InvalidServiceIdException, UnauthorisedParameterValueException, 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.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.
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) errorpublic void appActivityTestErr(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 appUnavailableInd(java.lang.String serviceID) throws CommonException, PlatformException
serviceID
- Identifies the affected 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 genFaultStatsRecordRes(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 genFaultStatsRecordErr(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 appAvailStatusInd(org.csapi.jr.se.fw.AppAvailStatusReason reason) throws CommonException, PlatformException
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.
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, java.lang.String[] serviceIDs) throws CommonException, InvalidServiceIdException, UnauthorisedParameterValueException, PlatformException
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.
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) 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 |