com.adobe.livecycle.signatures.client.types
Class TSPOptionSpec

java.lang.Object
  com.adobe.livecycle.signatures.client.types.TSPOptionSpec

All Implemented Interfaces:

java.io.Serializable

public class TSPOptionSpec
extends java.lang.Object
implements java.io.Serializable

Stores preference values for time stamping provider (TSP) support.

See Also:

Serialized Form

Field Summary

static java.lang.Integer	DEFAULT_TSP_SIZE The default size, in bytes, of this TSP request.
static java.lang.Integer	MAX_TSP_SIZE The maximum size, in bytes, of this TSP request.
static java.lang.Integer	MIN_TSP_SIZE The minimum size, in bytes, of this TSP request.

Constructor Summary

TSPOptionSpec()
Creates a TSPOptionSpec object with these default values:

TSPOptionSpec(RevocationCheckStyle revCheckStyle, HashAlgorithm hashAlgo, java.lang.Integer tspSize, boolean sendNonce, java.lang.String serverURL, java.lang.String username, java.lang.String password)
Creates a TSPOptionSpec object.

Method Summary

HashAlgorithm	getTspHashAlgorithm() Gets a HashAlgorithm object that represents a hash algorithm associated with this TSP.
RevocationCheckStyle	getTspRevocationCheckStyle() Returns a RevocationCheckStyle object that represents revocation checking.
java.lang.String	getTspServerPassword() Returns a password for a TSP server.
java.lang.String	getTspServerURL() Returns an URL for a TSP server.
java.lang.String	getTspServerUsername() Returns a user name for a TSP server.
java.lang.Integer	getTspSize() Returns the size, in bytes, of this TSP request.
boolean	isTspSendNonce() Determines whether a nonce is sent with this TSP request.
boolean	isUseExpiredTimestamps()
void	setTspHashAlgorithm(HashAlgorithm tspHashAlgorithm) Sets a HashAlgorithm object that represents a hash algorithm associated with this TSP.
void	setTspRevocationCheckStyle(RevocationCheckStyle revocationCheckStyle) Sets a RevocationCheckStyle object that represents revocation checking.
void	setTspSendNonce(boolean sendNonce) Sets whether a nonce is sent during the request.
void	setTspServerPassword(java.lang.String tspServerPassword) Sets a password for a TSP server.
void	setTspServerURL(java.lang.String tspServerURL) Sets an URL for a TSP server.
void	setTspServerUsername(java.lang.String tspServerUsername) Sets the user name for a TSP server.
void	setTspSize(java.lang.Integer tspSize) Sets the size, in bytes, of this TSP request.
void	setUseExpiredTimestamps(boolean useExpiredTimestamps)

Methods inherited from class java.lang.Object

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

Field Detail

MIN_TSP_SIZE

public static final java.lang.Integer MIN_TSP_SIZE

The minimum size, in bytes, of this TSP request. The minimum size is 64.

MAX_TSP_SIZE

public static final java.lang.Integer MAX_TSP_SIZE

The maximum size, in bytes, of this TSP request. The maximum size is 10240.

DEFAULT_TSP_SIZE

public static final java.lang.Integer DEFAULT_TSP_SIZE

The default size, in bytes, of this TSP request. The default size is 4096.

Constructor Detail

TSPOptionSpec

public TSPOptionSpec(RevocationCheckStyle revCheckStyle,
                     HashAlgorithm hashAlgo,
                     java.lang.Integer tspSize,
                     boolean sendNonce,
                     java.lang.String serverURL,
                     java.lang.String username,
                     java.lang.String password)

Creates a TSPOptionSpec object.

Parameters:

revCheckStyle - A RevocationCheckStyle object that specifies revocation checking preference types.

hashAlgo - A HashAlgorithm object that specifies the hash algorithm associated with this object.

tspSize - The size, in bytes, of this TSP request.

sendNonce - A Boolean value that specifies whether a nonce is sent with this TSP request.

serverURL - The URL of the TSP server.

username - The username required to access the TSP server.

password - The password required to access the TSP server.

TSPOptionSpec

public TSPOptionSpec()

Creates a TSPOptionSpec object with these default values:

• The hash algorithm is HashAlgorithm.SHA1.
• The revocation checking preference type is RevocationCheckStyle.BestEffort.
• A nonce is sent with this TSP request.

Method Detail

isTspSendNonce

public boolean isTspSendNonce()

Determines whether a nonce is sent with this TSP request. A nonce can be a time stamp, a visit counter on a Web page, or a special marker intended to limit or prevent the unauthorized replay or reproduction of a file.

Returns:

A Boolean value that determines whether a nonce is sent.

setTspSendNonce

public void setTspSendNonce(boolean sendNonce)

Sets whether a nonce is sent during the request.

Parameters:

sendNonce - A Boolean value that specifies whether a nonce is sent with this request.

getTspHashAlgorithm

public HashAlgorithm getTspHashAlgorithm()

Gets a HashAlgorithm object that represents a hash algorithm associated with this TSP.

Returns:

A HashAlgorithm object that represents a hash algorithm associated with this TSP.

setTspHashAlgorithm

public void setTspHashAlgorithm(HashAlgorithm tspHashAlgorithm)

Sets a HashAlgorithm object that represents a hash algorithm associated with this TSP.

Parameters:

tspHashAlgorithm - A HashAlgorithm object that represents a hash algorithm associated with this TSP.

getTspServerPassword

public java.lang.String getTspServerPassword()

Returns a password for a TSP server.

Returns:

A password for a TSP server.

setTspServerPassword

public void setTspServerPassword(java.lang.String tspServerPassword)

Sets a password for a TSP server.

Parameters:

tspServerPassword - A password value for a TSP server.

getTspServerURL

public java.lang.String getTspServerURL()

Returns an URL for a TSP server.

Returns:

An URL for a TSP server.

setTspServerURL

public void setTspServerURL(java.lang.String tspServerURL)

Sets an URL for a TSP server.

Parameters:

tspServerURL - An URL for a TSP server.

getTspServerUsername

public java.lang.String getTspServerUsername()

Returns a user name for a TSP server.

Returns:

A user name for a TSP server.

setTspServerUsername

public void setTspServerUsername(java.lang.String tspServerUsername)

Sets the user name for a TSP server.

Parameters:

tspServerUsername - The user name for a TSP server.

getTspSize

public java.lang.Integer getTspSize()

Returns the size, in bytes, of this TSP request.

Returns:

The size of this TSP request.

setTspSize

public void setTspSize(java.lang.Integer tspSize)

Sets the size, in bytes, of this TSP request.

Parameters:

tspSize - This size of this TSP request.

getTspRevocationCheckStyle

public RevocationCheckStyle getTspRevocationCheckStyle()

Returns a RevocationCheckStyle object that represents revocation checking.

Returns:

A RevocationCheckStyle object that represents revocation checking.

setTspRevocationCheckStyle

public void setTspRevocationCheckStyle(RevocationCheckStyle revocationCheckStyle)

Sets a RevocationCheckStyle object that represents revocation checking.

Parameters:

revocationCheckStyle - A RevocationCheckStyle object that represents revocation checking.

isUseExpiredTimestamps

public boolean isUseExpiredTimestamps()

setUseExpiredTimestamps

public void setUseExpiredTimestamps(boolean useExpiredTimestamps)