sam.core
Class Settings.Constants

java.lang.Object
  |
  +--sam.core.Settings.Constants

Enclosing class:

Settings

public static class Settings.Constants

extends java.lang.Object

Repository of various constants Changing them does not modify the program semantic but might change its performance/visual behaviour

Nested Class Summary

static class	Settings.Constants.Key Central repository of settings related to cipher keys.
static class	Settings.Constants.UI Repository of settings related to user interfaces.

Field Summary

static boolean	ALLOW_MULTIPLE_MAIL_STOPS Wether the ProgressEvent postmaster(s) can stopped several times.
static boolean	ALWAYS_STARTS_LOG Wether a log reader should always be started statically
static long	ARCHIVE_RESOURCE_INTEGRAL_VALUE The long value returned in case of broken archive.
static boolean	ASK_BEFORE_OVERWRITING_LOCAL_FILES Wether to ask the user for confirmation before overwriting a local file during extraction.
static java.lang.String	BACKSPACE String that erases the previous character when displayed.
static int	BYTE_ARRAY_FILTER_MAXIMUM_BUFFER_LENGTH Maximum length of a ByteArrayFilter buffer
static java.lang.String	CIPHER_WILDCARD Alias to the list of all registered ciphers
static char	COMMAND_LINE_FILE_ALIAS Prefix for file alias command-line argument
static java.lang.String	DEFAULT_TRACE Default output
static boolean	DO_NOT_REENTER_FULLY_SPECIFIED_CIPHERS Wether the cipher/password must not always be rentered by user whenever it is adequately set in command-line.
static int	DUMP_BUFFER_SIZE Size of I/O dump buffers in bytes
static boolean	EARLY_LOG_LEVEL_SETTING Wether to set the log level as soon as it has been parsed from command-line or to wait for the whole command-line to have been parsed ans set it then.
static int	ENTRY_LENGTH_DIGITS Number of digits to be used to report entry length.
static int	FILTER_BLOCK_BUFFER_SIZE Size of byte[] array filters.
static int[]	KNOWN_WAR_SIZES List of all registered WAR ciphers.
static java.lang.String	LOG_INDENTATION Tabulation string to be used to indent log messages according to their depth.
static int	MAIL_POSTMASTER_PRIORITY Scheduling priority of mailbox post agents
static int	MAXIMUM_BLOCK_SIZE The maximum block size in kilobytes
static int	MAXIMUM_LOG_LEVEL The maximum log level
static int	MINIMUM_LOG_LEVEL The minimum log level
static int	MULTI_THREADED_BLOCK_SIZE Block size to be used for parallel I/O computations.
static boolean	NEWLY_REGISTERED_CLASS_IS_AUTOMATICALLY_SET Wether each newly registered class should automatically be set the active class.
static boolean	PARALLELIO_PARANOIAC Wether to add expensive but failsafe tests during parallel I/O operations.
static boolean	PREEXTRACT_DATA Wether to pre-extract data from archive before unstoring.
static long	PROGRESS_ENCODED_GRANULARITY The granularity of encoded data commitment.
static long	PROGRESS_PLAIN_GRANULARITY The granularity of plain data commitment.
static int	RANDOM_GENERATOR_CONSUMER_LIFETIME Lifetime of the random consumer thread.
static java.lang.String	STDERR_NAME Conventionnal file name designating the standard error
static java.lang.String	STDOUT_NAME Conventionnal file name designating the standard output
static boolean	SUPPLIED_CIPHERS_IGNORED_IN_EXTRACTING Wether command-line ciphers are ginored in extracting mode and replaced by those reloaded from archive.
static boolean	WARN_DIFFERENT_GROUP Wether to issue a warning whenever an archive is extracted from a user in a different group than that of the user who created it.
static boolean	WARN_DIFFERENT_USER Wether to issue a warning whenever an archive is extracted from a different user than the one who created it.

Constructor Summary

Settings.Constants()

Methods inherited from class java.lang.Object

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

Field Detail

RANDOM_GENERATOR_CONSUMER_LIFETIME

public static final int RANDOM_GENERATOR_CONSUMER_LIFETIME

Lifetime of the random consumer thread. Valid values are any positive value, or 0 to disable consumer threads.

See Also:

Random, Constant Field Values

BACKSPACE

public static final java.lang.String BACKSPACE

String that erases the previous character when displayed.

See Also:

Constant Field Values

CIPHER_WILDCARD

public static final java.lang.String CIPHER_WILDCARD

Alias to the list of all registered ciphers

See Also:

Constant Field Values

COMMAND_LINE_FILE_ALIAS

public static final char COMMAND_LINE_FILE_ALIAS

Prefix for file alias command-line argument

See Also:

Syntax, SyntaxSet, Constant Field Values

DUMP_BUFFER_SIZE

public static final int DUMP_BUFFER_SIZE

Size of I/O dump buffers in bytes

See Also:

IO, Constant Field Values

FILTER_BLOCK_BUFFER_SIZE

public static final int FILTER_BLOCK_BUFFER_SIZE

Size of byte[] array filters.

See Also:

ByteArrayFilter, Storer, Unstorer, Constant Field Values

MULTI_THREADED_BLOCK_SIZE

public static final int MULTI_THREADED_BLOCK_SIZE

Block size to be used for parallel I/O computations.

See Also:

ParallelIO, Storer, Unstorer, Constant Field Values

PROGRESS_PLAIN_GRANULARITY

public static final long PROGRESS_PLAIN_GRANULARITY

The granularity of plain data commitment.

See Also:

ProgressEventNotifier, Constant Field Values

PROGRESS_ENCODED_GRANULARITY

public static final long PROGRESS_ENCODED_GRANULARITY

The granularity of encoded data commitment.

See Also:

ProgressEventNotifier, Constant Field Values

MAIL_POSTMASTER_PRIORITY

public static final int MAIL_POSTMASTER_PRIORITY

Scheduling priority of mailbox post agents

See Also:

Mailbox, Thread.NORM_PRIORITY, Constant Field Values

ALLOW_MULTIPLE_MAIL_STOPS

public static final boolean ALLOW_MULTIPLE_MAIL_STOPS

Wether the ProgressEvent postmaster(s) can stopped several times. This is safe although computationnally expensive and theoretically useless.

See Also:

Mailbox, Constant Field Values

MINIMUM_LOG_LEVEL

public static final int MINIMUM_LOG_LEVEL

The minimum log level

See Also:

LogInterface, Constant Field Values

MAXIMUM_LOG_LEVEL

public static final int MAXIMUM_LOG_LEVEL

The maximum log level

See Also:

LogInterface, Constant Field Values

EARLY_LOG_LEVEL_SETTING

public static final boolean EARLY_LOG_LEVEL_SETTING

Wether to set the log level as soon as it has been parsed from command-line or to wait for the whole command-line to have been parsed ans set it then.

See Also:

LogInterface, Constant Field Values

LOG_INDENTATION

public static final java.lang.String LOG_INDENTATION

Tabulation string to be used to indent log messages according to their depth.

See Also:

LogInterface, Constant Field Values

ALWAYS_STARTS_LOG

public static final boolean ALWAYS_STARTS_LOG

Wether a log reader should always be started statically

See Also:

LogInterface, Constant Field Values

ARCHIVE_RESOURCE_INTEGRAL_VALUE

public static final long ARCHIVE_RESOURCE_INTEGRAL_VALUE

The long value returned in case of broken archive.

See Also:

ArchiveLayout, Constant Field Values

STDOUT_NAME

public static final java.lang.String STDOUT_NAME

Conventionnal file name designating the standard output

See Also:

Constant Field Values

STDERR_NAME

public static final java.lang.String STDERR_NAME

Conventionnal file name designating the standard error

See Also:

Constant Field Values

DEFAULT_TRACE

public static final java.lang.String DEFAULT_TRACE

Default output

See Also:

Constant Field Values

NEWLY_REGISTERED_CLASS_IS_AUTOMATICALLY_SET

public static final boolean NEWLY_REGISTERED_CLASS_IS_AUTOMATICALLY_SET

Wether each newly registered class should automatically be set the active class.

See Also:

ClassRegistry, Constant Field Values

ENTRY_LENGTH_DIGITS

public static final int ENTRY_LENGTH_DIGITS

Number of digits to be used to report entry length. This sets an upper bound to the largest entry able to be listed (but does not affect other operations like storing or unstoring).

See Also:

Entry.list(sam.rules.ModusOperandi), Constant Field Values

MAXIMUM_BLOCK_SIZE

public static final int MAXIMUM_BLOCK_SIZE

The maximum block size in kilobytes

See Also:

Constant Field Values

DO_NOT_REENTER_FULLY_SPECIFIED_CIPHERS

public static final boolean DO_NOT_REENTER_FULLY_SPECIFIED_CIPHERS

Wether the cipher/password must not always be rentered by user whenever it is adequately set in command-line.

See Also:

Constant Field Values

SUPPLIED_CIPHERS_IGNORED_IN_EXTRACTING

public static final boolean SUPPLIED_CIPHERS_IGNORED_IN_EXTRACTING

Wether command-line ciphers are ginored in extracting mode and replaced by those reloaded from archive. Note that command-line passwords are not dropped, in turn.

Although this is semantically arguable it allows the same "-pciphers:passwords" be used both in archving and in extracting mode.

See Also:

Constant Field Values

PREEXTRACT_DATA

public static final boolean PREEXTRACT_DATA

Wether to pre-extract data from archive before unstoring. This is a bug-fix: the Java API seems to handle inner Zip input streams incorrectly. In particular, due to internal native methods the buffering appears to be skewed, i.e. it does not always read as many bytes as required at each call. Thus it seems necessary to pre-extract ciphered data to a temporary file before handling it.

See Also:

Constant Field Values

KNOWN_WAR_SIZES

public static final int[] KNOWN_WAR_SIZES

List of all registered WAR ciphers. Valid values are any list of non-negative integers. Remember that as the buffer size will be 4 ^ bits this bits value should remain below 16.

See Also:

WarFactory

BYTE_ARRAY_FILTER_MAXIMUM_BUFFER_LENGTH

public static final int BYTE_ARRAY_FILTER_MAXIMUM_BUFFER_LENGTH

Maximum length of a ByteArrayFilter buffer

See Also:

Cipher, Constant Field Values

WARN_DIFFERENT_USER

public static final boolean WARN_DIFFERENT_USER

Wether to issue a warning whenever an archive is extracted from a different user than the one who created it.

See Also:

Constant Field Values

WARN_DIFFERENT_GROUP

public static final boolean WARN_DIFFERENT_GROUP

Wether to issue a warning whenever an archive is extracted from a user in a different group than that of the user who created it.

See Also:

Constant Field Values

ASK_BEFORE_OVERWRITING_LOCAL_FILES

public static final boolean ASK_BEFORE_OVERWRITING_LOCAL_FILES

Wether to ask the user for confirmation before overwriting a local file during extraction.

See Also:

Constant Field Values

PARALLELIO_PARANOIAC

public static final boolean PARALLELIO_PARANOIAC

Wether to add expensive but failsafe tests during parallel I/O operations. This must set if the application is expected to run accross multiple processors and the JVM uses aggressive value caching (Sun's does).

See Also:

Constant Field Values

Constructor Detail

Settings.Constants

public Settings.Constants()