DSSUtils (DSS Service Provider Interface 5.4.d4j.1 API)

java.lang.Object
- eu.europa.esig.dss.DSSUtils

public final class DSSUtils
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_DATE_FORMAT` The default date pattern: "yyyy-MM-dd"
`static String`	`DEFAULT_DATE_TIME_FORMAT`
`static byte[]`	`EMPTY_BYTE_ARRAY`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`available(InputStream is)` Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.
`static byte[]`	`concatenate(byte[]... arrays)` Concatenates all the arrays into a new array.
`static byte[]`	`convertToDER(String pemContent)` This method converts a PEM encoded certificate/crl/...
`static String`	`convertToPEM(CertificateToken cert)` This method converts the given certificate into its PEM string.
`static String`	`decodeUrl(String uri)`
`static byte[]`	`digest(DigestAlgorithm digestAlgorithm, byte[]... data)`
`static byte[]`	`digest(DigestAlgorithm digestAlgorithm, byte[] data)` This method allows to digest the data with the given algorithm.
`static byte[]`	`digest(DigestAlgorithm digestAlgorithm, DSSDocument document)`
`static byte[]`	`digest(DigestAlgorithm digestAlgo, InputStream inputStream)` This method allows to digest the data in the `InputStream` with the given algorithm.
`static boolean`	`fileExists(String path)` This method checks if the file with the given path exists.
`static String`	`formatInternal(Date date)` Formats a date to use for internal purposes (logging, toString)
`static long`	`getDateDiff(Date date1, Date date2, TimeUnit timeUnit)` Gets a difference between two dates
`static String`	`getDeterministicId(Date signingTime, TokenIdentifier id)` Return a unique id for a date and the certificateToken id.
`static File`	`getFile(String filePath)` This method returns a file reference.
`static String`	`getFinalFileName(DSSDocument originalFile, SigningOperation operation, SignatureLevel level)`
`static String`	`getFinalFileName(DSSDocument originalFile, SigningOperation operation, SignatureLevel level, ASiCContainerType containerType)`
`static String`	`getMD5Digest(byte[] bytes)` Returns a Hex encoded of the MD5 digest of binaries
`static MessageDigest`	`getMessageDigest(DigestAlgorithm digestAlgorithm)` Returns a new instance of MessageDigest for a given digest algorithm
`static String`	`getMessageId(String message)` This method return the unique message id which can be used for translation purpose.
`static X500Principal`	`getNormalizedX500Principal(X500Principal x500Principal)` This method normalizes the X500Principal object
`static InputStream`	`getResource(String resourcePath)`
`static String`	`getSHA1Digest(String stringToDigest)` This method digests the given string with SHA1 algorithm and encode returned array of bytes as hex string.
`static String`	`getSummaryMessage(Exception exception, Class<?> javaClass)` This method returns the summary of the given exception.
`static Date`	`getUtcDate(int year, int month, int day)` This method returns an UTC date base on the year, the month and the day.
`static X500Principal`	`getX500PrincipalOrNull(String x500PrincipalString)` This method returns the `X500Principal` corresponding to the given string or `null` if the conversion is not possible.
`static boolean`	`isStartWithASN1SequenceTag(InputStream is)` This method returns true if the inputStream starts with an ASN.1 Sequence
`static CertificateToken`	`loadCertificate(byte[] input)` This method loads a certificate from the byte array.
`static CertificateToken`	`loadCertificate(File file)` This method loads a certificate from the given location.
`static CertificateToken`	`loadCertificate(InputStream inputStream)` This method loads a certificate from the given location.
`static CertificateToken`	`loadCertificate(String path)` This method loads a certificate from the given resource.
`static CertificateToken`	`loadCertificateFromBase64EncodedString(String base64Encoded)` This method loads a certificate from a base 64 encoded String
`static Collection<CertificateToken>`	`loadCertificateFromP7c(InputStream is)`
`static Collection<CertificateToken>`	`loadPotentialIssuerCertificates(CertificateToken cert, DataLoader loader)` This method loads the potential issuer certificate(s) from the given locations (AIA).
`static void`	`printSecurityProviders()` This method lists all defined security providers.
`static byte`	`readFirstByte(DSSDocument dssDocument)` Reads the first byte from the DSSDocument
`static int`	`readToArray(DSSDocument dssDocument, int headerLength, byte[] destinationByteArray)` Reads maximum `headerLength` bytes from `dssDocument` to the given `byte` array.
`static boolean`	`resourceExists(String path)` This method checks if the resource with the given path exists.
`static void`	`saveToFile(byte[] bytes, File file)` This method saves the given array of `byte` to the provided `File`.
`static DSSDocument`	`splitDocument(DSSDocument origin, int start, int end)` This method create a new document from a sub-part of another document
`static byte[]`	`toByteArray(DSSDocument document)` Get the contents of an `DSSDocument` as a `byte[]`.
`static byte[]`	`toByteArray(File file)` FROM: Apache Reads the contents of a file into a byte array.
`static byte[]`	`toByteArray(InputStream inputStream)` Get the contents of an `InputStream` as a `byte[]`.
`static InputStream`	`toByteArrayInputStream(File file)` This method returns an `InputStream` which does not need to be closed, based on `ByteArrayInputStream`.
`protected static int`	`toDigit(char ch, int index)` Converts a hexadecimal character to an integer.
`static FileOutputStream`	`toFileOutputStream(String path)` This method returns a `FileOutputStream` based on the provided path to the file.
`static String`	`toHex(byte[] value)` Converts an array of bytes into a String representing the hexadecimal values of each byte in order.
`static InputStream`	`toInputStream(File file)` This method returns an `InputStream` which needs to be closed, based on `FileInputStream`.
`static InputStream`	`toInputStream(String filePath)` This method returns an `InputStream` which needs to be closed, based on `FileInputStream`.
`static InputStream`	`toInputStream(String string, String charset)` This method returns the `InputStream` based on the given `String` and char set.
`static boolean`	`x500PrincipalAreEquals(X500Principal firstX500Principal, X500Principal secondX500Principal)` This method compares two `X500Principal`s.

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

- Field Detail
  - EMPTY_BYTE_ARRAY
```
public static final byte[] EMPTY_BYTE_ARRAY
```
  - DEFAULT_DATE_TIME_FORMAT
```
public static final String DEFAULT_DATE_TIME_FORMAT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DATE_FORMAT
```
public static final String DEFAULT_DATE_FORMAT
```
    The default date pattern: "yyyy-MM-dd"
    
    See Also:
    
    Constant Field Values
- Method Detail
  - formatInternal
```
public static String formatInternal(Date date)
```
    Formats a date to use for internal purposes (logging, toString)
    
    Parameters:
    
    date - the date to be converted
    
    Returns:
    
    the textual representation (a null date will result in "N/A")
  - toHex
```
public static String toHex(byte[] value)
```
    Converts an array of bytes into a String representing the hexadecimal values of each byte in order. The returned String will be double the length of the passed array, as it takes two characters to represent any given byte. If the input array is null then null is returned. The obtained string is converted to uppercase.
    
    Parameters:
    
    value - the value to be converted to hexadecimal
    
    Returns:
    
    the hexadecimal String
  - toDigit
```
protected static int toDigit(char ch,
                             int index)
                      throws DSSException
```
    Converts a hexadecimal character to an integer.
    
    Parameters:
    
    ch - A character to convert to an integer digit
    
    index - The index of the character in the source
    
    Returns:
    
    An integer
    
    Throws:
    
    DSSException - Thrown if ch is an illegal hex character
  - resourceExists
```
public static boolean resourceExists(String path)
```
    This method checks if the resource with the given path exists.
    
    Parameters:
    
    path -
    
    Returns:
  - fileExists
```
public static boolean fileExists(String path)
```
    This method checks if the file with the given path exists.
    
    Parameters:
    
    path -
    
    Returns:
  - getFile
```
public static File getFile(String filePath)
```
    This method returns a file reference. The file path is normalised (OS independent)
    
    Parameters:
    
    filePath - The path to the file.
    
    Returns:
  - convertToPEM
```
public static String convertToPEM(CertificateToken cert)
```
    This method converts the given certificate into its PEM string.
    
    Parameters:
    
    cert - the token to be converted to PEM
    
    Returns:
    
    PEM encoded certificate
  - isStartWithASN1SequenceTag
```
public static boolean isStartWithASN1SequenceTag(InputStream is)
```
    This method returns true if the inputStream starts with an ASN.1 Sequence
    
    Parameters:
    
    is - the inputstream to be tested
    
    Returns:
    
    true if DER encoded
  - convertToDER
```
public static byte[] convertToDER(String pemContent)
```
    This method converts a PEM encoded certificate/crl/... to DER encoded
    
    Parameters:
    
    pemContent - the String which contains the PEM encoded object
    
    Returns:
    
    the binaries of the DER encoded object
  - loadCertificate
```
public static CertificateToken loadCertificate(String path)
```
    This method loads a certificate from the given resource. The certificate must be DER-encoded and may be supplied in binary or printable (PEM / Base64) encoding. If the certificate is provided in Base64 encoding, it must be bounded at the beginning by -----BEGIN CERTIFICATE-----, and must be bounded at the end by -----END CERTIFICATE-----.
    
    Parameters:
    
    path - resource location.
    
    Returns:
    
    the certificate token
  - loadCertificate
```
public static CertificateToken loadCertificate(File file)
```
    This method loads a certificate from the given location. The certificate must be DER-encoded and may be supplied in binary or printable (PEM / Base64) encoding. If the certificate is provided in Base64 encoding, it must be bounded at the beginning by -----BEGIN CERTIFICATE-----, and must be bounded at the end by -----END CERTIFICATE-----.
    
    Parameters:
    
    file - the file with the certificate
    
    Returns:
    
    the certificate token
  - loadCertificate
```
public static CertificateToken loadCertificate(InputStream inputStream)
```
    This method loads a certificate from the given location. The certificate must be DER-encoded and may be supplied in binary or printable (PEM / Base64) encoding. If the certificate is provided in Base64 encoding, it must be bounded at the beginning by -----BEGIN CERTIFICATE-----, and must be bounded at the end by -----END CERTIFICATE-----.
    
    Parameters:
    
    inputStream - input stream containing the certificate
    
    Returns:
    
    the certificate token
  - loadCertificateFromP7c
```
public static Collection<CertificateToken> loadCertificateFromP7c(InputStream is)
```
  - loadCertificate
```
public static CertificateToken loadCertificate(byte[] input)
```
    This method loads a certificate from the byte array. The certificate must be DER-encoded and may be supplied in binary or printable (Base64) encoding. If the certificate is provided in Base64 encoding, it must be bounded at the beginning by -----BEGIN CERTIFICATE-----, and must be bounded at the end by -----END CERTIFICATE-----. It throws an DSSException or return null when the certificate cannot be loaded.
    
    Parameters:
    
    input - array of bytes containing the certificate
    
    Returns:
    
    the certificate token
  - loadCertificateFromBase64EncodedString
```
public static CertificateToken loadCertificateFromBase64EncodedString(String base64Encoded)
```
    This method loads a certificate from a base 64 encoded String
    
    Parameters:
    
    base64Encoded - the base64 encoded certificate
    
    Returns:
    
    the certificate token
  - loadPotentialIssuerCertificates
```
public static Collection<CertificateToken> loadPotentialIssuerCertificates(CertificateToken cert,
                                                                           DataLoader loader)
```
    This method loads the potential issuer certificate(s) from the given locations (AIA).
    
    Parameters:
    
    cert - certificate for which the issuer(s) should be loaded
    
    loader - the data loader to use
    
    Returns:
    
    a list of potential issuers
  - getSHA1Digest
```
public static String getSHA1Digest(String stringToDigest)
```
    This method digests the given string with SHA1 algorithm and encode returned array of bytes as hex string.
    
    Parameters:
    
    stringToDigest - Everything in the name
    
    Returns:
    
    hex encoded digest value
  - digest
```
public static byte[] digest(DigestAlgorithm digestAlgorithm,
                            byte[] data)
```
    This method allows to digest the data with the given algorithm.
    
    Parameters:
    
    digestAlgorithm - the algorithm to use
    
    data - the data to digest
    
    Returns:
    
    digested array of bytes
  - getMessageDigest
```
public static MessageDigest getMessageDigest(DigestAlgorithm digestAlgorithm)
```
    Returns a new instance of MessageDigest for a given digest algorithm
    
    Parameters:
    
    digestAlgorithm - the digest algoritm
    
    Returns:
    
    a new instance of MessageDigest
  - digest
```
public static byte[] digest(DigestAlgorithm digestAlgo,
                            InputStream inputStream)
```
    This method allows to digest the data in the InputStream with the given algorithm.
    
    Parameters:
    
    digestAlgo - the algorithm to use
    
    inputStream - the data to digest
    
    Returns:
    
    digested array of bytes
  - digest
```
public static byte[] digest(DigestAlgorithm digestAlgorithm,
                            DSSDocument document)
```
  - digest
```
public static byte[] digest(DigestAlgorithm digestAlgorithm,
                            byte[]... data)
```
  - toInputStream
```
public static InputStream toInputStream(String filePath)
                                 throws DSSException
```
    This method returns an InputStream which needs to be closed, based on FileInputStream.
    
    Parameters:
    
    filePath - The path to the file to read
    
    Returns:
    
    an InputStream materialized by a FileInputStream representing the contents of the file
    
    Throws:
    
    DSSException
  - toInputStream
```
public static InputStream toInputStream(File file)
```
    This method returns an InputStream which needs to be closed, based on FileInputStream.
    
    Parameters:
    
    file - File to read.
    
    Returns:
    
    an InputStream materialized by a FileInputStream representing the contents of the file @ if an I/O error occurred
  - toInputStream
```
public static InputStream toInputStream(String string,
                                        String charset)
                                 throws DSSException
```
    This method returns the InputStream based on the given String and char set. This stream does not need to be closed, it is based on ByteArrayInputStream.
    
    Parameters:
    
    string - String to convert
    
    charset - char set to use
    
    Returns:
    
    the InputStream based on ByteArrayInputStream
    
    Throws:
    
    DSSException
  - toFileOutputStream
```
public static FileOutputStream toFileOutputStream(String path)
                                           throws DSSException
```
    This method returns a FileOutputStream based on the provided path to the file.
    
    Parameters:
    
    path - to the file
    
    Returns:
    
    FileOutputStream
    
    Throws:
    
    DSSException
  - toByteArrayInputStream
```
public static InputStream toByteArrayInputStream(File file)
```
    This method returns an InputStream which does not need to be closed, based on ByteArrayInputStream.
    
    Parameters:
    
    file - File to read
    
    Returns:
    
    InputStream based on ByteArrayInputStream
  - toByteArray
```
public static byte[] toByteArray(File file)
```
    FROM: Apache Reads the contents of a file into a byte array. The file is always closed.
    
    Parameters:
    
    file - the file to read, must not be null
    
    Returns:
    
    the file contents, never null
  - splitDocument
```
public static DSSDocument splitDocument(DSSDocument origin,
                                        int start,
                                        int end)
```
    This method create a new document from a sub-part of another document
    
    Parameters:
    
    origin - the original document
    
    start - the start position to retrieve
    
    end - the end position to retrieve
    
    Returns:
    
    a new DSSDocument
  - toByteArray
```
public static byte[] toByteArray(DSSDocument document)
```
    Get the contents of an DSSDocument as a byte[].
    
    Parameters:
    
    document - the document to read
    
    Returns:
    
    the content as byte array
  - toByteArray
```
public static byte[] toByteArray(InputStream inputStream)
```
    Get the contents of an InputStream as a byte[].
    
    Parameters:
    
    inputStream - the inputstream to read
    
    Returns:
    
    the content of the inputstream as byte array
  - saveToFile
```
public static void saveToFile(byte[] bytes,
                              File file)
```
    This method saves the given array of byte to the provided File.
    
    Parameters:
    
    bytes - the binary to save
    
    file - the file where to store
  - getDeterministicId
```
public static String getDeterministicId(Date signingTime,
                                        TokenIdentifier id)
```
    Return a unique id for a date and the certificateToken id.
    
    Parameters:
    
    signingTime - the signing time
    
    id - the token identifier
    
    Returns:
    
    an unique string
  - getMD5Digest
```
public static String getMD5Digest(byte[] bytes)
```
    Returns a Hex encoded of the MD5 digest of binaries
    
    Parameters:
    
    bytes - the bytes to be digested
    
    Returns:
    
    the hex encoded MD5 digest
  - getX500PrincipalOrNull
```
public static X500Principal getX500PrincipalOrNull(String x500PrincipalString)
```
    This method returns the X500Principal corresponding to the given string or null if the conversion is not possible.
    
    Parameters:
    
    x500PrincipalString - a String representation of the X500Principal
    
    Returns:
    
    X500Principal or null
  - x500PrincipalAreEquals
```
public static boolean x500PrincipalAreEquals(X500Principal firstX500Principal,
                                             X500Principal secondX500Principal)
```
    This method compares two X500Principals. X500Principal.CANONICAL and X500Principal.RFC2253 forms are compared.
    
    Parameters:
    
    firstX500Principal - the first X500Principal object to be compared
    
    secondX500Principal - the second X500Principal object to be compared
    
    Returns:
    
    true if the two parameters contain the same key/values
  - getNormalizedX500Principal
```
public static X500Principal getNormalizedX500Principal(X500Principal x500Principal)
```
    This method normalizes the X500Principal object
    
    Parameters:
    
    x500Principal - to be normalized
    
    Returns:
    
    X500Principal normalized
  - getResource
```
public static InputStream getResource(String resourcePath)
```
  - getUtcDate
```
public static Date getUtcDate(int year,
                              int month,
                              int day)
```
    This method returns an UTC date base on the year, the month and the day. The year must be encoded as 1978... and not 78
    
    Parameters:
    
    year - the value used to set the YEAR calendar field.
    
    month - the month. Month value is 0-based. e.g., 0 for January.
    
    day - the value used to set the DAY_OF_MONTH calendar field.
    
    Returns:
    
    the UTC date base on parameters
  - getMessageId
```
public static String getMessageId(String message)
```
    This method return the unique message id which can be used for translation purpose.
    
    Parameters:
    
    message - the String message on which the unique id is calculated.
    
    Returns:
    
    the unique id
  - available
```
public static int available(InputStream is)
                     throws DSSException
```
    Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. The next invocation might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream. IOException if this input stream has been closed by invoking the InputStream.close() method. returns 0.
    
    Returns:
    
    an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream.
    
    Throws:
    
    DSSException - if IOException occurs (if an I/O error occurs)
  - printSecurityProviders
```
public static void printSecurityProviders()
```
    This method lists all defined security providers.
  - getSummaryMessage
```
public static String getSummaryMessage(Exception exception,
                                       Class<?> javaClass)
```
    This method returns the summary of the given exception. The analysis of the stack trace stops when the provided class is found.
    
    Parameters:
    
    exception - Exception to summarize
    
    javaClass - Class
    
    Returns:
    
    String containing the summary message
  - readToArray
```
public static int readToArray(DSSDocument dssDocument,
                              int headerLength,
                              byte[] destinationByteArray)
```
    Reads maximum headerLength bytes from dssDocument to the given byte array.
    
    Parameters:
    
    dssDocument - DSSDocument to read
    
    headerLength - int: maximum number of bytes to read
    
    destinationByteArray - destination byte array
    
    Returns:
    
    the number of read bytes
  - getDateDiff
```
public static long getDateDiff(Date date1,
                               Date date2,
                               TimeUnit timeUnit)
```
    Gets a difference between two dates
    
    Parameters:
    
    date1 - the oldest date
    
    date2 - the newest date
    
    timeUnit - the unit in which you want the diff
    
    Returns:
    
    the difference value, in the provided unit
  - readFirstByte
```
public static byte readFirstByte(DSSDocument dssDocument)
```
    Reads the first byte from the DSSDocument
    
    Parameters:
    
    dssDocument - the document
    
    Returns:
    
    the first byte
  - concatenate
```
public static byte[] concatenate(byte[]... arrays)
```
    Concatenates all the arrays into a new array. The new array contains all of the element of each array followed by all of the elements of the next array. When an array is returned, it is always a new array.
    
    Parameters:
    
    arrays - byte arrays to concatenate
    
    Returns:
    
    the new byte array
  - getFinalFileName
```
public static String getFinalFileName(DSSDocument originalFile,
                                      SigningOperation operation,
                                      SignatureLevel level,
                                      ASiCContainerType containerType)
```
  - getFinalFileName
```
public static String getFinalFileName(DSSDocument originalFile,
                                      SigningOperation operation,
                                      SignatureLevel level)
```
  - decodeUrl
```
public static String decodeUrl(String uri)
```

Class DSSUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_BYTE_ARRAY

DEFAULT_DATE_TIME_FORMAT

DEFAULT_DATE_FORMAT

Method Detail

formatInternal

toHex

toDigit

resourceExists

fileExists

getFile

convertToPEM

isStartWithASN1SequenceTag

convertToDER

loadCertificate

loadCertificate

loadCertificate

loadCertificateFromP7c

loadCertificate

loadCertificateFromBase64EncodedString

loadPotentialIssuerCertificates

getSHA1Digest

digest

getMessageDigest

digest

digest

digest

toInputStream

toInputStream

toInputStream

toFileOutputStream

toByteArrayInputStream

toByteArray

splitDocument

toByteArray

toByteArray

saveToFile

getDeterministicId

getMD5Digest

getX500PrincipalOrNull

x500PrincipalAreEquals

getNormalizedX500Principal

getResource

getUtcDate

getMessageId

available

printSecurityProviders

getSummaryMessage

readToArray

getDateDiff

readFirstByte

concatenate

getFinalFileName

getFinalFileName

decodeUrl