org.digidoc4j.impl.asic

Class AsicContainer

java.lang.Object

org.digidoc4j.impl.asic.AsicContainer

All Implemented Interfaces:

Serializable, Container

Direct Known Subclasses:

AsicEContainer, AsicSContainer

public abstract class AsicContainer
extends Object
implements Container

Created by Andrei on 7.11.2017.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.digidoc4j.Container

Container.DocumentType

Constructor Summary

Constructors

Constructor and Description
AsicContainer(AsicParseResult containerParseResult, Configuration configuration, String containerType) Deprecated. Deprecated for removal. Use AsicContainer(AsicParseResult, Configuration) instead.
AsicContainer(InputStream stream, Configuration configuration, String containerType) Deprecated. Deprecated for removal. Use ContainerOpener.open(InputStream, Configuration) or ContainerBuilder.fromStream(InputStream) instead.
AsicContainer(InputStream stream, String containerType) Deprecated. Deprecated for removal. Use ContainerOpener.open(InputStream, Configuration) or ContainerBuilder.fromStream(InputStream) instead.
AsicContainer(String containerPath, Configuration configuration, String containerType) Deprecated. Deprecated for removal. Use ContainerOpener.open(String, Configuration) or ContainerBuilder.fromExistingFile(String) instead.
AsicContainer(String containerPath, String containerType) Deprecated. Deprecated for removal. Use ContainerOpener.open(String) or ContainerBuilder.fromExistingFile(String) instead.

Method Summary

Modifier and Type	Method and Description
void	addDataFile(DataFile dataFile) Adds a data file from the file system to the container.
DataFile	addDataFile(File file, String mimeType) Adds a data file from the file system to the container.
DataFile	addDataFile(InputStream inputStream, String fileName, String mimeType) Adds a data file from the input stream (i.e.
DataFile	addDataFile(String path, String mimeType) Adds a data file from the file system to the container.
void	addSignature(Signature signature) Adds a new signature to the container.
void	extendSignatureProfile(SignatureProfile profile) Extends signature profile to SignatureProfile
Configuration	getConfiguration() Gets Configuration
AsicParseResult	getContainerParseResult()
List<DataFile>	getDataFiles() Returns all data files in the container.
List<Signature>	getSignatures() Returns a list of all signatures in the container.
String	getType() Returns container type "BDOC" or "DDOC"
boolean	isTimestampTokenDefined() Deprecated. Deprecated for removal
void	removeDataFile(DataFile file) Removes the data file from the container.
void	removeSignature(Signature signature) Removes the signature from the container
File	saveAsFile(String filePath) Saves the container to the specified location.
InputStream	saveAsStream() Saves the container as a stream.
void	setTimeStampToken(DataFile timeStampToken) Deprecated.
void	setType(String containerType) Deprecated. Deprecated for removal. Use appropriate constructor instead.
ContainerValidationResult	validate() Validate container

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.digidoc4j.Container

getTimeStampToken, save

Constructor Detail

AsicContainer

@Deprecated
public AsicContainer(String containerPath,
                                  String containerType)

Deprecated. Deprecated for removal. Use ContainerOpener.open(String) or ContainerBuilder.fromExistingFile(String) instead.

ASicContainer constructor

Parameters:

containerPath - path

containerType - type

AsicContainer

@Deprecated
public AsicContainer(String containerPath,
                                  Configuration configuration,
                                  String containerType)

Deprecated. Deprecated for removal. Use ContainerOpener.open(String, Configuration) or ContainerBuilder.fromExistingFile(String) instead.

ASicContainer constructor

Parameters:

containerPath - path

configuration - configuration

containerType - type

AsicContainer

@Deprecated
public AsicContainer(InputStream stream,
                                  String containerType)

Deprecated. Deprecated for removal. Use ContainerOpener.open(InputStream, Configuration) or ContainerBuilder.fromStream(InputStream) instead.

ASicContainer constructor

Parameters:

stream - input stream

containerType - type

AsicContainer

@Deprecated
public AsicContainer(InputStream stream,
                                  Configuration configuration,
                                  String containerType)

Deprecated. Deprecated for removal. Use ContainerOpener.open(InputStream, Configuration) or ContainerBuilder.fromStream(InputStream) instead.

ASicContainer constructor

Parameters:

stream - input stream

configuration - configuration

containerType - type

AsicContainer

@Deprecated
public AsicContainer(AsicParseResult containerParseResult,
                                  Configuration configuration,
                                  String containerType)

Deprecated. Deprecated for removal. Use AsicContainer(AsicParseResult, Configuration) instead.

ASicContainer constructor

Parameters:

containerParseResult - container parsed result

configuration - configuration

containerType - container type

Method Detail

validate

public ContainerValidationResult validate()

Description copied from interface: Container

Validate container

Specified by:

validate in interface Container

Returns:

validation result

saveAsFile

public File saveAsFile(String filePath)

Description copied from interface: Container

Saves the container to the specified location.

Specified by:

saveAsFile in interface Container

Parameters:

filePath - file name and path.

getConfiguration

public Configuration getConfiguration()

Description copied from interface: Container

Gets Configuration

Specified by:

getConfiguration in interface Container

Returns:

Configuration

saveAsStream

public InputStream saveAsStream()

Description copied from interface: Container

Saves the container as a stream.

Specified by:

saveAsStream in interface Container

Returns:

stream of the container.

setType

@Deprecated
public void setType(String containerType)

Deprecated. Deprecated for removal. Use appropriate constructor instead.

Sets container type.

Parameters:

containerType - container type

getType

public String getType()

Description copied from interface: Container

Returns container type "BDOC" or "DDOC"

Specified by:

getType in interface Container

Returns:

type

getDataFiles

public List<DataFile> getDataFiles()

Description copied from interface: Container

Returns all data files in the container.

Specified by:

getDataFiles in interface Container

Returns:

list of all the data files in the container.

addDataFile

public DataFile addDataFile(String path,
                            String mimeType)

Description copied from interface: Container

Adds a data file from the file system to the container.

Note: Data files can be removed from a container only after all signatures have been removed.

Specified by:

addDataFile in interface Container

Parameters:

path - data file to be added to the container

mimeType - MIME type of the data file, for example 'text/plain' or 'application/msword'

Returns:

data file

addDataFile

public DataFile addDataFile(InputStream inputStream,
                            String fileName,
                            String mimeType)

Description copied from interface: Container

Adds a data file from the input stream (i.e. the date file content can be read from the internal memory buffer).

Note: Data files can be added to a container only after all signatures have been removed.

Specified by:

addDataFile in interface Container

Parameters:

inputStream - input stream from where data is read

fileName - data file name in the container

mimeType - MIME type of the data file, for example 'text/plain' or 'application/msword'

Returns:

data file

addDataFile

public DataFile addDataFile(File file,
                            String mimeType)

Description copied from interface: Container

Adds a data file from the file system to the container.

Note: Data files can be removed from a container only after all signatures have been removed.

Specified by:

addDataFile in interface Container

Parameters:

file - data file to be added to the container

mimeType - MIME type of the data file, for example 'text/plain' or 'application/msword'

Returns:

data file

addDataFile

public void addDataFile(DataFile dataFile)

Description copied from interface: Container

Adds a data file from the file system to the container.

Note: Data files can be removed from a container only after all signatures have been removed.

Specified by:

addDataFile in interface Container

Parameters:

dataFile - data file to be added to the container

addSignature

public void addSignature(Signature signature)

Description copied from interface: Container

Adds a new signature to the container.

Specified by:

addSignature in interface Container

Parameters:

signature - signature to be added.

setTimeStampToken

@Deprecated
public void setTimeStampToken(DataFile timeStampToken)

Deprecated.

Set timestamp token to container

Specified by:

setTimeStampToken in interface Container

Parameters:

timeStampToken -

isTimestampTokenDefined

@Deprecated
public boolean isTimestampTokenDefined()

Deprecated. Deprecated for removal

Checks if timestamp token is defined

Returns:

true if timestamp token is defined, otherwise false

extendSignatureProfile

public void extendSignatureProfile(SignatureProfile profile)

Description copied from interface: Container

Extends signature profile to SignatureProfile

Specified by:

extendSignatureProfile in interface Container

Parameters:

profile - signature profile

See Also:

SignatureProfile

removeSignature

public void removeSignature(Signature signature)

Description copied from interface: Container

Removes the signature from the container

Specified by:

removeSignature in interface Container

Parameters:

signature - signature to be removed.

removeDataFile

public void removeDataFile(DataFile file)

Description copied from interface: Container

Removes the data file from the container.

Note: Data files can be removed from a container only after all signatures have been removed.

Specified by:

removeDataFile in interface Container

Parameters:

file - data file to be removed from the container.

getSignatures

public List<Signature> getSignatures()

Description copied from interface: Container

Returns a list of all signatures in the container.

Specified by:

getSignatures in interface Container

Returns:

list of all signatures

getContainerParseResult

public AsicParseResult getContainerParseResult()