Package eu.europa.esig.dss.asic.xades.signature

Class SimpleASiCWithXAdESFilenameFactory

java.lang.Object

eu.europa.esig.dss.asic.common.AbstractASiCFilenameFactory

eu.europa.esig.dss.asic.xades.signature.DefaultASiCWithXAdESFilenameFactory

eu.europa.esig.dss.asic.xades.signature.SimpleASiCWithXAdESFilenameFactory

All Implemented Interfaces:

ASiCEvidenceRecordFilenameFactory, ASiCFilenameFactory, ASiCWithXAdESFilenameFactory, Serializable

public class SimpleASiCWithXAdESFilenameFactory
extends DefaultASiCWithXAdESFilenameFactory

This class provides a simple way to define custom names for file entries created within an ASiC with XAdES container, by using set and get methods. This factory adds "META-INF/" prefix to the filename, when required. When a target filename for a particular document type is not specified, then the default processing will take precedence. NOTE: This factory shall be modified when consequently signing/extending a single container. WARN: The class does not verify the conformance of the defined filenames to the EN 319 162-1 standard.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SimpleASiCWithXAdESFilenameFactory()	Default constructor instantiating factory with null values

Method Summary

Modifier and Type	Method	Description
String	getDataPackageFilename(ASiCContent asicContent)	Returns a name of a ZIP archive containing signed documents in case of an ASiC-E signature, when applicable
String	getEvidenceRecordManifestFilename(ASiCContent asicContent)	Returns a filename for an evidence record's ASIC manifest file to be created
String	getManifestFilename(ASiCContent asicContent)	Returns a filename of a manifest file to be created
String	getSignatureFilename(ASiCContent asicContent)	Returns a filename for a signature file to be created
protected String	getValidManifestFilename(String manifestFilename, ASiCContent asicContent)	This method returns a valid manifest filename
protected String	getValidSignatureFilename(String signatureFilename, ASiCContent asicContent)	This method returns a valid signature filename
void	setDataPackageFilename(String dataPackageFilename)	Sets a filename for a new ZIP data package (when applicable).
void	setEvidenceRecordManifestFilename(String evidenceRecordManifestFilename)	Sets a new filename for the ASiC evidence record manifest document (when applicable)
void	setManifestFilename(String manifestFilename)	Sets a filename for a new manifest document (when applicable).
void	setSignatureFilename(String signatureFilename)	Sets a filename for a new signature document (when applicable).

Methods inherited from class eu.europa.esig.dss.asic.xades.signature.DefaultASiCWithXAdESFilenameFactory

getEvidenceRecordFilename

Methods inherited from class eu.europa.esig.dss.asic.common.AbstractASiCFilenameFactory

assertASiCContentIsValid, assertFilenameValid, getNextAvailableDocumentName, getValidDataPackageFilename, getValidEvidenceRecordManifestFilename, getWithMetaInfFolder, isAvailableName

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleASiCWithXAdESFilenameFactory

public SimpleASiCWithXAdESFilenameFactory()

Default constructor instantiating factory with null values

Method Details

getSignatureFilename

public String getSignatureFilename(ASiCContent asicContent)

Description copied from interface: ASiCFilenameFactory

Returns a filename for a signature file to be created

Specified by:

getSignatureFilename in interface ASiCFilenameFactory

Overrides:

getSignatureFilename in class DefaultASiCWithXAdESFilenameFactory

Parameters:

asicContent - ASiCContent representing a content of an ASiC container

Returns:

String signature filename

setSignatureFilename

public void setSignatureFilename(String signatureFilename)

Sets a filename for a new signature document (when applicable). NOTE: The name of the signature file shall be: - ASiC-S with XAdES : "META-INF/signatures.xml"; - ASiC-E with XAdES : "META-INF/signatures*.xml"; - OpenDocument : "META-INF/documentsignatures.xml". "META-INF/" is optional.

Parameters:

signatureFilename - String

getManifestFilename

public String getManifestFilename(ASiCContent asicContent)

Description copied from interface: ASiCFilenameFactory

Returns a filename of a manifest file to be created

Specified by:

getManifestFilename in interface ASiCFilenameFactory

Overrides:

getManifestFilename in class DefaultASiCWithXAdESFilenameFactory

Parameters:

asicContent - ASiCContent representing a content of an ASiC container

Returns:

String manifest filename

setManifestFilename

public void setManifestFilename(String manifestFilename)

Sets a filename for a new manifest document (when applicable). NOTE: The name of the manifest file shall be: - ASiC-E with XAdES : "META-INF/manifest.xml". "META-INF/" is optional.

Parameters:

manifestFilename - String

getDataPackageFilename

public String getDataPackageFilename(ASiCContent asicContent)

Description copied from interface: ASiCFilenameFactory

Returns a name of a ZIP archive containing signed documents in case of an ASiC-E signature, when applicable

Specified by:

getDataPackageFilename in interface ASiCFilenameFactory

Overrides:

getDataPackageFilename in class DefaultASiCWithXAdESFilenameFactory

Parameters:

asicContent - ASiCContent representing a content of an ASiC container

Returns:

String data package filename

setDataPackageFilename

public void setDataPackageFilename(String dataPackageFilename)

Sets a filename for a new ZIP data package (when applicable). NOTE: The name of the data package file shall be: - ASiC-S with XAdES : "*.zip".

Parameters:

dataPackageFilename - String

getEvidenceRecordManifestFilename

public String getEvidenceRecordManifestFilename(ASiCContent asicContent)

Description copied from interface: ASiCEvidenceRecordFilenameFactory

Returns a filename for an evidence record's ASIC manifest file to be created

Specified by:

getEvidenceRecordManifestFilename in interface ASiCEvidenceRecordFilenameFactory

Overrides:

getEvidenceRecordManifestFilename in class DefaultASiCWithXAdESFilenameFactory

Parameters:

asicContent - ASiCContent representing a content of an ASiC container

Returns:

String evidence record's manifest filename

setEvidenceRecordManifestFilename

public void setEvidenceRecordManifestFilename(String evidenceRecordManifestFilename)

Sets a new filename for the ASiC evidence record manifest document (when applicable)

Parameters:

evidenceRecordManifestFilename - String

getValidSignatureFilename

protected String getValidSignatureFilename(String signatureFilename,
 ASiCContent asicContent)

This method returns a valid signature filename

Parameters:

signatureFilename - String defined signature filename

asicContent - ASiCContent

Returns:

String signature filename

getValidManifestFilename

protected String getValidManifestFilename(String manifestFilename,
 ASiCContent asicContent)

This method returns a valid manifest filename

Parameters:

manifestFilename - String defined manifest filename

asicContent - ASiCContent

Returns:

String manifest filename