Package eu.europa.esig.dss.enumerations

Enum TokenExtractionStrategy

java.lang.Object

java.lang.Enum<TokenExtractionStrategy>

eu.europa.esig.dss.enumerations.TokenExtractionStrategy

All Implemented Interfaces:

Serializable, Comparable<TokenExtractionStrategy>

public enum TokenExtractionStrategy
extends Enum<TokenExtractionStrategy>

Defines a representation of tokens in the DiagnosticData (as binaries or digests)

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXTRACT_ALL	Extract certificates, timestamps and revocation data
EXTRACT_CERTIFICATES_AND_REVOCATION_DATA	Extract certificates and revocation data
EXTRACT_CERTIFICATES_AND_TIMESTAMPS	Extract certificates and timestamps
EXTRACT_CERTIFICATES_ONLY	Extract certificates
EXTRACT_REVOCATION_DATA_ONLY	Extract revocation data
EXTRACT_TIMESTAMPS_AND_REVOCATION_DATA	Extract timestamps and revocation data
EXTRACT_TIMESTAMPS_ONLY	Extract timestamps
NONE	Extract nothing

Method Summary

Modifier and Type	Method	Description
static TokenExtractionStrategy	fromParameters(boolean certificate, boolean timestamp, boolean revocationData)	Returns the enumeration value depending on parameters
boolean	isCertificate()	This method returns true if the certificate extraction is enabled
boolean	isRevocationData()	This method returns true if the revocation data extraction is enabled
boolean	isTimestamp()	This method returns true if the timestamp extraction is enabled
static TokenExtractionStrategy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TokenExtractionStrategy[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXTRACT_ALL

public static final TokenExtractionStrategy EXTRACT_ALL

Extract certificates, timestamps and revocation data

EXTRACT_CERTIFICATES_ONLY

public static final TokenExtractionStrategy EXTRACT_CERTIFICATES_ONLY

Extract certificates

EXTRACT_TIMESTAMPS_ONLY

public static final TokenExtractionStrategy EXTRACT_TIMESTAMPS_ONLY

Extract timestamps

EXTRACT_REVOCATION_DATA_ONLY

public static final TokenExtractionStrategy EXTRACT_REVOCATION_DATA_ONLY

Extract revocation data

EXTRACT_CERTIFICATES_AND_TIMESTAMPS

public static final TokenExtractionStrategy EXTRACT_CERTIFICATES_AND_TIMESTAMPS

Extract certificates and timestamps

EXTRACT_CERTIFICATES_AND_REVOCATION_DATA

public static final TokenExtractionStrategy EXTRACT_CERTIFICATES_AND_REVOCATION_DATA

Extract certificates and revocation data

EXTRACT_TIMESTAMPS_AND_REVOCATION_DATA

public static final TokenExtractionStrategy EXTRACT_TIMESTAMPS_AND_REVOCATION_DATA

Extract timestamps and revocation data

NONE

public static final TokenExtractionStrategy NONE

Extract nothing

Method Detail

values

public static TokenExtractionStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TokenExtractionStrategy c : TokenExtractionStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TokenExtractionStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isCertificate

public boolean isCertificate()

This method returns true if the certificate extraction is enabled

Returns:

true if certificates need to be extracted

isTimestamp

public boolean isTimestamp()

This method returns true if the timestamp extraction is enabled

Returns:

true if timestamps need to be extracted

isRevocationData

public boolean isRevocationData()

This method returns true if the revocation data extraction is enabled

Returns:

true if revocation data need to be extracted

fromParameters

public static TokenExtractionStrategy fromParameters(boolean certificate,
                                                     boolean timestamp,
                                                     boolean revocationData)

Returns the enumeration value depending on parameters

Parameters:

certificate - true if certificates need to be extracted

timestamp - true if timestamps need to be extracted

revocationData - true if revocation data need to be extracted

Returns:

TokenExtractionStrategy