com.lacunasoftware.restpki

Class CadesSignatureExplorer

java.lang.Object

com.lacunasoftware.restpki.SignatureExplorer

com.lacunasoftware.restpki.CadesSignatureExplorer

public class CadesSignatureExplorer
extends SignatureExplorer

Class used to open a CAdES signature file (.p7s file) and optionally validate its signatures.

By default, the signature file is only opened but not validated. In order to validate the file, you must call the method setValidate and also the methods regarding signature policies, which specify the parameters for the validation.

CAdES signature files may or may not have embedded the original file that was signed (the "data file"), which is called having an "encapsulated content". Files with the original file embedded are called "attached signatures", whereas files without it are called "detached signatures". This class supports both kinds of files. However, when opening detached signatures, it is necessary to provide not only the CAdES signature file but also the data file.

Implementation notice: when opening detached signatures, the data file is not uploaded to Rest PKI, only its digest(s), which allows for efficient opening of detached CAdES signatures from very large data files.

Field Summary

Fields inherited from class com.lacunasoftware.restpki.SignatureExplorer

acceptableExplicitPolicies, client, defaultSignaturePolicyId, securityContextId, signatureFileContent, validate

Constructor Summary

Constructors

Constructor and Description
CadesSignatureExplorer(RestPkiClient client)

Method Summary

Modifier and Type	Method and Description
CadesSignature	open() Performs the open signature operation.
void	setDataFile(java.io.InputStream stream) Sets the data file input stream (needed only for signatures without encapsulated content, aka "detached signatures")
void	setDataFile(java.nio.file.Path path) Sets the data file path (needed only for signatures without encapsulated content, aka "detached signatures")
void	setDataFile(java.lang.String path) Sets the data file path (needed only for signatures without encapsulated content, aka "detached signatures")

Methods inherited from class com.lacunasoftware.restpki.SignatureExplorer

getRequest, setAcceptableExplicitPolicies, setDefaultSignaturePolicy, setSecurityContext, setSignatureFile, setSignatureFile, setSignatureFile, setValidate

Methods inherited from class java.lang.Object

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

Constructor Detail

CadesSignatureExplorer

public CadesSignatureExplorer(RestPkiClient client)

Method Detail

setDataFile

public void setDataFile(java.lang.String path)

Sets the data file path (needed only for signatures without encapsulated content, aka "detached signatures")

Parameters:

path - File path of the data file.

setDataFile

public void setDataFile(java.nio.file.Path path)

Sets the data file path (needed only for signatures without encapsulated content, aka "detached signatures")

Parameters:

path - File path of the data file.

setDataFile

public void setDataFile(java.io.InputStream stream)

Sets the data file input stream (needed only for signatures without encapsulated content, aka "detached signatures")

Parameters:

stream - InputStream associated with the data file.

open

public CadesSignature open()
                    throws RestException,
                           java.io.IOException

Performs the open signature operation.

Returns:

information about the signature file.

Throws:

RestException - if an error occurs when calling REST PKI

java.io.IOException