SignatureExplorer (restpki-client 1.15.7 API)

java.lang.Object
- com.lacunasoftware.restpki.SignatureExplorer

Direct Known Subclasses:

CadesSignatureExplorer, PadesSignatureExplorer
```
public abstract class SignatureExplorer
extends java.lang.Object
```
Base class for the CadesSignatureExplorer and PadesSignatureExplorer classes.

Field Summary

Fields
Modifier and Type	Field and Description
`protected SignaturePolicyCatalog`	`acceptableExplicitPolicies`
`protected RestPkiClient`	`client`
`protected java.lang.String`	`defaultSignaturePolicyId`
`protected boolean`	`ignoreRevocationStatusUnknown`
`protected java.lang.String`	`securityContextId`
`protected byte[]`	`signatureFileContent`
`protected boolean`	`trustUncertifiedSigningTime`
`protected boolean`	`validate`

Constructor Summary

Constructors
Constructor and Description

SignatureExplorer(RestPkiClient client)

Constructors
Constructor and Description
`SignatureExplorer(RestPkiClient client)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SignaturePolicyCatalog`	`getAcceptableExplicitPolicies()`
`RestPkiClient`	`getClient()`
`java.lang.String`	`getDefaultSignaturePolicyId()`
`protected com.lacunasoftware.restpki.OpenSignatureRequestModel`	`getRequest(java.lang.String fileMimeType)`
`java.lang.String`	`getSecurityContextId()`
`byte[]`	`getSignatureFile()`
`boolean`	`isTrustUncertifiedSigningTime()`
`boolean`	`isValidate()`
`void`	`setAcceptableExplicitPolicies(SignaturePolicyCatalog policyCatalog)` Sets the "catalog" of explicit policies that should be accepted when validating signatures with an explicit validation policy attribute.
`void`	`setClient(RestPkiClient client)`
`void`	`setDefaultSignaturePolicy(SignaturePolicy signaturePolicy)` Sets the default signature policy to be used to validate signatures.
`void`	`setIgnoreRevocationStatusUnknown(boolean ignoreRevocationStatusUnknown)` Sets the option of "IgnoreRevocationStatusUnknown".
`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(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`	`setTrustUncertifiedSigningTime(boolean trustUncertifiedSigningTime)`
`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
```
  - signatureFileContent
```
protected byte[] signatureFileContent
```
  - validate
```
protected boolean validate
```
  - defaultSignaturePolicyId
```
protected java.lang.String defaultSignaturePolicyId
```
  - acceptableExplicitPolicies
```
protected SignaturePolicyCatalog acceptableExplicitPolicies
```
  - securityContextId
```
protected java.lang.String securityContextId
```
  - ignoreRevocationStatusUnknown
```
protected boolean ignoreRevocationStatusUnknown
```
  - trustUncertifiedSigningTime
```
protected boolean trustUncertifiedSigningTime
```
- Constructor Detail
  - SignatureExplorer
```
public SignatureExplorer(RestPkiClient client)
```
- Method Detail
  - getSignatureFile
```
public byte[] getSignatureFile()
```
  - 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(java.lang.String path)
                      throws java.io.IOException
```
    Sets the file path of the signature file to be opened
    
    Parameters:
    
    path - File path of the signature file to be signed.
    
    Throws:
    
    java.io.IOException - if an error occurs while reading the file.
  - setSignatureFile
```
public void setSignatureFile(java.nio.file.Path path)
                      throws java.io.IOException
```
    Sets the file path of the signature file to be opened
    
    Parameters:
    
    path - File path of the signature file to be opened.
    
    Throws:
    
    java.io.IOException - if an error occurs while reading the file.
  - isValidate
```
public boolean isValidate()
```
  - 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
  - getDefaultSignaturePolicyId
```
public java.lang.String getDefaultSignaturePolicyId()
```
  - 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.
  - getAcceptableExplicitPolicies
```
public SignaturePolicyCatalog getAcceptableExplicitPolicies()
```
  - 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())
  - getSecurityContextId
```
public java.lang.String getSecurityContextId()
```
  - 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.
  - getClient
```
public RestPkiClient getClient()
```
  - setClient
```
public void setClient(RestPkiClient client)
```
  - setIgnoreRevocationStatusUnknown
```
public void setIgnoreRevocationStatusUnknown(boolean ignoreRevocationStatusUnknown)
```
    Sets the option of "IgnoreRevocationStatusUnknown".
    
    Parameters:
    
    ignoreRevocationStatusUnknown - The option of "IgnoreRevocationStatusUnknown".
  - isTrustUncertifiedSigningTime
```
public boolean isTrustUncertifiedSigningTime()
```
  - setTrustUncertifiedSigningTime
```
public void setTrustUncertifiedSigningTime(boolean trustUncertifiedSigningTime)
```
  - getRequest
```
protected com.lacunasoftware.restpki.OpenSignatureRequestModel getRequest(java.lang.String fileMimeType)
```

Class SignatureExplorer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

client

signatureFileContent

validate

defaultSignaturePolicyId

acceptableExplicitPolicies

securityContextId

ignoreRevocationStatusUnknown

trustUncertifiedSigningTime

Constructor Detail

SignatureExplorer

Method Detail

getSignatureFile

setSignatureFile

setSignatureFile

setSignatureFile

isValidate

setValidate

getDefaultSignaturePolicyId

setDefaultSignaturePolicy

getAcceptableExplicitPolicies

setAcceptableExplicitPolicies

getSecurityContextId

setSecurityContext

getClient

setClient

setIgnoreRevocationStatusUnknown

isTrustUncertifiedSigningTime

setTrustUncertifiedSigningTime

getRequest