Token (DSS Model 5.2.d4j.3 API)

java.lang.Object
- eu.europa.esig.dss.x509.Token

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CertificateToken, RevocationToken
```
public abstract class Token
extends Object
implements Serializable
```
This is the base class for the different types of tokens (certificate, OCSP, CRL, Timestamp) used in the process of signature validation.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected TokenValidationExtraInfo`	`extraInfo`
`protected CertificateToken`	`issuerToken` This attribute represents the `CertificateToken` which is the issuer of the encapsulated Token.
`protected X500Principal`	`issuerX500Principal` The normalized `X500Principal` of the signer's certificate of this token.
`protected SignatureAlgorithm`	`signatureAlgorithm`
`protected String`	`signatureInvalidityReason`
`protected boolean`	`signatureValid`

Constructor Summary

Constructors
Constructor and Description

Token()

Constructors
Constructor and Description
`Token()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`TokenValidationExtraInfo`	`extraInfo()` Returns the object managing the validation extra info.
`String`	`getAbbreviation()` This method returns the DSS abbreviation of the token.
`byte[]`	`getDigest(DigestAlgorithm digestAlgorithm)` Returns the digest value of the wrapped token
`TokenIdentifier`	`getDSSId()` Returns a DSS unique token identifier.
`String`	`getDSSIdAsString()` Returns a string representation of the unique DSS token identifier.
`abstract byte[]`	`getEncoded()` Returns the encoded form of the wrapped token.
`CertificateToken`	`getIssuerToken()` It returns the issuer certificate token that was used to sign this token (CertificateToken, CRLToken, OCSPRespToken, TimestampToken).
`X500Principal`	`getIssuerX500Principal()` Returns the `X500Principal` of the certificate which was used to sign this token.
`SignatureAlgorithm`	`getSignatureAlgorithm()` Returns the algorithm that was used to sign the token (ex: SHA1WithRSAEncryption, SHA1withRSA...).
`List<String>`	`getValidationInfo()` Returns the additional information gathered during the validation process.
`int`	`hashCode()`
`boolean`	`isSelfSigned()` Checks if the certificate is self-signed.
`boolean`	`isSignatureValid()` Indicates if the token's signature is intact.
`abstract boolean`	`isSignedBy(CertificateToken issuerToken)` Checks if the token is signed by the token given in the parameter.
`boolean`	`isTrusted()` Checks if the certificate is provided by the trusted list.
`String`	`toString()`
`abstract String`	`toString(String indentStr)` returns a string representation of the token.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - issuerToken
```
protected CertificateToken issuerToken
```
    This attribute represents the CertificateToken which is the issuer of the encapsulated Token. In other words this is the CertificateToken used to sign the enclosed Token.
  - issuerX500Principal
```
protected X500Principal issuerX500Principal
```
    The normalized X500Principal of the signer's certificate of this token.
  - signatureValid
```
protected boolean signatureValid
```
  - signatureInvalidityReason
```
protected String signatureInvalidityReason
```
  - signatureAlgorithm
```
protected SignatureAlgorithm signatureAlgorithm
```
  - extraInfo
```
protected TokenValidationExtraInfo extraInfo
```
- Constructor Detail
  - Token
```
public Token()
```
- Method Detail
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isTrusted
```
public boolean isTrusted()
```
    Checks if the certificate is provided by the trusted list. For all tokens different from CertificateToken this method always returns false. This method was introduced in order to manage in a uniform manner the different tokens.
    
    Returns:
  - isSelfSigned
```
public boolean isSelfSigned()
```
    Checks if the certificate is self-signed. For all tokens different from CertificateToken this method always returns false. This method was introduced in order to manage in a uniform manner the different tokens.
    
    Returns:
  - getDSSId
```
public TokenIdentifier getDSSId()
```
    Returns a DSS unique token identifier. Used by CertificateToken & TimestampToken.
  - getDSSIdAsString
```
public String getDSSIdAsString()
```
    Returns a string representation of the unique DSS token identifier.
  - getIssuerX500Principal
```
public X500Principal getIssuerX500Principal()
```
    Returns the X500Principal of the certificate which was used to sign this token.
    
    Returns:
  - getIssuerToken
```
public CertificateToken getIssuerToken()
```
    It returns the issuer certificate token that was used to sign this token (CertificateToken, CRLToken, OCSPRespToken, TimestampToken).
    
    Returns:
  - isSignedBy
```
public abstract boolean isSignedBy(CertificateToken issuerToken)
```
    Checks if the token is signed by the token given in the parameter. Each check changes the associated with the token signer's certificate. If the issuerToken is already known, and the current check fail the issuerToken stays unchanged. It is up to the calling function to make sure that the signer's certificate was found.
    
    Parameters:
    issuerToken -
    
    Returns:
  - getValidationInfo
```
public List<String> getValidationInfo()
```
    Returns the additional information gathered during the validation process.
    
    Returns:
  - getAbbreviation
```
public String getAbbreviation()
```
    This method returns the DSS abbreviation of the token. It is used for debugging purpose.
    
    Returns:
  - getSignatureAlgorithm
```
public SignatureAlgorithm getSignatureAlgorithm()
```
    Returns the algorithm that was used to sign the token (ex: SHA1WithRSAEncryption, SHA1withRSA...).
    
    Returns:
  - isSignatureValid
```
public boolean isSignatureValid()
```
    Indicates if the token's signature is intact. For each kind of token the method isSignedBy(CertificateToken) must be called to set this flag. Except if the token is trusted: the signature signature is assumed to be valid.
    
    Returns:
  - extraInfo
```
public TokenValidationExtraInfo extraInfo()
```
    Returns the object managing the validation extra info.
    
    Returns:
  - toString
```
public abstract String toString(String indentStr)
```
    returns a string representation of the token.
    
    Parameters:
    indentStr -
    
    Returns:
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getEncoded
```
public abstract byte[] getEncoded()
```
    Returns the encoded form of the wrapped token.
    
    Returns:
    the encoded form of the wrapped token
  - getDigest
```
public byte[] getDigest(DigestAlgorithm digestAlgorithm)
```
    Returns the digest value of the wrapped token
    
    Parameters:
    digestAlgorithm - the requested digest algorithm
    
    Returns:
    the digest value in binaries

Class Token

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

issuerToken

issuerX500Principal

signatureValid

signatureInvalidityReason

signatureAlgorithm

extraInfo

Constructor Detail

Token

Method Detail

equals

hashCode

isTrusted

isSelfSigned

getDSSId

getDSSIdAsString

getIssuerX500Principal

getIssuerToken

isSignedBy

getValidationInfo

getAbbreviation

getSignatureAlgorithm

isSignatureValid

extraInfo

toString

toString

getEncoded

getDigest