com.entrust.toolkit.timestamp

Class HttpTimeStampTransport

java.lang.Object

com.entrust.toolkit.timestamp.HttpTimeStampTransport

All Implemented Interfaces:

TimeStampTransport

public class HttpTimeStampTransport
extends java.lang.Object
implements TimeStampTransport

This class implements an HTTP-based transport for the Time-Stamp protocol as defined in RFC 3161.

This transport is used for conveying ASN.1-encoded messages for the Time-Stamp protocol using the HyperText Transfer Protocol. The following two MIME objects are used:

 Content-type: application/timestamp-query
 
    <the ASN.1 DER-encoded Time-Stamp Request message>
 

 Content-type: application/timestamp-reply
 
    <the ASN.1 DER-encoded Time-Stamp Response message>
 

These MIME objects are sent and received over WWW links to provide simple browser-server transport for Time-Stamp messages.

Since:

7.0

See Also:

RFC 3161

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_RECEIVE_TIMEOUT By default, the maximum amount of time in milliseconds to spend attempting to receive a Time-Stamp response from the Time-Stamp Authority.

Constructor Summary

Constructors

Constructor and Description
HttpTimeStampTransport(java.lang.String url) Creates an HttpTimeStampTransport for communicating with a Time-Stamp Authority at the provided URL.
HttpTimeStampTransport(java.net.URL url) Creates an HttpTimeStampTransport for communicating with a Time-Stamp Authority at the provided URL.

Method Summary

Modifier and Type	Method and Description
int	getReceiveTimeout() Returns the receive timeout.
java.net.URL	getUrl() Returns the URL of the Time-Stamp Authority.
TimeStampResp	requestTimeStamp(TimeStampReq request) Sends/Receives a Time-Stamp request/response with the Time-Stamp Authority.
void	setReceiveTimeout(int receiveTimeout) Sets the receive timeout.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RECEIVE_TIMEOUT

public static final int DEFAULT_RECEIVE_TIMEOUT

By default, the maximum amount of time in milliseconds to spend attempting to receive a Time-Stamp response from the Time-Stamp Authority.

See Also:

Constant Field Values

Constructor Detail

HttpTimeStampTransport

public HttpTimeStampTransport(java.lang.String url)
                       throws java.net.MalformedURLException

Creates an HttpTimeStampTransport for communicating with a Time-Stamp Authority at the provided URL.

The URL must indicate that the http protocol is to be used:

     http://www.mycompany.com:1234/tsa
 

Parameters:

url - the URL of the Time-Stamp Authority in string format

Throws:

java.net.MalformedURLException - thrown string does not contain a properly formatted URL

InvalidArgumentException - thrown if the string is null or represents a URL that is not an http address

HttpTimeStampTransport

public HttpTimeStampTransport(java.net.URL url)

Creates an HttpTimeStampTransport for communicating with a Time-Stamp Authority at the provided URL.

The URL must indicate that the http protocol is to be used:

     http://www.mycompany.com:1234/tsa
 

Parameters:

url - the URL of the Time-Stamp Authority

Throws:

InvalidArgumentException - thrown if the string is null or represents a URL that does not indicate that the http protocol is to be used to contact the Time-Stamp Authority

Method Detail

requestTimeStamp

public TimeStampResp requestTimeStamp(TimeStampReq request)
                               throws java.io.IOException

Sends/Receives a Time-Stamp request/response with the Time-Stamp Authority.

First, a connection is opened with the Time-Stamp server. Then, the Time-Stamp request provided, is DER encoded and sent to the Time-Stamp Authority in an http 'POST' request. The response that is received from the Time-Stamp Authority is then DER decoded into a Time-Stamp request, and the connection with the Time-Stamp server is closed.

Checks are done to ensure that the response was received in the proper format, and that no errors occurred during the communication with the Time-Stamp Authority.

Specified by:

requestTimeStamp in interface TimeStampTransport

Parameters:

request - the Time-Stamp request

Returns:

the Time-Stamp response

Throws:

java.io.IOException - thrown if an error occurred while communicating with the Time-Stamp Authority

getUrl

public java.net.URL getUrl()

Returns the URL of the Time-Stamp Authority.

Returns:

the URL of the Time-Stamp Authority

setReceiveTimeout

public void setReceiveTimeout(int receiveTimeout)
                       throws java.lang.IllegalArgumentException

Sets the receive timeout.

The receive timeout is the maximum amount of time that will be spent when attempting to receive an entire response from the Time-Stamp Authority.

Parameters:

receiveTimeout - the receive timeout in milliseconds

Throws:

InvalidArgumentException - thrown if the receive timeout provided is less than zero

java.lang.IllegalArgumentException

getReceiveTimeout

public int getReceiveTimeout()

Returns the receive timeout.

The receive timeout is the maximum amount of time that will be spent when attempting to receive an entire response from the Time-Stamp Authority.

Returns:

the receive timeout in milliseconds