Package dk.netarkivet.archive

Class ArchiveSettings

  • public class ArchiveSettings
extends java.lang.Object
    Settings specific to the archive module of NetarchiveSuite.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      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_READ_ONLY_ALLOWED
      settings.archive.bitarchive.readOnlyAllowed:
      true/false - The possibility to have ready-only directories in your list (default false) - If true the application is not throwing a PermissionDenied Exception
      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_ARCHIVE_CLASS
      settings.archive.checksum.class This decides how to store the checksums, in file, og BDB database.
      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 CHECKSUM_USE_PRECOMPUTED_CHECKSUM_DURING_UPLOAD
      settings.archive.checksum.usePrecomputedChecksum: This decides whether or not use the pre-computed checksum sent as part of the StoreMessage and UploadMessage The default is false
      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 DB_CONN_VALID_CHECK_TIMEOUT
      settings.archive.admin.database.validityCheckTimeout:
      Timeout in seconds to check for the validity of a JDBC connection on the server.
      static java.lang.String DB_PASSWORD
      The password name for login to the admin database.Default values is empty (no password passed to database connection).
      static java.lang.String DB_POOL_ACQ_INC
      settings.archive.admin.database.pool.acquireInc:
      Configure the increment size DB connection pool.
      static java.lang.String DB_POOL_IDLE_CONN_TEST_ON_CHECKIN
      settings.archive.admin.database.pool.idleConnTestOnCheckin:
      Configure if a connection validity should be checked when returned to the pool.
      static java.lang.String DB_POOL_IDLE_CONN_TEST_PERIOD
      settings.archive.admin.database.pool.idleConnTestPeriod:
      Configure idle connection testing period in seconds.
      static java.lang.String DB_POOL_IDLE_CONN_TEST_QUERY
      settings.archive.admin.database.pool.idleConnTestQuery:
      The SQL query to be used when testing an idle connection.
      static java.lang.String DB_POOL_MAX_SIZE
      settings.archive.admin.database.pool.maxSize:
      Configure the maximum size of the DB connection pool.
      static java.lang.String DB_POOL_MAX_STM
      settings.archive.admin.database.pool.maxStm:
      Configure statement pooling, by setting the global maximum number of pooled prepared statements for a data source.
      static java.lang.String DB_POOL_MAX_STM_PER_CONN
      settings.archive.admin.database.pool.maxStmPerConn:
      Configure statement pooling, by setting the global maximum number of pooled prepared statements for a data source.
      static java.lang.String DB_POOL_MIN_SIZE
      settings.archive.admin.database.pool.minSize:
      Configure the minimum size of the DB connection pool.
      static java.lang.String DB_USERNAME
      The user name for login to the admin database.
      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 FILE_DIRECTORY_FILE_LISTING
      settings.archive.bitarchive.fileDirectoryListing:
      (optional) The name of the file in baseFileDir where an inventory of the archived files are placed.
      static java.lang.String FILE_DIRECTORY_NAME
      settings.archive.bitarchive.fileDirectoryName:
      The name of the subdirectory in baseFileDir where the archived files are placed.
      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 READONLY_ARCHIVE_MODE
      settings.archive.bitarchive.readonlyArchiveMode:
      Is the bitarchiveServer to be readOnly? If yes, we don't listen to the upload queue Necessary, when the upload happens by other means than the ArcrepositoryClient.store method.
      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

      Constructors 
      Constructor Description
      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_READ_ONLY_ALLOWED

        public static java.lang.String BITARCHIVE_READ_ONLY_ALLOWED
        settings.archive.bitarchive.readOnlyAllowed:
        true/false - The possibility to have ready-only directories in your list (default false) - If true the application is not throwing a PermissionDenied Exception

      • 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.

      • DB_CONN_VALID_CHECK_TIMEOUT

        public static java.lang.String DB_CONN_VALID_CHECK_TIMEOUT
        settings.archive.admin.database.validityCheckTimeout:
        Timeout in seconds to check for the validity of a JDBC connection on the server. This is the time in seconds to wait for the database operation used to validate the connection to complete. If the timeout period expires before the operation completes, this method returns false. A value of 0 indicates a timeout is not applied to the database operation.

        Connection.isValid(int)

      • DB_POOL_MIN_SIZE

        public static java.lang.String DB_POOL_MIN_SIZE
        settings.archive.admin.database.pool.minSize:
        Configure the minimum size of the DB connection pool. Default value is 5.

      • DB_POOL_MAX_SIZE

        public static java.lang.String DB_POOL_MAX_SIZE
        settings.archive.admin.database.pool.maxSize:
        Configure the maximum size of the DB connection pool. Default value is 10.

      • DB_POOL_ACQ_INC

        public static java.lang.String DB_POOL_ACQ_INC
        settings.archive.admin.database.pool.acquireInc:
        Configure the increment size DB connection pool. Default value is 5 (half the max size).

      • DB_USERNAME

        public static java.lang.String DB_USERNAME
        The user name for login to the admin database. Default value is empty (no username passed to database connection).

      • DB_PASSWORD

        public static java.lang.String DB_PASSWORD
        The password name for login to the admin database.Default values is empty (no password passed to database connection).

      • 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.

      • CHECKSUM_ARCHIVE_CLASS

        public static java.lang.String CHECKSUM_ARCHIVE_CLASS
        settings.archive.checksum.class This decides how to store the checksums, in file, og BDB database. By default, it is stored in a file

      • CHECKSUM_USE_PRECOMPUTED_CHECKSUM_DURING_UPLOAD

        public static java.lang.String CHECKSUM_USE_PRECOMPUTED_CHECKSUM_DURING_UPLOAD
        settings.archive.checksum.usePrecomputedChecksum: This decides whether or not use the pre-computed checksum sent as part of the StoreMessage and UploadMessage The default is false

      • 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.

      • FILE_DIRECTORY_NAME

        public static java.lang.String FILE_DIRECTORY_NAME
        settings.archive.bitarchive.fileDirectoryName:
        The name of the subdirectory in baseFileDir where the archived files are placed.

      • FILE_DIRECTORY_FILE_LISTING

        public static java.lang.String FILE_DIRECTORY_FILE_LISTING
        settings.archive.bitarchive.fileDirectoryListing:
        (optional) The name of the file in baseFileDir where an inventory of the archived files are placed. Replaces the use of the archivedFiles and archivedTime , introduced to optimize getFile and getRecord operations

      • READONLY_ARCHIVE_MODE

        public static java.lang.String READONLY_ARCHIVE_MODE
        settings.archive.bitarchive.readonlyArchiveMode:
        Is the bitarchiveServer to be readOnly? If yes, we don't listen to the upload queue Necessary, when the upload happens by other means than the ArcrepositoryClient.store method.