com.entrust.toolkit.archive

Class LargeFileOptions

java.lang.Object

com.entrust.toolkit.archive.LargeFileOptions

public class LargeFileOptions
extends java.lang.Object

This class provides the information necessary to allow large files to be protected using Entrust Archive format.

Due to limitations of the Entrust Archive format, it is not possible to stream the processing of the file being protected. This means that, when protecting a file using Entrust Archive format (via ArchiveCreator), the data contained in the input file must be buffered internally. By default, ArchiveCreator, simply buffers the data to memory. This limits the amount of data than can be processed (input file size) to slightly less than half of the maximum available memory.

However, instead of buffering all data to memory, it is possible to buffer a portion of the data to memory and the remainder to a series of temporary files. This reduces the memory requirements during Entrust Archive format creation, and allows large files to be protected using Entrust Archive format.

To protect a large file using Entrust Archive format, an instance of this class must be provided to the constructor of ArchiveCreator. This object will provide all the necessary information (options); each option is described below:

• Memory Size MB
  

  The amount of memory storage in MBs; this amount of data will be buffered to memory before temporary files are used (REQUIRED: when less than 1MB, data is not buffered to memory).

• Storage File Size MB
  

  The size of the temporary storage files in MBs; each temporary storage file that is created to buffer data will not exceed this size (REQUIRED: must be at least 1MB).

• Storage Directory
  

  The directory where all temporary storage files will be written (OPTIONAL: when not set, the default temporary-file directory is automatically used, which is specified by the system property java.io.tmpdir).

• Storage File Prefix
  

  The prefix string to be used in generating the storage file names; the name of each storage file name will begin with this value (REQUIRED: must be at least 3 characters long).

• Storage File Suffix
  

  The suffix string to be used in generating the storage file names; the name of each storage file name will end with this value (OPTIONAL: when not set, '.tmp' is automatically used).

For the options that are OPTIONAL, these values can be set to null, in which case default values will automatically be used.

Note:

Temporary files used during the Entrust Archive creation process are automatically deleted once the process completes.

Limitation:

Entrust Archive format cannot be used to protect files larger than 4GB; this is because Entrust Archive format uses a 32-bit value to represent the data size (2³² = 4GB).

Since:

7.1 Patch

See Also:

ArchiveCreator

Constructor Summary

Constructors

Constructor and Description
LargeFileOptions() Creates a new set of Entrust Archive large file options from default option values.
LargeFileOptions(int memorySizeMB, int storageFileSizeMB, java.io.File storageDirectory, java.lang.String storageFilePrefix, java.lang.String storageFileSuffix) Creates a new set of Entrust Archive large file options from user supplied option values.

Method Summary

Methods

Modifier and Type	Method and Description
int	getMemorySizeMB() Returns the amount of memory storage in MBs.
java.io.File	getStorageDirectory() Gets the directory where all temporary storage files will be written.
java.lang.String	getStorageFilePrefix() Returns the file name prefix used when creating temporary storage files.
int	getStorageFileSizeMB() Returns the size of the temporary storage files in MBs; each storage file created will not exceed this size.
java.lang.String	getStorageFileSuffix() Returns the file name suffix used when creating temporary storage files.
void	setMemorySizeMB(int memorySizeMB) Sets the amount of memory storage in MBs.
void	setStorageDirectory(java.io.File storageDirectory) Sets the directory where all temporary storage files will be written.
void	setStorageFilePrefix(java.lang.String storageFilePrefix) Sets the file name prefix used when creating temporary storage files.
void	setStorageFileSizeMB(int storageFileSizeMB) Sets the size of the temporary storage files in MBs; each storage file created will not exceed this size.
void	setStorageFileSuffix(java.lang.String storageFileSuffix) Sets the file name suffix used when creating temporary storage files.

Methods inherited from class java.lang.Object

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

Constructor Detail

LargeFileOptions

public LargeFileOptions()

Creates a new set of Entrust Archive large file options from default option values.

The following default values are used for the required options:

• Memory Size MB: 16MB
• Storage File Size MB: 1024 (1GB)
• Storage File Prefix: "EntArchive"

LargeFileOptions

public LargeFileOptions(int memorySizeMB,
                int storageFileSizeMB,
                java.io.File storageDirectory,
                java.lang.String storageFilePrefix,
                java.lang.String storageFileSuffix)

Creates a new set of Entrust Archive large file options from user supplied option values.

Parameters:

memorySizeMB - the amount of memory storage in MBs; when less than 1MB, memory storage is not used

storageFileSizeMB - the size of the temporary storage files in MBs; must be at least 1MB

storageDirectory - the directory where all storage files will be written, or null if the default temporary-file directory is to be used (OPTIONAL)

storageFilePrefix - the prefix string to be used in generating the storage file names; must be at least three characters long

storageFileSuffix - the suffix string to be used in generating the storage file names; may be null, in which case the suffix ".tmp" (OPTIONAL)

Method Detail

getMemorySizeMB

public int getMemorySizeMB()

Returns the amount of memory storage in MBs.

Returns:

the amount of memory storage in MBs

setMemorySizeMB

public void setMemorySizeMB(int memorySizeMB)

Sets the amount of memory storage in MBs.

Parameters:

memorySizeMB - the amount of memory storage in MBs; when less than 1MB, memory storage is not used

Throws:

java.lang.IllegalArgumentException - if the memory storage size exceeds the maximum available or maximum addressable memory

getStorageFileSizeMB

public int getStorageFileSizeMB()

Returns the size of the temporary storage files in MBs; each storage file created will not exceed this size.

Returns:

the size of the temporary storage files in MBs

setStorageFileSizeMB

public void setStorageFileSizeMB(int storageFileSizeMB)

Sets the size of the temporary storage files in MBs; each storage file created will not exceed this size.

Parameters:

storageFileSizeMB - the size of the temporary storage files in MBs

Throws:

java.lang.IllegalArgumentException - if the temporary storage file size is less than 1MB

getStorageDirectory

public java.io.File getStorageDirectory()

Gets the directory where all temporary storage files will be written.

Returns:

the directory where all temporary storage files will be written, or null if not set

setStorageDirectory

public void setStorageDirectory(java.io.File storageDirectory)

Sets the directory where all temporary storage files will be written.

Parameters:

storageDirectory - the directory where all temporary storage files will be written, or null if the default temporary-file directory is to be used (OPTIONAL)

Throws:

java.lang.IllegalArgumentException - if the directory where temporary storage files will be written does not represent a directory on the system, or does not permit write operations

getStorageFilePrefix

public java.lang.String getStorageFilePrefix()

Returns the file name prefix used when creating temporary storage files.

Returns:

the file name prefix used when creating temporary storage files

setStorageFilePrefix

public void setStorageFilePrefix(java.lang.String storageFilePrefix)

Sets the file name prefix used when creating temporary storage files.

Parameters:

storageFilePrefix - the file name prefix used when creating temporary storage files

Throws:

java.lang.IllegalArgumentException - if the storage file prefix is null or less than three characters

getStorageFileSuffix

public java.lang.String getStorageFileSuffix()

Returns the file name suffix used when creating temporary storage files.

Returns:

the file name suffix used when creating temporary storage files (OPTIONAL)

setStorageFileSuffix

public void setStorageFileSuffix(java.lang.String storageFileSuffix)

Sets the file name suffix used when creating temporary storage files.

Parameters:

storageFileSuffix - the file name suffix used when creating temporary storage files, or null if not set