no.difi.asic.extras

Class CmsEncryptedAsicWriter

java.lang.Object

no.difi.asic.extras.CmsEncryptedAsicWriter

All Implemented Interfaces:

AsicWriter

public class CmsEncryptedAsicWriter
extends Object
implements AsicWriter

Wrapper to seamlessly encode specific files.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	BC

Constructor Summary

Constructors

Constructor and Description
CmsEncryptedAsicWriter(AsicWriter asicWriter, X509Certificate certificate)
CmsEncryptedAsicWriter(AsicWriter asicWriter, X509Certificate certificate, org.bouncycastle.asn1.ASN1ObjectIdentifier cmsAlgorithm)

Method Summary

Modifier and Type	Method and Description
AsicWriter	add(File file) Adds another data object to the ASiC archive.
AsicWriter	add(File file, String entryName) Adds another data object to the ASiC container, using the supplied name as the zip entry name
AsicWriter	add(File file, String entryName, MimeType mimeType) Adds the contents of a file into the ASiC archive using the supplied entry name and MIME type.
AsicWriter	add(InputStream inputStream, String filename) Adds the data provided by the stream into the ASiC archive, using the name of the supplied file as the entry name.
AsicWriter	add(InputStream inputStream, String filename, MimeType mimeType) Adds the contents of an input stream into the ASiC archive, under a given entry name and explicitly identifying the MIME type.
AsicWriter	add(Path path) Adds another data object to the ASiC archive
AsicWriter	add(Path path, String entryName) Adds another data object to the ASiC container under the entry name provided.
AsicWriter	add(Path path, String entryName, MimeType mimeType)
AsicWriter	addEncrypted(File file)
AsicWriter	addEncrypted(File file, String entryName)
AsicWriter	addEncrypted(File file, String entryName, MimeType mimeType)
AsicWriter	addEncrypted(InputStream inputStream, String filename)
AsicWriter	addEncrypted(InputStream inputStream, String filename, MimeType mimeType)
AsicWriter	addEncrypted(Path path)
AsicWriter	addEncrypted(Path path, String entryName)
AsicWriter	addEncrypted(Path path, String entryName, MimeType mimeType)
AsicWriter	setRootEntryName(String name) Specifies which entry (file) represents the "root" document, i.e.
AsicWriter	sign(File keyStoreFile, String keyStorePassword, String keyPassword) Signs and closes the ASiC archive.
AsicWriter	sign(File keyStoreFile, String keyStorePassword, String keyAlias, String keyPassword) Signs and closes the ASiC archive using the private and public key stored in the supplied key store under the supplied alias name.
AsicWriter	sign(SignatureHelper signatureHelper) Allows re-use of the same SignatureHelper object when creating multiple ASiC archive and hence the need to create multiple signatures.

Methods inherited from class java.lang.Object

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

Field Detail

BC

protected static final String BC

See Also:

Constant Field Values

Constructor Detail

CmsEncryptedAsicWriter

public CmsEncryptedAsicWriter(AsicWriter asicWriter,
                              X509Certificate certificate)

CmsEncryptedAsicWriter

public CmsEncryptedAsicWriter(AsicWriter asicWriter,
                              X509Certificate certificate,
                              org.bouncycastle.asn1.ASN1ObjectIdentifier cmsAlgorithm)

Method Detail

add

public AsicWriter add(File file)
               throws IOException

Adds another data object to the ASiC archive.

Specified by:

add in interface AsicWriter

Parameters:

file - references the file to be added as a data object. The name of the entry is extracted from the File object.

Returns:

reference to this AsicWriter

Throws:

IOException

add

public AsicWriter add(File file,
                      String entryName)
               throws IOException

Adds another data object to the ASiC container, using the supplied name as the zip entry name

Specified by:

add in interface AsicWriter

Parameters:

file - references the file to be added as a data object.

entryName - the archive entry name to be used.

Returns:

reference to this AsicWriter

Throws:

IOException

add

public AsicWriter add(Path path)
               throws IOException

Adds another data object to the ASiC archive

Specified by:

add in interface AsicWriter

Parameters:

path - references the file to be added.

Returns:

reference to this AsicWriter

Throws:

IOException

See Also:

AsicWriter.add(File)

add

public AsicWriter add(Path path,
                      String entryName)
               throws IOException

Adds another data object to the ASiC container under the entry name provided.

Specified by:

add in interface AsicWriter

Parameters:

path - reference to this AsicWriter.

entryName - the archive entry name to be used.

Returns:

reference to this AsicWriter

Throws:

IOException

See Also:

AsicWriter.add(File, String)

add

public AsicWriter add(InputStream inputStream,
                      String filename)
               throws IOException

Adds the data provided by the stream into the ASiC archive, using the name of the supplied file as the entry name.

Specified by:

add in interface AsicWriter

Parameters:

inputStream - input stream of data.

filename - the name of a file, which must be available in the file system in order to determine the MIME type.

Returns:

reference to this AsicWriter

Throws:

IOException

add

public AsicWriter add(File file,
                      String entryName,
                      MimeType mimeType)
               throws IOException

Adds the contents of a file into the ASiC archive using the supplied entry name and MIME type.

Specified by:

add in interface AsicWriter

Parameters:

file - references the file to be added as a data object.

entryName - the archive entry name to be used.

mimeType - explicitly identifies the MIME type of the entry.

Returns:

reference to this AsicWriter

Throws:

IOException

add

public AsicWriter add(Path path,
                      String entryName,
                      MimeType mimeType)
               throws IOException

Specified by:

add in interface AsicWriter

Throws:

IOException

See Also:

AsicWriter.add(File, String, MimeType)

add

public AsicWriter add(InputStream inputStream,
                      String filename,
                      MimeType mimeType)
               throws IOException

Adds the contents of an input stream into the ASiC archive, under a given entry name and explicitly identifying the MIME type.

Specified by:

add in interface AsicWriter

Throws:

IOException

See Also:

AsicWriter.add(Path, String, MimeType)

addEncrypted

public AsicWriter addEncrypted(File file)
                        throws IOException

Throws:

IOException

addEncrypted

public AsicWriter addEncrypted(File file,
                               String entryName)
                        throws IOException

Throws:

IOException

addEncrypted

public AsicWriter addEncrypted(Path path)
                        throws IOException

Throws:

IOException

addEncrypted

public AsicWriter addEncrypted(Path path,
                               String entryName)
                        throws IOException

Throws:

IOException

addEncrypted

public AsicWriter addEncrypted(InputStream inputStream,
                               String filename)
                        throws IOException

Throws:

IOException

addEncrypted

public AsicWriter addEncrypted(File file,
                               String entryName,
                               MimeType mimeType)
                        throws IOException

Throws:

IOException

addEncrypted

public AsicWriter addEncrypted(Path path,
                               String entryName,
                               MimeType mimeType)
                        throws IOException

Throws:

IOException

addEncrypted

public AsicWriter addEncrypted(InputStream inputStream,
                               String filename,
                               MimeType mimeType)
                        throws IOException

Throws:

IOException

setRootEntryName

public AsicWriter setRootEntryName(String name)

Description copied from interface: AsicWriter

Specifies which entry (file) represents the "root" document, i.e. which business document to read first.

Specified by:

setRootEntryName in interface AsicWriter

Parameters:

name - of entry holding the root document.

Returns:

reference to this AsicWriter

sign

public AsicWriter sign(File keyStoreFile,
                       String keyStorePassword,
                       String keyPassword)
                throws IOException

Description copied from interface: AsicWriter

Signs and closes the ASiC archive. The private and public key is obtained from the supplied key store.

Specified by:

sign in interface AsicWriter

Parameters:

keyStoreFile - the file holding the JKS keystore file.

keyStorePassword - password for the keystore

keyPassword - password protecting the private key.

Returns:

reference to this AsicWriter

Throws:

IOException

sign

public AsicWriter sign(File keyStoreFile,
                       String keyStorePassword,
                       String keyAlias,
                       String keyPassword)
                throws IOException

Description copied from interface: AsicWriter

Signs and closes the ASiC archive using the private and public key stored in the supplied key store under the supplied alias name.

Specified by:

sign in interface AsicWriter

Parameters:

keyStoreFile - the file holding the JKS keystore file.

keyStorePassword - password for the keystore

keyAlias - the alias of the keystore entry holding the private and the public key.

keyPassword - password protecting the private key.

Returns:

reference to this AsicWriter

Throws:

IOException

sign

public AsicWriter sign(SignatureHelper signatureHelper)
                throws IOException

Description copied from interface: AsicWriter

Allows re-use of the same SignatureHelper object when creating multiple ASiC archive and hence the need to create multiple signatures.

Specified by:

sign in interface AsicWriter

Parameters:

signatureHelper - instantiated SignatureHelper

Returns:

reference to this AsicWriter

Throws:

IOException

See Also:

AsicWriter.sign(File, String, String, String)