dk.netarkivet.archive
Class ArchiveSettings

java.lang.Object
  extended by dk.netarkivet.archive.ArchiveSettings

public class ArchiveSettings
extends java.lang.Object

Settings specific to the archive module of NetarchiveSuite.


Field Summary
static java.lang.String ADMIN_CLASS
          settings.archive.admin.class The path to the settings for the adminstration instance class.
static java.lang.String ARCREPOSITORY_UPLOAD_RETRIES
          settings.archive.arcrepository.uploadRetries:
The maximum number of times an arc file is attempted uploaded if the initial upload fails.
static java.lang.String BASEURL_ARCREPOSITORY_ADMIN_DATABASE
          settings.archive.admin.database.baseUrl:
Setting for giving the base URL to the database used by the ReplicaCacheDatabase class.
static java.lang.String BITARCHIVE_ACCEPTABLE_HEARTBEAT_DELAY
          settings.archive.bitarchive.acceptableHeartbeatDelay:*
If we haven't heard from a bit archive within this many milliseconds, we don't expect it to be online and won't wait for them to reply on a batch job.
static java.lang.String BITARCHIVE_BATCH_JOB_TIMEOUT
          settings.archive.bitarchive.batchMessageTimeout:
The BitarchiveMonitorServer will listen for BatchEndedMessages for this many milliseconds before it decides that a batch job is taking too long and returns just the replies it has received at that point.
static java.lang.String BITARCHIVE_HEARTBEAT_FREQUENCY
          settings.archive.bitarchive.heartbeatFrequency:*
The frequency in milliseconds of heartbeats that are sent by each BitarchiveServer to the BitarchiveMonitor.
static java.lang.String BITARCHIVE_MIN_SPACE_LEFT
          settings.archive.bitarchive.minSpaceLeft:
The minimum amount of bytes left *in any dir* that we will allow a bitarchive machine to accept uploads with.
static java.lang.String BITARCHIVE_MIN_SPACE_REQUIRED
          settings.archive.bitarchive.minSpaceRequired:
The minimum amount of bytes required left *in all dirs* after we have accepted an upload.
static java.lang.String BITARCHIVE_SERVER_FILEDIR
          settings.archive.bitarchive.baseFileDir:
These are the directories where ARC files are stored (in a subdir).
static java.lang.String CHECKSUM_BASEDIR
          settings.archive.checksum.baseDir:
The directory for the checksum file.
static java.lang.String CHECKSUM_MIN_SPACE_LEFT
          settings.archive.checksum.minSpaceLeft:
The path to the settings for the minimum amount of space left for the checksum archive to receive new upload messages.
static java.lang.String CLASS_ARCREPOSITORY_ADMIN_DATABASE
          settings.archive.admin.database.class:
Setting for which class is used for handling the database for the DatabaseBasedActiveBitPreservation class.
static java.lang.String CLASS_ARCREPOSITORY_BITPRESERVATION
          settings.archive.bitpreservation.class:
Setting for which instance of ActiveBitPreservation that should be used for preservation.
static java.lang.String DIR_ARCREPOSITORY_ADMIN_DATABASE
          settings.archive.admin.database.dir:
Setting for giving the machine of the external database used by the ReplicaCacheDatabase class.
static java.lang.String DIR_ARCREPOSITORY_BITPRESERVATION
          settings.archive.bitpreservation.baseDir:
Absolute or relative path to dir containing results of file-list-batch-jobs and checksumming batch jobs for bit preservation.
static java.lang.String DIRS_ARCREPOSITORY_ADMIN
          settings.archive.arcrepository.baseDir:
Absolute/relative path to where the "central list of files and checksums" (admin.data) is written.
static java.lang.String ENVIRONMENT_THIS_CREDENTIALS
          settings.archive.bitarchive.thisCredentials:
Credentials to enter in the GUI for "deleting" ARC files in this bit archive.
static java.lang.String INDEXSERVER_INDEXING_MAXCLIENTS
          settings.archive.indexserver.maxclients:
Setting for the max number of clients the indexserver can handle simultaneously.
static java.lang.String INDEXSERVER_INDEXING_MAXTHREADS
          settings.archive.indexserver.maxthreads:
Setting for the max number of threads the deduplication indexer shall use.
static java.lang.String INDEXSERVER_INDEXING_REQUESTDIR
          settings.archive.indexserver.requestdir:
Setting for where the requests of the indexserver are stored.
static java.lang.String INDEXSERVER_INDEXING_TIMEOUT
          settings.archive.indexserver.indexingtimeout:
Setting for the indexing timeout in milliseconds.
static java.lang.String MACHINE_ARCREPOSITORY_ADMIN_DATABASE
          settings.archive.admin.database.machine:
Setting for giving the machine of the external database used by the ReplicaCacheDatabase class.
static java.lang.String PORT_ARCREPOSITORY_ADMIN_DATABASE
          settings.archive.admin.database.port:
Setting for giving the port of the external database used by the ReplicaCacheDatabase class.
static java.lang.String RECONNECT_DELAY_ADMIN_DATABASE
          settings.archive.admin.database.reconnectRetryDelay:
Settings for the delay between the attempts to reconnect to the admin database.
static java.lang.String RECONNECT_MAX_TRIES_ADMIN_DATABASE
          settings.archive.admin.database.reconnectMaxRetries:
Setting for the maximum number of attempts to reconnect to the admin database.
static java.lang.String SINGLE_CHECKSUM_TIMEOUT
          settings.archive.bitarchive.singleChecksumTimeout:
The path to the settings for the maximum time usage for the calculation of the checksum for a single file.
 
Constructor Summary
ArchiveSettings()
           
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DIRS_ARCREPOSITORY_ADMIN

public static java.lang.String DIRS_ARCREPOSITORY_ADMIN
settings.archive.arcrepository.baseDir:
Absolute/relative path to where the "central list of files and checksums" (admin.data) is written. Used by ArcRepository and BitPreservation.


ARCREPOSITORY_UPLOAD_RETRIES

public static java.lang.String ARCREPOSITORY_UPLOAD_RETRIES
settings.archive.arcrepository.uploadRetries:
The maximum number of times an arc file is attempted uploaded if the initial upload fails.


BITARCHIVE_MIN_SPACE_LEFT

public static java.lang.String BITARCHIVE_MIN_SPACE_LEFT
settings.archive.bitarchive.minSpaceLeft:
The minimum amount of bytes left *in any dir* that we will allow a bitarchive machine to accept uploads with. When no dir has more space than this, the bitarchive machine stops listening for uploads. This value should at the very least be greater than the largest ARC file you expect to receive.


BITARCHIVE_MIN_SPACE_REQUIRED

public static java.lang.String BITARCHIVE_MIN_SPACE_REQUIRED
settings.archive.bitarchive.minSpaceRequired:
The minimum amount of bytes required left *in all dirs* after we have accepted an upload. If no dir has enough space to store a received file and still have at least this much space left, the operation will result in an error.


BITARCHIVE_SERVER_FILEDIR

public static java.lang.String BITARCHIVE_SERVER_FILEDIR
settings.archive.bitarchive.baseFileDir:
These are the directories where ARC files are stored (in a subdir). If more than one is given, they are used from one end. This setting may be repeated, to define multiple directories. Note: This value should always be so much lower than minSpaceRequired, that the difference matches at least the size of files we expect to receive.


BITARCHIVE_HEARTBEAT_FREQUENCY

public static java.lang.String BITARCHIVE_HEARTBEAT_FREQUENCY
settings.archive.bitarchive.heartbeatFrequency:*
The frequency in milliseconds of heartbeats that are sent by each BitarchiveServer to the BitarchiveMonitor.


BITARCHIVE_ACCEPTABLE_HEARTBEAT_DELAY

public static java.lang.String BITARCHIVE_ACCEPTABLE_HEARTBEAT_DELAY
settings.archive.bitarchive.acceptableHeartbeatDelay:*
If we haven't heard from a bit archive within this many milliseconds, we don't expect it to be online and won't wait for them to reply on a batch job. This number should be significantly greater than heartbeatFrequency to account for temporary network congestion.


BITARCHIVE_BATCH_JOB_TIMEOUT

public static java.lang.String BITARCHIVE_BATCH_JOB_TIMEOUT
settings.archive.bitarchive.batchMessageTimeout:
The BitarchiveMonitorServer will listen for BatchEndedMessages for this many milliseconds before it decides that a batch job is taking too long and returns just the replies it has received at that point.


ENVIRONMENT_THIS_CREDENTIALS

public static java.lang.String ENVIRONMENT_THIS_CREDENTIALS
settings.archive.bitarchive.thisCredentials:
Credentials to enter in the GUI for "deleting" ARC files in this bit archive.


DIR_ARCREPOSITORY_BITPRESERVATION

public static java.lang.String DIR_ARCREPOSITORY_BITPRESERVATION
settings.archive.bitpreservation.baseDir:
Absolute or relative path to dir containing results of file-list-batch-jobs and checksumming batch jobs for bit preservation.


ADMIN_CLASS

public static java.lang.String ADMIN_CLASS
settings.archive.admin.class The path to the settings for the adminstration instance class.


BASEURL_ARCREPOSITORY_ADMIN_DATABASE

public static java.lang.String BASEURL_ARCREPOSITORY_ADMIN_DATABASE
settings.archive.admin.database.baseUrl:
Setting for giving the base URL to the database used by the ReplicaCacheDatabase class. It has the default value: 'jdbc:derby'. Do not retrieve this directly, use in stead the function dk.netarkivet.archive.arcrepositoryadmin.DBConnect.getArchiveUrl(). If a specific url is wanted, and not constructed from the 4 different parts, just assign the entire URL to this setting and set the other settings to the empty string.


MACHINE_ARCREPOSITORY_ADMIN_DATABASE

public static java.lang.String MACHINE_ARCREPOSITORY_ADMIN_DATABASE
settings.archive.admin.database.machine:
Setting for giving the machine of the external database used by the ReplicaCacheDatabase class. It is default: 'localhost'. If this is empty, then it will be ignored. Do not retrieve this directly, use in stead the function dk.netarkivet.archive.arcrepositoryadmin.DBConnect.getArchiveUrl().


PORT_ARCREPOSITORY_ADMIN_DATABASE

public static java.lang.String PORT_ARCREPOSITORY_ADMIN_DATABASE
settings.archive.admin.database.port:
Setting for giving the port of the external database used by the ReplicaCacheDatabase class. It is default: '1527'. If this is empty, then it will be ignored. Do not retrieve this directly, use in stead the function dk.netarkivet.archive.arcrepositoryadmin.DBConnect.getArchiveUrl().


DIR_ARCREPOSITORY_ADMIN_DATABASE

public static java.lang.String DIR_ARCREPOSITORY_ADMIN_DATABASE
settings.archive.admin.database.dir:
Setting for giving the machine of the external database used by the ReplicaCacheDatabase class. It is default: 'admindb'. If this is empty, then it will be ignored. Do not retrieve this directly, use in stead the function dk.netarkivet.archive.arcrepositoryadmin.DBConnect.getArchiveUrl().


CLASS_ARCREPOSITORY_ADMIN_DATABASE

public static java.lang.String CLASS_ARCREPOSITORY_ADMIN_DATABASE
settings.archive.admin.database.class:
Setting for which class is used for handling the database for the DatabaseBasedActiveBitPreservation class.


RECONNECT_MAX_TRIES_ADMIN_DATABASE

public static java.lang.String RECONNECT_MAX_TRIES_ADMIN_DATABASE
settings.archive.admin.database.reconnectMaxRetries:
Setting for the maximum number of attempts to reconnect to the admin database.


RECONNECT_DELAY_ADMIN_DATABASE

public static java.lang.String RECONNECT_DELAY_ADMIN_DATABASE
settings.archive.admin.database.reconnectRetryDelay:
Settings for the delay between the attempts to reconnect to the admin database.


CLASS_ARCREPOSITORY_BITPRESERVATION

public static java.lang.String CLASS_ARCREPOSITORY_BITPRESERVATION
settings.archive.bitpreservation.class:
Setting for which instance of ActiveBitPreservation that should be used for preservation.


CHECKSUM_BASEDIR

public static java.lang.String CHECKSUM_BASEDIR
settings.archive.checksum.baseDir:
The directory for the checksum file.


CHECKSUM_MIN_SPACE_LEFT

public static java.lang.String CHECKSUM_MIN_SPACE_LEFT
settings.archive.checksum.minSpaceLeft:
The path to the settings for the minimum amount of space left for the checksum archive to receive new upload messages.


SINGLE_CHECKSUM_TIMEOUT

public static java.lang.String SINGLE_CHECKSUM_TIMEOUT
settings.archive.bitarchive.singleChecksumTimeout:
The path to the settings for the maximum time usage for the calculation of the checksum for a single file. Used to set a timelimit to the batchjob for the GetChecksumMessage.


INDEXSERVER_INDEXING_REQUESTDIR

public static java.lang.String INDEXSERVER_INDEXING_REQUESTDIR
settings.archive.indexserver.requestdir:
Setting for where the requests of the indexserver are stored.


INDEXSERVER_INDEXING_MAXCLIENTS

public static java.lang.String INDEXSERVER_INDEXING_MAXCLIENTS
settings.archive.indexserver.maxclients:
Setting for the max number of clients the indexserver can handle simultaneously.


INDEXSERVER_INDEXING_MAXTHREADS

public static java.lang.String INDEXSERVER_INDEXING_MAXTHREADS
settings.archive.indexserver.maxthreads:
Setting for the max number of threads the deduplication indexer shall use.


INDEXSERVER_INDEXING_TIMEOUT

public static java.lang.String INDEXSERVER_INDEXING_TIMEOUT
settings.archive.indexserver.indexingtimeout:
Setting for the indexing timeout in milliseconds. The default is 172800000 (2 days).

Constructor Detail

ArchiveSettings

public ArchiveSettings()