com.entrust.toolkit.x509.revocation.ocsp.net

Class HTTPOCSPProtocolHandler

java.lang.Object

com.entrust.toolkit.x509.revocation.ocsp.net.OCSPProtocolHandler

com.entrust.toolkit.x509.revocation.ocsp.net.HTTPOCSPProtocolHandler

Direct Known Subclasses:

HTTPSOCSPProtocolHandler

public class HTTPOCSPProtocolHandler
extends OCSPProtocolHandler

A simple wrapper class allowing to post an OCSP request to an OCSP server over HTTP.

This class uses a HttpURLConnection object for sending a request to an OCSP responder by using the POST method. When creating a HTTPOCSPProtocolHandler object supply the URL of the OCSP responder and subsequently call method sendRequest(OCSPRequest) for sending the OCSPRequest to the server. The response from the server can be obtained by calling method getOCSPResponse, e.g.:

 // the request to be send:
 OCSPRequest ocspRequest = ...;
 // the responder URL to post to:
 URL url = ...;
 // create the http request:
 HTTPOCSPProtocolHandler httpOCSPRequest = new HTTPOCSPProtocolHandler(url);
 // post the request
 int responseCode = httpOCSPRequest.postRequest(ocspRequest);
 if (responseCode != getSuccessCode()) {
   System.out.println("Error connecting to " + m_responderUrl + ":"); 
   System.out.println(httpOCSPRequest.getResponseMessage());
 } else {
   System.out.println("Parse response: ");
   OCSPResponse ocspResponse = httpOCSPRequest.getOCSPResponse();
   ...
 }

See Also:

OCSPRequest, OCSPResponse

Constructor Summary

Constructors

Constructor and Description
HTTPOCSPProtocolHandler(java.net.URL location) Sets the HTTPOCSPProtocolHandler based on the given URL.

Method Summary

Modifier and Type	Method and Description
OCSPResponse	getOCSPResponse() Once an OCSP request has been set, the Response should be available if everything has gone as requested.
java.lang.String	getResponseMessage() Gets the Http response message.
int	getSuccessCode() Returns the implementations integer representation of a successcode, For HTTP, HTTPS, and FTP it is 200, but it could be different for another protocol.
int	sendRequest(OCSPRequest ocspRequest) Posts the given ocsp request to the responder of this HTTPOCSPProtocolHandler.

Methods inherited from class com.entrust.toolkit.x509.revocation.ocsp.net.OCSPProtocolHandler

getConnectTimeout, getReadTimeout, getResponderURL, setConnectTimeout, setReadTimeout, setResponderURL

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HTTPOCSPProtocolHandler

public HTTPOCSPProtocolHandler(java.net.URL location)

Sets the HTTPOCSPProtocolHandler based on the given URL.

Parameters:

location - The specified URL location

Method Detail

sendRequest

public int sendRequest(OCSPRequest ocspRequest)
                throws java.io.IOException,
                       UnknownResponseException,
                       java.lang.InterruptedException,
                       CodingException

Posts the given ocsp request to the responder of this HTTPOCSPProtocolHandler.

Specified by:

sendRequest in class OCSPProtocolHandler

Parameters:

ocspRequest - the OCSPrequest to be posted

Returns:

the http response code indicating success status

Throws:

java.io.IOException - if an I/O error occurs while reading the response

UnknownResponseException - if the post has been successful, but the server responder with an unknown response

java.lang.InterruptedException

CodingException

getOCSPResponse

public OCSPResponse getOCSPResponse()

Description copied from class: OCSPProtocolHandler

Once an OCSP request has been set, the Response should be available if everything has gone as requested.

Specified by:

getOCSPResponse in class OCSPProtocolHandler

Returns:

the OCSP response sent by the server

getResponseMessage

public java.lang.String getResponseMessage()

Gets the Http response message. This may be useful to see the reason if the connection was not successful.

Specified by:

getResponseMessage in class OCSPProtocolHandler

Returns:

the Http response message

getSuccessCode

public int getSuccessCode()

Description copied from class: OCSPProtocolHandler

Returns the implementations integer representation of a successcode, For HTTP, HTTPS, and FTP it is 200, but it could be different for another protocol.

Specified by:

getSuccessCode in class OCSPProtocolHandler

Returns:

the integer code which represents a successful transaction for this Http Protocol handler