|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WSPKIClient
WSPKIClient interface that can be used to connect to a Certificate Authority (CA) and request a certificate, revoke a certificate, and query to see if a certificate creation has completed.
Method Summary | |
---|---|
void |
init(java.util.HashMap initAttrs)
Method called by WebSphere Application Server runtime to setup connection information to a Certificate Authority (CA). |
java.security.cert.X509Certificate[] |
queryCertificate(byte[] certReq,
java.util.HashMap customAttrs)
Method called by WebSphere Application Server runtime to query if certificate creation is completed on the Certificate Authority (CA). |
java.security.cert.X509Certificate[] |
requestCertificate(byte[] certReq,
javax.security.auth.x500.X500Principal SubjectDN,
byte[] revocationPassword,
java.util.HashMap customAttrs)
Method called by WebSphere Application Server runtime to connect to a Certificate Authority (CA) and requests a certificate signed by the authority. |
void |
revokeCertificate(java.security.cert.X509Certificate[] cert,
byte[] revocationPassword,
java.lang.String revocationReason,
java.util.HashMap customAttrs)
Method called by WebSphere Application Server runtime to summit a request to a Certificate Authority (CA) to revoke a certificate. |
Method Detail |
---|
void init(java.util.HashMap initAttrs) throws WSPKIException
initAttrs
- - java.util.HashMap that contains connection information to a Certificate Authority and any custom properties defined on the CAClient object.
Custom properties on the CAClient object will be stored in the HashMap as Strings. If a host, port, authentication ID, and authentication password are available they will be provided in the following keys on the HashMap.
CAHostname - String value for the host name of the Certificate Authority (CA).
CAPort - The Integer value for the port where the Certificate Authority (CA) server is listening.
AuthenticationID - String value for the id used to authenticate to the CA server.
AuthenticationPWD - The password used to authenticate to the CA server. The password is a "UTF-8" encoded sequence of bytes.
WSPKIException
java.security.cert.X509Certificate[] requestCertificate(byte[] certReq, javax.security.auth.x500.X500Principal SubjectDN, byte[] revocationPassword, java.util.HashMap customAttrs) throws WSPKIException
certReq
- - A byte[] that contains the PKCS10 certificate request.SubjectDN
- - A X500Principal that contains the X500Principal name of the certificaterevocationPassword
- - A byte[] that contains the "UTF-8" encoded password that will be needed to revoke the key store.customAttrs
- - A java.util.HashMap contains any customized information defined as a custom properties on the CAClient object. They will be stored in the HashMap as Strings.
WSPKIException
- if unable to connect to the CA or an error is return from the CA during while creating the certificate.void revokeCertificate(java.security.cert.X509Certificate[] cert, byte[] revocationPassword, java.lang.String revocationReason, java.util.HashMap customAttrs) throws WSPKIException
cert
- - X509Certificate[] that contains the certificate that is to be revoked.revocationPassword
- - A byte[] that contains the password in a "UTF-8" encoded sequence of bytes.revocationReason
- - String that contains the reason for revoking this certificate.customAttrs
- - java.util.HashMap that contains the custom information that may be needed to revoke the certificate. Any custom properties
defined on the CA Client object will be added to the HashMap as Strings. Key store information will be added to the following HashMap keys:
CertificateAlias - String value for the alias of the certificate that is to be revoked.
KeyStoreAlias - String value for the key store name as it is defined in the configuration.
KeyStore - String value for the path to the key store that hold the certificate.
KeyStoreType - String value for the type of the key store where the certificate is stored.
KeyStorePassword - The key store password in a "UTF-8" encoded sequence of bytes.
WSPKIException
- if unable to connect to the CA or an error is return from the CA while revoking the certificate.java.security.cert.X509Certificate[] queryCertificate(byte[] certReq, java.util.HashMap customAttrs) throws WSPKIException
certReq
- - byte[] that contains the PKCS10 certificate request.customAttrs
- - A java.util.HashMap contains any customized information defined as a custom properties on the CAClient object. They will be stored in the HashMap as Strings.
WSPKIException
- if unable to connect to the CA or an error is return from the CA while trying to query the status of a certificate.
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |