iaik.x509.ocsp.net

Class HttpOCSPRequest

java.lang.Object

iaik.x509.ocsp.net.HttpOCSPRequest

public class HttpOCSPRequest
extends java.lang.Object

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 HttpOCSPRequest object supply the URL of the OCSP responder and subsequently call method postRequest 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:
 HttpOCSPRequest httpOCSPRequest = new HttpOCSPRequest(url);
 // post the request
 int responseCode = httpOCSPRequest.postRequest(ocspRequest);
 if (responseCode/200 != 2) {
   System.out.println("Error connecting to " + responderUrl + ":"); 
   System.out.println(httpOCSPRequest.getResponseMessage());
 } else {
   System.out.println("Parse response: ");
   OCSPResponse ocspResponse = httpOCSPRequest.getOCSPResponse();
   ...
 }
 

Version:

File Revision 15

See Also:

OCSPRequest, OCSPResponse

Constructor Summary

Constructors

Constructor and Description
HttpOCSPRequest(java.net.URL responderUrl) Creates a HttpOCSPRequest for the given responder url.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getHeaderField(int n) Gets the value of the http response header field with the given index.
java.lang.String	getHeaderField(java.lang.String name) Gets the value of the http response header field with the given name.
java.lang.String	getHeaderFieldKey(int n) Gets the key of the http response header field with the given index.
OCSPResponse	getOCSPResponse() Returns the ocsp response sent by the server.
java.lang.String	getResponseMessage() Gets the http response message.
protected java.net.HttpURLConnection	openConnection(java.net.URL responderUrl) Opens the connection to the responder url.
int	postRequest(OCSPRequest ocspRequest) Posts the given ocsp request to the responder of this HttpOCSPRequest.
int	sendGETRequest(OCSPRequest ocspRequest) Uses the http GET command to send the given ocsp request to the responder of this HttpOCSPRequest.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpOCSPRequest

public HttpOCSPRequest(java.net.URL responderUrl)

Creates a HttpOCSPRequest for the given responder url.

Parameters:

responderUrl - the url of the OCSP responder

Method Detail

postRequest

public int postRequest(OCSPRequest ocspRequest)
                throws java.io.IOException,
                       UnknownResponseException

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

Parameters:

ocspRequest - the OCSPrequest to be posted

Returns:

the http response code indicating if the post has been successful

Throws:

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

UnknownResponseException - if the post has been successful, but the server uses an not supported response type

openConnection

protected java.net.HttpURLConnection openConnection(java.net.URL responderUrl)
                                             throws java.io.IOException

Opens the connection to the responder url.

This method is used by postRequest and sendGETRequest(OCSPRequest) to open the connection to the OCSP responder:

  return (HttpURLConnection) responderUrl.openConnection();
 

This method may be overridden by an application to do some application specific configurations for the HttpURLConnection object to be used, e.g. setting read/connect timeout:

 URL responderUrl = new URL(...);
 HttpOCSPRequest httpOCSPRequest = new HttpOCSPRequest(responderUrl) {

   protected HttpURLConnection openConnection(URL responderUrl) throws IOException {
     HttpURLConnection con = super.openConnection(responderUrl);
     con.setConnectTimeout(...);
     con.setReadTimeout(...);
     return con;
   }
   
 };

Parameters:

responderUrl - the responder url

Returns:

the HttpURLConnection object for connection to the responder

Throws:

java.io.IOException - if the connection cannot be opened

sendGETRequest

public int sendGETRequest(OCSPRequest ocspRequest)
                   throws java.io.IOException,
                          UnknownResponseException

Uses the http GET command to send the given ocsp request to the responder of this HttpOCSPRequest. If the encoded request is longer than 255 bytes, the http POST command is used to post the request.

Parameters:

ocspRequest - the OCSPrequest to be posted

Returns:

the http response code indicating if the post has been successful

Throws:

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

UnknownResponseException - if the post has been successful, but the server uses an not supported response type

getOCSPResponse

public OCSPResponse getOCSPResponse()

Returns the ocsp response sent by the server.

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.

Returns:

the http response message

getHeaderField

public java.lang.String getHeaderField(java.lang.String name)

Gets the value of the http response header field with the given name.

Parameters:

name - the name of the http response header field

Returns:

the value of the http response header field with the given name, or null if there is no header field with the given name or the request has yet not be send to the server

getHeaderFieldKey

public java.lang.String getHeaderFieldKey(int n)

Gets the key of the http response header field with the given index.

Parameters:

n - the header index

Returns:

the key of the http response header field with the given index, or null if there is no header field with the given index or the request has yet not be send to the server

getHeaderField

public java.lang.String getHeaderField(int n)

Gets the value of the http response header field with the given index.

Parameters:

n - the header index

Returns:

the value of the http response header field with the given index, or null if there is no header field with the given index or the request has yet not be send to the server