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

Class OCSPProtocolHandler

java.lang.Object

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

Direct Known Subclasses:

HTTPOCSPProtocolHandler

public abstract class OCSPProtocolHandler
extends java.lang.Object

The OCSPProtocolHandler is a protocol handler which is used to select the type of protocol which is used to send the OCSP request.

Examples of protocols which could be used to send OCSP requests:

• HTTP - Sending the OCSP request over HTTP
• HTTPS - Sending the OCSP request over HTTPS
• FTP - sending the OCSP request over FTP

Implementations of specific protocols should extend this class

Since:

7.2

See Also:

HTTPOCSPProtocolHandler

Constructor Summary

Constructors

Constructor and Description
OCSPProtocolHandler()

Method Summary

Methods

Modifier and Type	Method and Description
int	getConnectTimeout()
abstract OCSPResponse	getOCSPResponse() Once an OCSP request has been set, the Response should be available if everything has gone as requested.
int	getReadTimeout()
java.net.URL	getResponderURL()
abstract java.lang.String	getResponseMessage() Gets the http response message.
abstract 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.
abstract int	sendRequest(OCSPRequest ocspRequest) Method used to send OCSP request via the specified protocol
void	setConnectTimeout(int milliseconds) Sets the connect timeout for connecting to the OCSP responder in milliseconds.
void	setReadTimeout(int milliseconds) Set the Timeout for reading data from the connection in milliseconds.
void	setResponderURL(java.net.URL location) Sets the URL of the responder.

Methods inherited from class java.lang.Object

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

Constructor Detail

OCSPProtocolHandler

public OCSPProtocolHandler()

Method Detail

setResponderURL

public void setResponderURL(java.net.URL location)

Sets the URL of the responder.

Parameters:

location - The URL location of the responder

sendRequest

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

Method used to send OCSP request via the specified protocol

Parameters:

ocspRequest - The OCSP request to be sent to the server

Returns:

an Integer representing a return type

Throws:

java.io.IOException

java.lang.InterruptedException

CodingException

UnknownResponseException

getOCSPResponse

public abstract OCSPResponse getOCSPResponse()

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

Returns:

OCSPResponse The OCSP response if set, or null if it has not been set

getResponseMessage

public abstract java.lang.String getResponseMessage()

Gets the http response message. If the response was not successful, then get a response message which may contain the reason why the response was not successful.

Returns:

the http response message

setReadTimeout

public void setReadTimeout(int milliseconds)

Set the Timeout for reading data from the connection in milliseconds. If set to 0 then no read timeout will be used.

Parameters:

milliseconds - the number of milliseconds for the read timeout

getReadTimeout

public int getReadTimeout()

Returns:

the value of the read timeout in milliseconds

setConnectTimeout

public void setConnectTimeout(int milliseconds)

Sets the connect timeout for connecting to the OCSP responder in milliseconds. If set to 0 then no read timeout will be used.

Parameters:

milliseconds -

getConnectTimeout

public int getConnectTimeout()

Returns:

the value of the connect timeout in milliseconds

getSuccessCode

public abstract 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.

Returns:

integer representation of success code for specified protocol

getResponderURL

public java.net.URL getResponderURL()

Returns:

the URL accessLocation for the instance of this protocol handler