org.digidoc4j

Interface Container

All Superinterfaces:

Serializable

All Known Implementing Classes:

AsicContainer, AsicEContainer, AsicSContainer, BDocContainer, DDocContainer, PadesContainer

public interface Container
extends Serializable

Offers functionality for handling data files and signatures in a container.

A container can contain several files and all those files can be signed using signing certificates. A container can only be signed if it contains data files.

Data files can be added and removed from a container only if the container is not signed. To modify the data list of a signed container by adding or removing datafiles you must first remove all the signatures.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Container.DocumentType Document types

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 is, 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
List<DataFile>	getDataFiles() Returns all data files in the container.
List<Signature>	getSignatures() Returns a list of all signatures in the container.
DataFile	getTimeStampToken() Returns timestamp token
String	getType() Returns container type "BDOC" or "DDOC"
void	removeDataFile(DataFile file) Removes the data file from the container.
void	removeSignature(Signature signature) Removes the signature from the container
void	save(OutputStream out) Saves the container to the java.io.OutputStream.
File	saveAsFile(String filePath) Saves the container to the specified location.
InputStream	saveAsStream() Saves the container as a stream.
void	setTimeStampToken(DataFile timeStampToken) Deprecated. Deprecated for removal
ContainerValidationResult	validate() Validate container

Method Detail

addDataFile

DataFile addDataFile(String path,
                     String mimeType)

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.

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

DataFile addDataFile(InputStream is,
                     String fileName,
                     String mimeType)

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.

Parameters:

is - 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

DataFile addDataFile(File file,
                     String mimeType)

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.

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

void addDataFile(DataFile dataFile)

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.

Parameters:

dataFile - data file to be added to the container

addSignature

void addSignature(Signature signature)

Adds a new signature to the container.

Parameters:

signature - signature to be added.

getDataFiles

List<DataFile> getDataFiles()

Returns all data files in the container.

Returns:

list of all the data files in the container.

getType

String getType()

Returns container type "BDOC" or "DDOC"

Returns:

type

getSignatures

List<Signature> getSignatures()

Returns a list of all signatures in the container.

Returns:

list of all signatures

removeDataFile

void removeDataFile(DataFile file)

Removes the data file from the container.

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

Parameters:

file - data file to be removed from the container.

removeSignature

void removeSignature(Signature signature)

Removes the signature from the container

Parameters:

signature - signature to be removed.

extendSignatureProfile

void extendSignatureProfile(SignatureProfile profile)

Extends signature profile to SignatureProfile

Parameters:

profile - signature profile

See Also:

SignatureProfile

saveAsFile

File saveAsFile(String filePath)

Saves the container to the specified location.

Parameters:

filePath - file name and path.

saveAsStream

InputStream saveAsStream()

Saves the container as a stream.

Returns:

stream of the container.

save

void save(OutputStream out)

Saves the container to the java.io.OutputStream.

Parameters:

out - output stream.

See Also:

OutputStream

validate

ContainerValidationResult validate()

Validate container

Returns:

validation result

setTimeStampToken

@Deprecated
void setTimeStampToken(DataFile timeStampToken)

Deprecated. Deprecated for removal

Adds timestamp token

Parameters:

timeStampToken - timestamp token

getTimeStampToken

DataFile getTimeStampToken()

Returns timestamp token

Returns:

TimestampToken

getConfiguration

Configuration getConfiguration()

Gets Configuration

Returns:

Configuration