ee.ria.DigiDoc.crypto

Class CryptoContainer

java.lang.Object

ee.ria.DigiDoc.crypto.CryptoContainer

public abstract class CryptoContainer
extends java.lang.Object

Handles working with CDOC containers.

See Also:

Parse existing containers., Create new containers., Decrypt existing containers.

Constructor Summary

Constructors

Constructor and Description
CryptoContainer()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	createContainerFileName(java.lang.String fileName) Create a CDOC container file name based on some other file name.
abstract com.google.common.collect.ImmutableList<java.io.File>	dataFiles() List of data files.
CryptoContainer	decrypt(DecryptToken decryptToken, Certificate authCertificate, java.lang.String pin1, java.io.File dataFilesDirectory) Decrypt the container.
abstract boolean	decrypted() Whether this container is decrypted.
static CryptoContainer	encrypt(com.google.common.collect.ImmutableList<java.io.File> dataFiles, com.google.common.collect.ImmutableList<Certificate> recipients, java.io.File file) Create a new crypto container with provided data files and recipients.
abstract java.io.File	file() Location of the container.
static boolean	isContainerFileName(java.lang.String fileName) Checks whether the name is a CDOC container file name by extension.
static CryptoContainer	open(java.io.File file) Open an existing CDOC file.
abstract com.google.common.collect.ImmutableList<Certificate>	recipients() List of recipients.

Methods inherited from class java.lang.Object

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

Constructor Detail

CryptoContainer

public CryptoContainer()

Method Detail

file

public abstract java.io.File file()

Location of the container.

dataFiles

public abstract com.google.common.collect.ImmutableList<java.io.File> dataFiles()

List of data files. When decrypted() is true then it's an absolute path to the file, otherwise only data file name is present.

recipients

public abstract com.google.common.collect.ImmutableList<Certificate> recipients()

List of recipients.

decrypted

public abstract boolean decrypted()

Whether this container is decrypted. When decrypted the data files are with absolute paths.

decrypt

public CryptoContainer decrypt(DecryptToken decryptToken,
                               Certificate authCertificate,
                               java.lang.String pin1,
                               java.io.File dataFilesDirectory)
                        throws CryptoException

Decrypt the container.

Parameters:

decryptToken - Token used to decrypt.

authCertificate - Authentication certificate.

pin1 - PIN1 for the authentication certificate.

dataFilesDirectory - Directory where the data files are saved.

Returns:

Decrypted container.

Throws:

Pin1InvalidException - When PIN1 is incorrect.

CertificateNotRecipientException - When provided certificate is not in recipients list.

CryptoException - When decryption fails.

open

@WorkerThread
public static CryptoContainer open(java.io.File file)
                                          throws CryptoException

Open an existing CDOC file.

Parameters:

file - Path to the file.

Returns:

Container object.

Throws:

CryptoException - When opening or parsing the container file fails.

encrypt

@WorkerThread
public static CryptoContainer encrypt(com.google.common.collect.ImmutableList<java.io.File> dataFiles,
                                                    com.google.common.collect.ImmutableList<Certificate> recipients,
                                                    java.io.File file)
                                             throws CryptoException

Create a new crypto container with provided data files and recipients.

Parameters:

dataFiles - Data files.

recipients - Recipients.

file - Path to the created crypto container file.

Returns:

Container object.

Throws:

DataFilesEmptyException - When no data files provided.

RecipientsEmptyException - When no recipients provided.

CryptoException - When something failed with encryption.

isContainerFileName

public static boolean isContainerFileName(java.lang.String fileName)

Checks whether the name is a CDOC container file name by extension.

Parameters:

fileName - File name to check.

Returns:

True if valid container file name.

createContainerFileName

public static java.lang.String createContainerFileName(java.lang.String fileName)

Create a CDOC container file name based on some other file name.

Parameters:

fileName - Some other file name.

Returns:

Valid container file name.