Package org.ejbca.core.protocol.ws.client.gen

Provides the client-part of the EJBCA WS (Web Service) interface.

See:
Description

Interface Summary

EjbcaWS

Primary interface to the EJBCA RA WebService.

Class Summary

AlreadyRevokedException	Java class for AlreadyRevokedException complex type.
ApprovalException	Java class for ApprovalException complex type.
ApprovalRequestExecutionException	Java class for ApprovalRequestExecutionException complex type.
ApprovalRequestExpiredException	Java class for ApprovalRequestExpiredException complex type.
AuthorizationDeniedException	Java class for AuthorizationDeniedException complex type.
CADoesntExistsException	Java class for CADoesntExistsException complex type.
Certificate	Holds certificate WS elements
CertificateExpiredException	Java class for CertificateExpiredException complex type.
CertificateResponse	Holds certificate WS response data
EjbcaException	Java class for EjbcaException complex type.
EjbcaWSService	This class was generated by the JAXWS SI.
ErrorCode	Java class for errorCode complex type.
ExtendedInformationWS	Class used to represent extended information in userdata in the WebService API.
HardTokenDataWS	Value object containing WS representation of a hard token data it contains information about PIN/PUK codes, hardtoken serial number certificate stored on the card.
HardTokenDoesntExistsException	Java class for HardTokenDoesntExistsException complex type.
HardTokenExistsException	Java class for HardTokenExistsException complex type.
IllegalQueryException	Java class for IllegalQueryException complex type.
KeyStore	Wrapper class for holding WS keystore data
MultipleMatchException	Java class for MultipleMatchException complex type.
NameAndId	Value object holding a Name and Id pair, for example for a CA or a end entity- or certificate profile.
NotFoundException	Java class for NotFoundException complex type.
PinDataWS	Class containing a web service representation of a PIN data such as type, PIN and PUK
PublisherException	Java class for PublisherException complex type.
RevokeStatus	Class used when checking the revocation status of a certificate.
SignRequestException	Java class for SignRequestException complex type.
TokenCertificateRequestWS	Base class this is a ITokenCertificateRequest, either a PKCS10 or KeyStore defined by the type field.
TokenCertificateResponseWS	base class that this is a certificate response of either a Certificate or KeyStore
UserDataSourceException	Java class for UserDataSourceException complex type.
UserDataSourceVOWS	Class used to represent userdatasource in the WebService API.
UserDataVOWS	Class used to represent userdata in the WebService API.
UserDoesntFullfillEndEntityProfile	Java class for UserDoesntFullfillEndEntityProfile complex type.
UserMatch	Holder of user match/search data.
WaitingForApprovalException	Java class for WaitingForApprovalException complex type.

Exception Summary

AlreadyRevokedException_Exception	This class was generated by the JAXWS SI.
ApprovalException_Exception	This class was generated by the JAXWS SI.
ApprovalRequestExecutionException_Exception	This class was generated by the JAXWS SI.
ApprovalRequestExpiredException_Exception	This class was generated by the JAXWS SI.
AuthorizationDeniedException_Exception	This class was generated by the JAXWS SI.
CADoesntExistsException_Exception	This class was generated by the JAXWS SI.
CertificateExpiredException_Exception	This class was generated by the JAXWS SI.
EjbcaException_Exception	This class was generated by the JAXWS SI.
HardTokenDoesntExistsException_Exception	This class was generated by the JAXWS SI.
HardTokenExistsException_Exception	This class was generated by the JAXWS SI.
IllegalQueryException_Exception	This class was generated by the JAXWS SI.
MultipleMatchException_Exception	This class was generated by the JAXWS SI.
NotFoundException_Exception	This class was generated by the JAXWS SI.
PublisherException_Exception	This class was generated by the JAXWS SI.
SignRequestException_Exception	This class was generated by the JAXWS SI.
UserDataSourceException_Exception	This class was generated by the JAXWS SI.
UserDoesntFullfillEndEntityProfile_Exception	This class was generated by the JAXWS SI.
WaitingForApprovalException_Exception	This class was generated by the JAXWS SI.

Package org.ejbca.core.protocol.ws.client.gen Description

Provides the client-part of the EJBCA WS (Web Service) interface.

Introduction

This library supports EJBCA RA operations like issuing and revoking certificates.

Initialization

Before any EJBCA WS operations can be performed, the interface must be initialized. For performance reasons it is recommendable to only do this once, like in a ServletContextListener. Due to the fact that EJBCA requires that the calling applications are authenticated through TLS, client and trust-store certificates must also be defined during initialization. Below is a example of an intialization procedure:

    import javax.xml.namespace.QName;
         .
         .
    class MyClass
      {
        static EjbcaWS ejbcaws;  // A single instance is enough
                 .
                 .
        void myInit ()
          {
            // Initialization code
            System.setProperty ("javax.net.ssl.trustStore", "ws-keystore.jks");
            System.setProperty ("javax.net.ssl.trustStorePassword", "foo123");  
            System.setProperty ("javax.net.ssl.keyStore", "ws-keystore.jks");
            System.setProperty ("javax.net.ssl.keyStorePassword", "foo123");      
                
            QName qname = new QName ("http://ws.protocol.core.ejbca.org/", "EjbcaWSService");
            EjbcaWSService service = new EjbcaWSService (new URL ("https://localhost:8443/ejbca/ejbcaws/ejbcaws?wsdl"), qname);
            ejbcaws = service.getEjbcaWSPort ();
          }

Using the EJBCA interface

    UserDataVOWS user = new UserDataVOWS ();
    user.setUsername ("tester");
    user.setPassword ("foo123");
    user.setClearPwd (false);
    user.setSubjectDN ("CN=Tester,C=SE");
    user.setCaName ("AdminCA1");
    user.setTokenType (UserDataVOWS.TOKEN_TYPE_USERGENERATED);
    user.setEndEntityProfileName ("EMPTY");
    user.setCertificateProfileName ("ENDUSER");
    byte[] cert_blob = ejbcaws.certificateRequest (user,
                                                   pkcs10_request_in_base64,
                                                   CertificateHelper.CERT_REQ_TYPE_PKCS10,
                                                   null,
                                                   CertificateHelper.RESPONSETYPE_CERTIFICATE).getRawData ();

The data in italics is meant to be customized for the actual installation.