|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface and the signServiceAgreement(), terminateServiceAgreement(), selectService() and initiateSignServiceAgreement() methods shall be implemented by a Framework.
Method Summary | |
void |
initiateSignServiceAgreement(java.lang.String serviceToken)
This method is used by the client application to initiate the sign service agreement process. |
java.lang.String |
selectService(java.lang.String serviceID)
This method is used by the client application to identify the service that the client application wishes to use. |
org.csapi.jr.se.fw.SignatureAndServiceMgr |
signServiceAgreement(java.lang.String serviceToken,
java.lang.String agreementText,
java.lang.String signingAlgorithm)
After the framework has called signServiceAgreement() on the application's IpAppServiceAgreementManagement interface, this method is used by the client application to request that the framework sign the service agreement, which allows the client application to use the service. |
void |
terminateServiceAgreement(java.lang.String serviceToken,
java.lang.String terminationText,
byte[] digitalSignature)
This method is used by the client application to terminate an agreement for the service. |
Method Detail |
public org.csapi.jr.se.fw.SignatureAndServiceMgr signServiceAgreement(java.lang.String serviceToken, java.lang.String agreementText, java.lang.String signingAlgorithm) throws CommonException, AccessDeniedException, InvalidAgreementTextException, InvalidServiceTokenException, InvalidSigningAlgorithmException, ServiceAccessDeniedException, PlatformException
serviceToken
- This is the token returned by the framework in a call to the selectService() method. This token is used to identify the service instance requested by the client application. If the serviceToken is invalid, or has expired, an error code (P_INVALID_SERVICE_TOKEN) is returned.agreementText
- This is the agreement text that is to be signed by the framework using the private key of the framework. If the agreementText is invalid, then an error code (P_INVALID_AGREEMENT_TEXT) is returned.signingAlgorithm
- This is the algorithm used to compute the digital signature. It shall be identical to the one chosen by the framework in response to IpAccess.selectSigningAlgorithm(). If the signingAlgorithm is not the chosen one, is invalid, or unknown to the framework, an error code (P_INVALID_SIGNING_ALGORITHM) is returned. The list of possible algorithms is as specified in the TpSigningAlgorithm table. The identifier used in this parameter must correspond to the digestAlgorithm and signatureAlgorithm fields in the SignerInfo field in the digitalSignature (see below).
CommonException
- Defines the structure of the exception class which is applicable to all methods.
AccessDeniedException
- The client is not currently authenticated with the framework
InvalidAgreementTextException
- Invalid agreement text
InvalidServiceTokenException
- The service token has not been issued, or it has expired.
InvalidSigningAlgorithmException
- Invalid signing algorithm
ServiceAccessDeniedException
- The client application is not allowed to access this service.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void terminateServiceAgreement(java.lang.String serviceToken, java.lang.String terminationText, byte[] digitalSignature) throws CommonException, AccessDeniedException, InvalidServiceTokenException, InvalidSignatureException, PlatformException
serviceToken
- This is the token passed back from the framework in a previous selectService() method call. This token is used to identify the service agreement to be terminated. If the serviceToken is invalid, or has expired, an error code (P_INVALID_SERVICE_TOKEN) is returned.terminationText
- This is the termination text that describes the reason for the termination of the service agreement.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 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 signing algorithm used is the same as the signing algorithm given when the service agreement was signed using signServiceAgreement(). The framework uses this to check that the terminationText has been signed by the client application. If a match is made, the service agreement is terminated, otherwise an error code (P_INVALID_SIGNATURE) 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
InvalidServiceTokenException
- The service token has not been issued, or it has expired.
InvalidSignatureException
- Invalid digital signature
PlatformException
- The implementation detected an internal (for example, communication) errorpublic java.lang.String selectService(java.lang.String serviceID) throws CommonException, AccessDeniedException, InvalidServiceIdException, ServiceAccessDeniedException, PlatformException
serviceID
- This identifies the service required. If the serviceID is not recognised by the framework, an error code (P_INVALID_SERVICE_ID) 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
InvalidServiceIdException
- Invalid service ID
ServiceAccessDeniedException
- The client application is not allowed to access this service.
PlatformException
- The implementation detected an internal (for example, communication) errorpublic void initiateSignServiceAgreement(java.lang.String serviceToken) throws CommonException, InvalidServiceTokenException, ServiceAccessDeniedException, PlatformException
serviceToken
- This is the token returned by the framework in a call to the selectService() method. This token is used to identify the service instance requested by the client application. If the serviceToken is invalid, or has expired, the exception (P_INVALID_SERVICE_TOKEN) is thrown.
CommonException
- Defines the structure of the exception class which is applicable to all methods.
InvalidServiceTokenException
- The service token has not been issued, or it has expired.
ServiceAccessDeniedException
- The client application is not allowed to access this service.
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 |