public static final class Archive.Configuration extends Object
Details for the individual parameters can be found in the Javadoc for the Archive.Context setters.
| Modifier and Type | Field and Description |
|---|---|
static int |
ARCHIVE_CONTROL_SESSIONS_TYPE_ID
The type id of the
Counter used for keeping track of the count of concurrent control sessions. |
static String |
ARCHIVE_DIR_DEFAULT
Default directory for the archive files.
|
static String |
ARCHIVE_DIR_DELETE_ON_START_PROP_NAME
Should the archive delete existing files on start.
|
static String |
ARCHIVE_DIR_PROP_NAME
Directory in which the archive stores it files such as the catalog and recordings.
|
static int |
ARCHIVE_ERROR_COUNT_TYPE_ID
The type id of the
Counter used for keeping track of the number of errors that have occurred. |
static String |
ARCHIVE_IDLE_STRATEGY_PROP_NAME
Default
IdleStrategy to be used for the archive Agents when not busy. |
static String |
ARCHIVE_RECORDER_IDLE_STRATEGY_PROP_NAME
The
IdleStrategy to be used for the archive recorder Agent when not busy. |
static String |
ARCHIVE_REPLAYER_IDLE_STRATEGY_PROP_NAME
The
IdleStrategy to be used for the archive replayer Agent when not busy. |
static String |
AUTHENTICATOR_SUPPLIER_DEFAULT
Name of the class to use as a supplier of
Authenticator for the archive. |
static String |
AUTHENTICATOR_SUPPLIER_PROP_NAME
Name of class to use as a supplier of
Authenticator for the archive. |
static long |
CATALOG_CAPACITY_DEFAULT
Default capacity in bytes for the
Catalog. |
static String |
CATALOG_CAPACITY_PROP_NAME
Default capacity in bytes of the archive
Catalog. |
static int |
CATALOG_FILE_SYNC_LEVEL_DEFAULT
Default is to use normal file writes which may mean some data loss in the event of a power failure.
|
static String |
CATALOG_FILE_SYNC_LEVEL_PROP_NAME
The level at which catalog updates and directory should be sync'ed to disk.
|
static long |
CONNECT_TIMEOUT_DEFAULT_NS
Default timeout for connecting back to a client for a control session or replay.
|
static String |
CONNECT_TIMEOUT_PROP_NAME
Timeout for making a connection back to a client for a control session or replay.
|
static String |
DEFAULT_IDLE_STRATEGY
Default
IdleStrategy to be used for the archive Agents when not busy. |
static int |
ERROR_BUFFER_LENGTH_DEFAULT
Size in bytes of the error buffer for the archive when not eternally provided.
|
static String |
ERROR_BUFFER_LENGTH_PROP_NAME
Size in bytes of the error buffer for the archive when not externally provided.
|
static int |
FILE_IO_MAX_LENGTH_DEFAULT
Default block length of data in a single IO operation during a recording or replay.
|
static String |
FILE_IO_MAX_LENGTH_PROP_NAME
Maximum length of a file IO operation for recording or replay.
|
static int |
FILE_SYNC_LEVEL_DEFAULT
Default is to use normal file writes which may mean some data loss in the event of a power failure.
|
static String |
FILE_SYNC_LEVEL_PROP_NAME
The level at which recording files should be sync'ed to disk.
|
static long |
MAX_CATALOG_ENTRIES_DEFAULT
Deprecated.
|
static String |
MAX_CATALOG_ENTRIES_PROP_NAME
Deprecated.
Use
CATALOG_CAPACITY_PROP_NAME instead. |
static int |
MAX_CONCURRENT_RECORDINGS_DEFAULT
Default maximum number of concurrent recordings.
|
static String |
MAX_CONCURRENT_RECORDINGS_PROP_NAME
Maximum number of concurrent recordings which can be active at a time.
|
static int |
MAX_CONCURRENT_REPLAYS_DEFAULT
Default maximum number of concurrent replays.
|
static String |
MAX_CONCURRENT_REPLAYS_PROP_NAME
Maximum number of concurrent replays.
|
static String |
RECORD_CHECKSUM_PROP_NAME
Property that specifies fully qualified class name of the
Checksum
to be used for checksum computation during recording. |
static String |
REPLAY_CHECKSUM_PROP_NAME
Property that specifies fully qualified class name of the
Checksum
to be used for checksum validation during replay. |
static long |
REPLAY_LINGER_TIMEOUT_DEFAULT_NS
Default for long to linger a replay connection which defaults to
Configuration.publicationLingerTimeoutNs(). |
static String |
REPLAY_LINGER_TIMEOUT_PROP_NAME
How long a replay publication should linger after all data is sent.
|
static String |
REPLICATION_CHANNEL_DEFAULT
Channel for receiving replication streams replayed from another archive.
|
static String |
REPLICATION_CHANNEL_PROP_NAME
Channel for receiving replication streams replayed from another archive.
|
static int |
SEGMENT_FILE_LENGTH_DEFAULT
Default segment file length which is multiple of terms.
|
static String |
SEGMENT_FILE_LENGTH_PROP_NAME
Recordings will be segmented on disk in files limited to the segment length which must be a multiple of
the term length for each stream.
|
static String |
THREADING_MODE_PROP_NAME
What
ArchiveThreadingMode should be used. |
| Constructor and Description |
|---|
Configuration() |
| Modifier and Type | Method and Description |
|---|---|
static String |
archiveDirName()
Get the directory name to be used for storing the archive.
|
static AuthenticatorSupplier |
authenticatorSupplier()
The value
AUTHENTICATOR_SUPPLIER_DEFAULT or system property
AUTHENTICATOR_SUPPLIER_PROP_NAME if set. |
static long |
catalogCapacity()
Default capacity (size) in bytes for the catalog file.
|
static int |
catalogFileSyncLevel()
The level at which the catalog file and directory should be sync'ed to disk.
|
static long |
connectTimeoutNs()
The timeout in nanoseconds to wait for a connection.
|
static boolean |
deleteArchiveOnStart()
Whether to delete directory on start or not.
|
static int |
errorBufferLength()
Size in bytes of the error buffer in the mark file.
|
static int |
fileIoMaxLength()
The maximum length of a file IO operation.
|
static int |
fileSyncLevel()
The level at which files should be sync'ed to disk.
|
static Supplier<IdleStrategy> |
idleStrategySupplier(StatusIndicator controllableStatus)
Create a supplier of
IdleStrategys for the ARCHIVE_IDLE_STRATEGY_PROP_NAME
system property. |
static long |
maxCatalogEntries()
Deprecated.
Use
catalogCapacity() instead. |
static int |
maxConcurrentRecordings()
The maximum number of recordings that can operate concurrently after which new requests will be rejected.
|
static int |
maxConcurrentReplays()
The maximum number of replays that can operate concurrently after which new requests will be rejected.
|
static String |
recordChecksum()
Fully qualified class name of the
Checksum implementation to use during
recording to compute checksums. |
static Supplier<IdleStrategy> |
recorderIdleStrategySupplier(StatusIndicator controllableStatus)
Create a supplier of
IdleStrategys for the ARCHIVE_RECORDER_IDLE_STRATEGY_PROP_NAME
system property. |
static String |
replayChecksum()
Fully qualified class name of the
Checksum implementation to use during
replay for the checksum. |
static Supplier<IdleStrategy> |
replayerIdleStrategySupplier(StatusIndicator controllableStatus)
Create a supplier of
IdleStrategys for the ARCHIVE_REPLAYER_IDLE_STRATEGY_PROP_NAME
system property. |
static long |
replayLingerTimeoutNs()
The timeout in nanoseconds to for a replay network publication to linger after draining.
|
static String |
replicationChannel()
The value
REPLICATION_CHANNEL_DEFAULT or system property
REPLICATION_CHANNEL_PROP_NAME if set. |
static int |
segmentFileLength()
The length of file to be used for storing recording segments that must be a power of 2.
|
static ArchiveThreadingMode |
threadingMode()
The threading mode to be employed by the archive.
|
public static final int FILE_IO_MAX_LENGTH_DEFAULT
public static final String FILE_IO_MAX_LENGTH_PROP_NAME
public static final String ARCHIVE_DIR_PROP_NAME
public static final String ARCHIVE_DIR_DEFAULT
ARCHIVE_DIR_PROP_NAME,
Constant Field Valuespublic static final String SEGMENT_FILE_LENGTH_PROP_NAME
public static final int SEGMENT_FILE_LENGTH_DEFAULT
public static final String FILE_SYNC_LEVEL_PROP_NAME
public static final int FILE_SYNC_LEVEL_DEFAULT
FILE_SYNC_LEVEL_PROP_NAME,
Constant Field Valuespublic static final String CATALOG_FILE_SYNC_LEVEL_PROP_NAME
public static final int CATALOG_FILE_SYNC_LEVEL_DEFAULT
public static final String THREADING_MODE_PROP_NAME
ArchiveThreadingMode should be used.public static final String ARCHIVE_IDLE_STRATEGY_PROP_NAME
IdleStrategy to be used for the archive Agents when not busy.public static final String ARCHIVE_RECORDER_IDLE_STRATEGY_PROP_NAME
IdleStrategy to be used for the archive recorder Agent when not busy.public static final String ARCHIVE_REPLAYER_IDLE_STRATEGY_PROP_NAME
IdleStrategy to be used for the archive replayer Agent when not busy.public static final String DEFAULT_IDLE_STRATEGY
IdleStrategy to be used for the archive Agents when not busy.public static final String MAX_CONCURRENT_RECORDINGS_PROP_NAME
public static final int MAX_CONCURRENT_RECORDINGS_DEFAULT
public static final String MAX_CONCURRENT_REPLAYS_PROP_NAME
public static final int MAX_CONCURRENT_REPLAYS_DEFAULT
@Deprecated public static final String MAX_CATALOG_ENTRIES_PROP_NAME
CATALOG_CAPACITY_PROP_NAME instead.Catalog. Increasing this limit will require use of the
CatalogTool. The number of entries can be reduced by extending existing recordings rather than
creating new ones.@Deprecated public static final long MAX_CATALOG_ENTRIES_DEFAULT
Catalogpublic static final String CATALOG_CAPACITY_PROP_NAME
Catalog. Catalog will resize itself when this
limit is reached.public static final long CATALOG_CAPACITY_DEFAULT
Catalog.CATALOG_CAPACITY_PROP_NAME,
Constant Field Valuespublic static final String CONNECT_TIMEOUT_PROP_NAME
public static final long CONNECT_TIMEOUT_DEFAULT_NS
CONNECT_TIMEOUT_PROP_NAMEpublic static final String REPLAY_LINGER_TIMEOUT_PROP_NAME
public static final long REPLAY_LINGER_TIMEOUT_DEFAULT_NS
Configuration.publicationLingerTimeoutNs().REPLAY_LINGER_TIMEOUT_PROP_NAMEpublic static final String ARCHIVE_DIR_DELETE_ON_START_PROP_NAME
public static final String REPLICATION_CHANNEL_PROP_NAME
public static final String REPLICATION_CHANNEL_DEFAULT
public static final String AUTHENTICATOR_SUPPLIER_PROP_NAME
Authenticator for the archive.public static final String AUTHENTICATOR_SUPPLIER_DEFAULT
Authenticator for the archive. Default is
a non-authenticating option.public static final int ARCHIVE_ERROR_COUNT_TYPE_ID
Counter used for keeping track of the number of errors that have occurred.public static final int ARCHIVE_CONTROL_SESSIONS_TYPE_ID
Counter used for keeping track of the count of concurrent control sessions.public static final String ERROR_BUFFER_LENGTH_PROP_NAME
public static final int ERROR_BUFFER_LENGTH_DEFAULT
public static final String RECORD_CHECKSUM_PROP_NAME
Checksum
to be used for checksum computation during recording.public static final String REPLAY_CHECKSUM_PROP_NAME
Checksum
to be used for checksum validation during replay.public static String archiveDirName()
public static int fileIoMaxLength()
public static int segmentFileLength()
If the Image.termBufferLength() is greater then this will take priority.
public static int fileSyncLevel()
FILE_SYNC_LEVEL_PROP_NAMEpublic static int catalogFileSyncLevel()
CATALOG_FILE_SYNC_LEVEL_PROP_NAMEpublic static ArchiveThreadingMode threadingMode()
public static Supplier<IdleStrategy> idleStrategySupplier(StatusIndicator controllableStatus)
IdleStrategys for the ARCHIVE_IDLE_STRATEGY_PROP_NAME
system property.controllableStatus - if a ControllableIdleStrategy is required.Supplier.public static Supplier<IdleStrategy> recorderIdleStrategySupplier(StatusIndicator controllableStatus)
IdleStrategys for the ARCHIVE_RECORDER_IDLE_STRATEGY_PROP_NAME
system property.controllableStatus - if a ControllableIdleStrategy is required.Supplier.public static Supplier<IdleStrategy> replayerIdleStrategySupplier(StatusIndicator controllableStatus)
IdleStrategys for the ARCHIVE_REPLAYER_IDLE_STRATEGY_PROP_NAME
system property.controllableStatus - if a ControllableIdleStrategy is required.Supplier.public static int maxConcurrentRecordings()
public static int maxConcurrentReplays()
@Deprecated public static long maxCatalogEntries()
catalogCapacity() instead.catalogCapacity()public static long catalogCapacity()
public static long connectTimeoutNs()
CONNECT_TIMEOUT_PROP_NAMEpublic static long replayLingerTimeoutNs()
REPLAY_LINGER_TIMEOUT_PROP_NAME,
Configuration.PUBLICATION_LINGER_PROP_NAMEpublic static boolean deleteArchiveOnStart()
ARCHIVE_DIR_DELETE_ON_START_PROP_NAMEpublic static String replicationChannel()
REPLICATION_CHANNEL_DEFAULT or system property
REPLICATION_CHANNEL_PROP_NAME if set.REPLICATION_CHANNEL_DEFAULT or system property
REPLICATION_CHANNEL_PROP_NAME if set.public static int errorBufferLength()
ERROR_BUFFER_LENGTH_PROP_NAMEpublic static AuthenticatorSupplier authenticatorSupplier()
AUTHENTICATOR_SUPPLIER_DEFAULT or system property
AUTHENTICATOR_SUPPLIER_PROP_NAME if set.AUTHENTICATOR_SUPPLIER_DEFAULT or system property
AUTHENTICATOR_SUPPLIER_PROP_NAME if set.public static String recordChecksum()
Checksum implementation to use during
recording to compute checksums. Non-empty value means that checksum is enabled for recording.Checksum interfaceRECORD_CHECKSUM_PROP_NAMEpublic static String replayChecksum()
Checksum implementation to use during
replay for the checksum. Non-empty value means that checksum is enabled for replay.Checksum interfaceREPLAY_CHECKSUM_PROP_NAMECopyright © 2014-2020 Real Logic Limited. All Rights Reserved.