|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface shall be implemented by a Framework. As a minimum requirement the obtainInterface() and obtainInterfaceWithCallback(), selectSigningAlgorithm() and terminateAccess() methods shall be implemented.
Method Summary | |
void |
endAccess(org.csapi.jr.se.fw.Property[] endAccessProperties)
Deprecated. |
java.lang.String[] |
listInterfaces()
The client uses this method to obtain the names of all interfaces supported by the framework. |
org.csapi.jr.se.CsapiInterface |
obtainInterface(java.lang.String interfaceName)
This method is used to obtain other framework interfaces. |
org.csapi.jr.se.CsapiInterface |
obtainInterfaceWithCallback(java.lang.String interfaceName,
org.csapi.jr.se.CsapiInterface clientInterface)
This method is used to obtain other framework interfaces. |
void |
releaseInterface(java.lang.String interfaceName)
Deprecated. |
void |
relinquishInterface(java.lang.String interfaceName,
java.lang.String terminationText,
byte[] digitalSignature)
The client uses this method to release an instance of a framework interface that was obtained during this access session. |
java.lang.String |
selectSigningAlgorithm(java.lang.String signingAlgorithmCaps)
The client uses this method to inform the Framework of the different signing algorithms it supports for use in all cases where digital signatures are required. |
void |
terminateAccess(java.lang.String terminationText,
byte[] digitalSignature)
The terminateAccess method is used by the client to request that its access session with the framework is ended. |
Method Detail |
public org.csapi.jr.se.CsapiInterface obtainInterface(java.lang.String interfaceName) throws CommonException, AccessDeniedException, InvalidInterfaceNameException, PlatformException
interfaceName
- The name of the framework interface to which a reference to the interface is requested. If the interfaceName is invalid, the framework returns an error code (P_INVALID_INTERFACE_NAME).
CommonException
- Defines the structure of the exception class which is applicable to all methods.
AccessDeniedException
- The client is not currently authenticated with the framework
InvalidInterfaceNameException
- Invalid interface name.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic org.csapi.jr.se.CsapiInterface obtainInterfaceWithCallback(java.lang.String interfaceName, org.csapi.jr.se.CsapiInterface clientInterface) throws CommonException, AccessDeniedException, InvalidInterfaceNameException, InvalidInterfaceTypeException, PlatformException
interfaceName
- The name of the framework interface to which a reference to the interface is requested. If the interfaceName is invalid, the framework returns an error code (P_INVALID_INTERFACE_NAME).clientInterface
- This is the reference to the client interface, which is used for callbacks. If a client interface is not needed, then this method should not be used. (The obtainInterface method should be used when no callback interface needs to be supplied.) If the interface reference is not of the correct type, the framework returns an error code (P_INVALID_INTERFACE_TYPE).
CommonException
- Defines the structure of the exception class which is applicable to all methods.
AccessDeniedException
- The client is not currently authenticated with the framework
InvalidInterfaceNameException
- Invalid interface name.
InvalidInterfaceTypeException
- The interface reference supplied by the client is the wrong type.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void endAccess(org.csapi.jr.se.fw.Property[] endAccessProperties) throws CommonException, AccessDeniedException, InvalidPropertyException, PlatformException
endAccessProperties
- This is a list of properties that can be used to tell the framework the actions to perform when ending the access session (for example existing service sessions may be stopped, or left running). If a property is not recognised by the framework, an error code (P_INVALID_PROPERTY) is returned.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
AccessDeniedException
- The client is not currently authenticated with the framework
InvalidPropertyException
- The framework does not recognise the property supplied by the client
PlatformException
- The implementation detected an internal (for example, communication) errorpublic java.lang.String[] listInterfaces() throws CommonException, AccessDeniedException, PlatformException
CommonException
- Defines the structure of the exception class which is applicable to all methods.
AccessDeniedException
- The client is not currently authenticated with the framework
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void releaseInterface(java.lang.String interfaceName) throws CommonException, AccessDeniedException, InvalidInterfaceNameException, PlatformException
interfaceName
- This is the name of the framework interface which is being released. If the interfaceName is invalid, the framework throws the P_INVALID_INTERFACE_NAME exception. If the interface has not been given to the client during this access session, then the P_TASK_REFUSED exception will be thrown.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
AccessDeniedException
- The client is not currently authenticated with the framework
InvalidInterfaceNameException
- Invalid interface name.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic java.lang.String selectSigningAlgorithm(java.lang.String signingAlgorithmCaps) throws CommonException, AccessDeniedException, NoAcceptableSigningAlgorithmException, PlatformException
signingAlgorithmCaps
- The list of signing algorithms supported by the client.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
AccessDeniedException
- The client is not currently authenticated with the framework
NoAcceptableSigningAlgorithmException
- No signing algorithm, which is acceptable to the framework, is supported by the client
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void terminateAccess(java.lang.String terminationText, byte[] digitalSignature) throws CommonException, InvalidSignatureException, PlatformException
terminationText
- This is the termination text describes the reason for the termination of the access session.digitalSignature
- This contains a CMS (Cryptographic Message Syntax) object (as defined in RFC 2630) with content type Signed-data. The signature is calculated and created as per section 5 of RFC 2630. The content is made of the termination text. The "external signature" construct shall not be used (that is the eContent field in the EncapsulatedContentInfo field shall be present and contain the termination text string). The signing-time attribute, as defined in section 11.3 of RFC 2630, shall also be used to provide replay prevention. The client uses this to confirm its identity to the framework. The framework can check that the terminationText has been signed by the client. If a match is made, the access session is terminated, otherwise the P_INVALID_SIGNATURE exception will be thrown.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
InvalidSignatureException
- Invalid digital signature
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void relinquishInterface(java.lang.String interfaceName, java.lang.String terminationText, byte[] digitalSignature) throws CommonException, InvalidSignatureException, InvalidInterfaceNameException, PlatformException
interfaceName
- This is the name of the framework interface which is being released. If the interfaceName is invalid, the framework throws the P_INVALID_INTERFACE_NAME exception. If the interface has not been given to the client during this access session, then the P_TASK_REFUSED exception will be thrown.terminationText
- This is the termination text describes the reason for the release of the interface. This text is required simply because the digitalSignature parameter requires a terminationText to sign.digitalSignature
- This contains a CMS (Cryptographic Message Syntax) object (as defined in RFC 2630) with content type Signed-data. The signature is calculated and created as per section 5 of RFC 2630. The content is made of the termination text. The "external signature" construct shall not be used (that is the eContent field in the EncapsulatedContentInfo field shall be present and contain the termination text string). The signing-time attribute, as defined in section 11.3 of RFC 2630, shall also be used to provide replay prevention. The client uses this to confirm its identity to the framework. The framework can check that the terminationText has been signed by the client. If a match is made, the interface is released, otherwise the P_INVALID_SIGNATURE exception will be thrown.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
InvalidSignatureException
- Invalid digital signature
InvalidInterfaceNameException
- Invalid interface name.
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 |