com.lacunasoftware.restpki

Class SignatureExplorer2

java.lang.Object

com.lacunasoftware.restpki.SignatureExplorer2

Direct Known Subclasses:

CadesSignatureExplorer2, PadesSignatureExplorer2, XmlSignatureExplorer

public abstract class SignatureExplorer2
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected SignaturePolicyCatalog	acceptableExplicitPolicies
protected RestPkiClient	client
protected java.lang.String	defaultSignaturePolicyId
protected java.lang.String	securityContextId
protected boolean	validate

Constructor Summary

Constructors

Constructor and Description
SignatureExplorer2(RestPkiClient client) Create a new instance using the given RestPkiClient.

Method Summary

Modifier and Type	Method and Description
protected com.lacunasoftware.restpki.OpenSignatureRequestModel	fillRequest(com.lacunasoftware.restpki.OpenSignatureRequestModel request)
void	setAcceptableExplicitPolicies(SignaturePolicyCatalog policyCatalog) Sets the "catalog" of explicit policies that should be accepted when validating signatures with an explicit validation policy attribute.
void	setDefaultSignaturePolicy(SignaturePolicy signaturePolicy) Sets the default signature policy to be used to validate signatures.
void	setSecurityContext(SecurityContext securityContext) Sets the security context to be used to validate the signatures.
void	setSignatureFile(byte[] content) Sets the signature file to be opened
void	setSignatureFile(FileResult fileResult) Sets the signature to be signed from a file result from a previous call to Rest PKI
void	setSignatureFile(java.io.InputStream stream) Sets the PDF to be signed via a stream object
void	setSignatureFile(java.nio.file.Path path) Sets the file path of the signature file to be opened
void	setSignatureFile(java.lang.String path) Sets the file path of the signature file to be opened
void	setValidate(boolean validate) Sets whether the signature file should be validated or just opened

Methods inherited from class java.lang.Object

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

Field Detail

client

protected RestPkiClient client

validate

protected boolean validate

securityContextId

protected java.lang.String securityContextId

defaultSignaturePolicyId

protected java.lang.String defaultSignaturePolicyId

acceptableExplicitPolicies

protected SignaturePolicyCatalog acceptableExplicitPolicies

Constructor Detail

SignatureExplorer2

public SignatureExplorer2(RestPkiClient client)

Create a new instance using the given RestPkiClient.

Parameters:

client - the RestPkiClient which shall be used.

Method Detail

setSignatureFile

public void setSignatureFile(java.lang.String path)

Sets the file path of the signature file to be opened

Parameters:

path - File path of the signature file to be signed.

setSignatureFile

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

Sets the file path of the signature file to be opened

Parameters:

path - File path of the signature file to be opened.

setSignatureFile

public void setSignatureFile(java.io.InputStream stream)

Sets the PDF to be signed via a stream object

Parameters:

stream - a pre-opened InputStream linked to the PDF that will be signed. The stream is NOT closed by this method.

setSignatureFile

public void setSignatureFile(byte[] content)

Sets the signature file to be opened

Parameters:

content - Binary content of the signature file

setSignatureFile

public void setSignatureFile(FileResult fileResult)

Sets the signature to be signed from a file result from a previous call to Rest PKI

Parameters:

fileResult - FileResult from previous call to Rest PKI

setValidate

public void setValidate(boolean validate)

Sets whether the signature file should be validated or just opened

Parameters:

validate - Whether to validate the signature file or not

setDefaultSignaturePolicy

public void setDefaultSignaturePolicy(SignaturePolicy signaturePolicy)

Sets the default signature policy to be used to validate signatures. This value is used to validate signatures without an explicit validation policy attribute and also signatures with an explicit validation policy attribute that is not among the policies specified in AcceptableExplicitPolicies. In order to accept only a certain list of explicit policies, this value should be omitted.

Parameters:

signaturePolicy - The default signature policy for validation. Depending on the policy, it might also be necessary to set a security context.

setAcceptableExplicitPolicies

public void setAcceptableExplicitPolicies(SignaturePolicyCatalog policyCatalog)

Sets the "catalog" of explicit policies that should be accepted when validating signatures with an explicit validation policy attribute. If a signature being validated has an explicit validation policy attribute which is not among the values passed, then the default signature policy is used (specified with the setDefaultSignaturePolicy method). In order to accept only the given catalog of explicit policies, don't set a default policy.

Parameters:

policyCatalog - The signature policy catalog (for instance, SignaturePolicyCatalog.getPkiBrazilCades() or SignaturePolicyCatalog.getPkiBrazilPades())

setSecurityContext

public void setSecurityContext(SecurityContext securityContext)

Sets the security context to be used to validate the signatures. Depending on the signature policies passed on the methods setAcceptableExplicitPolicies and setDefaultSignaturePolicy, this may be mandatory. If a signature policy does not require a security context to be set but one is nevertheless passed, the given security context overrides the one that would otherwise be inferred from the policy.

Parameters:

securityContext - The security context to be used to validate the signatures on the signature file.

fillRequest

protected com.lacunasoftware.restpki.OpenSignatureRequestModel fillRequest(com.lacunasoftware.restpki.OpenSignatureRequestModel request)
                                                                    throws RestException,
                                                                           java.io.IOException

Throws:

RestException

java.io.IOException