Module jpms_dss_asic_common
Class ASiCContentDocumentFilter
java.lang.Object
eu.europa.esig.dss.asic.common.evidencerecord.ASiCContentDocumentFilter
This class provides a configuration to filter the content of an ASiC container.
Example: the class can be used to define type of documents to be protected by an evidence record
(see
eu.europa.esig.dss.asic.common.evidencerecord.ASiCEvidenceRecordDigestBuilder)
See eu.europa.esig.dss.asic.common.evidencerecord.ASiCContentDocumentFilterFactory class for creating
of pre-configured instances for basic usages-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor instantiating an ASiCContentDocumentFilter object with an empty configuration -
Method Summary
Modifier and TypeMethodDescriptionList<eu.europa.esig.dss.model.DSSDocument> filter(ASiCContent asicContent) Returns a list of filteredDSSDocuments according to the configurationvoidsetArchiveManifestDocuments(boolean archiveManifestDocuments) Sets whether the archive ASiC manifest documents present within a META-INF/ folder shall be returnedvoidsetEvidenceRecordDocuments(boolean evidenceRecordDocuments) Sets whether the evidence record documents present within a META-INF/ folder shall be returnedvoidsetEvidenceRecordManifestDocuments(boolean evidenceRecordManifestDocuments) Sets whether the evidence record manifest documents present within a META-INF/ folder shall be returnedvoidsetExcludedFilenames(Collection<String> excludedFilenames) Sets a collection of document filenames to be excluded from the final return resultvoidsetIncludedFilenames(Collection<String> includedFilenames) Sets a collection of document filenames to be included in the final return result despite other settings.voidsetManifestDocuments(boolean manifestDocuments) Sets whether the ASiC manifest documents present within a META-INF/ folder shall be returnedvoidsetMimetypeDocument(boolean mimetypeDocument) Sets whether the mimetype document present at the root level shall be returnedvoidsetSignatureDocuments(boolean signatureDocuments) Sets whether the signature documents present within a META-INF/ folder shall be returnedvoidsetSignedDocuments(boolean signedDocuments) Sets whether the original signed documents shall be returnedvoidsetTimestampDocuments(boolean timestampDocuments) Sets whether the time-stamp documents present within a META-INF/ folder shall be returnedvoidsetUnsupportedDocuments(boolean unsupportedDocuments) Sets whether other documents not directly supported by EN 319 162-1 specification shall be returned
-
Constructor Details
-
ASiCContentDocumentFilter
public ASiCContentDocumentFilter()Default constructor instantiating an ASiCContentDocumentFilter object with an empty configuration
-
-
Method Details
-
setMimetypeDocument
public void setMimetypeDocument(boolean mimetypeDocument) Sets whether the mimetype document present at the root level shall be returned- Parameters:
mimetypeDocument- whether the mimetype document present at the root level shall be returned
-
setSignedDocuments
public void setSignedDocuments(boolean signedDocuments) Sets whether the original signed documents shall be returned- Parameters:
signedDocuments- whether the original signed documents present at the root level shall be returned
-
setSignatureDocuments
public void setSignatureDocuments(boolean signatureDocuments) Sets whether the signature documents present within a META-INF/ folder shall be returned- Parameters:
signatureDocuments- whether the signature documents present within a META-INF/ folder shall be returned
-
setTimestampDocuments
public void setTimestampDocuments(boolean timestampDocuments) Sets whether the time-stamp documents present within a META-INF/ folder shall be returned- Parameters:
timestampDocuments- whether the time-stamp documents present within a META-INF/ folder shall be returned
-
setEvidenceRecordDocuments
public void setEvidenceRecordDocuments(boolean evidenceRecordDocuments) Sets whether the evidence record documents present within a META-INF/ folder shall be returned- Parameters:
evidenceRecordDocuments- whether the evidence record documents present within a META-INF/ folder shall be returned
-
setManifestDocuments
public void setManifestDocuments(boolean manifestDocuments) Sets whether the ASiC manifest documents present within a META-INF/ folder shall be returned- Parameters:
manifestDocuments- whether the ASiC manifest documents present within a META-INF/ folder shall be returned
-
setArchiveManifestDocuments
public void setArchiveManifestDocuments(boolean archiveManifestDocuments) Sets whether the archive ASiC manifest documents present within a META-INF/ folder shall be returned- Parameters:
archiveManifestDocuments- whether the archive ASiC manifest documents present within a META-INF/ folder shall be returned
-
setEvidenceRecordManifestDocuments
public void setEvidenceRecordManifestDocuments(boolean evidenceRecordManifestDocuments) Sets whether the evidence record manifest documents present within a META-INF/ folder shall be returned- Parameters:
evidenceRecordManifestDocuments- whether the evidence record manifest documents present within a META-INF/ folder shall be returned
-
setUnsupportedDocuments
public void setUnsupportedDocuments(boolean unsupportedDocuments) Sets whether other documents not directly supported by EN 319 162-1 specification shall be returned- Parameters:
unsupportedDocuments- whether other documents not directly supported by EN 319 162-1 specification shall be returned
-
setExcludedFilenames
Sets a collection of document filenames to be excluded from the final return result- Parameters:
excludedFilenames- a collection ofStringdocument filenames to be excluded
-
setIncludedFilenames
Sets a collection of document filenames to be included in the final return result despite other settings. NOTE: take precedence over all other constraints.- Parameters:
includedFilenames- a collection ofStringdocument filenames to be included
-
filter
Returns a list of filteredDSSDocuments according to the configuration- Parameters:
asicContent-ASiCContentrepresenting the ASiC container to get documents from- Returns:
- a list of
DSSDocuments
-