dk.netarkivet.common
Class CommonSettings

java.lang.Object
  dk.netarkivet.common.CommonSettings

public class CommonSettings
extends java.lang.Object

Settings common to the entire NetarchiveSuite.

Field Summary

static java.lang.String	APPLICATION_INSTANCE_ID settings.common.applicationInstanceId: The identifier of the instance of the application.
static java.lang.String	APPLICATION_NAME settings.common.applicationName: The name of the application, e.g.
static java.lang.String	ARC_REPOSITORY_CLIENT settings.common.arcrepositoryClient.class: The class that implements the ArcRepositoryClient.
static java.lang.String	BATCH_DEFAULT_TIMEOUT settings.common.batch.defaultBatchTimeout: The default timeout for batchjobs.
static java.lang.String	BATCH_LOGGING_INTERVAL settings.common.batch.loggingInterval: The time between logging the status of a batch job.
static java.lang.String	BATCHJOBS_BASEDIR settings.common.batch.baseDir: The directory where the resulting files will be placed when running a batchjob through the GUI interface.
static java.lang.String	BATCHJOBS_CLASS settings.common.batch.batchjobs.batchjob.class: The list of batchjobs to be runnable from the GUI.
static java.lang.String	BATCHJOBS_JARFILE settings.common.batch.batchjobs.batchjob.jarfile: The list of the corresponding jar-files containing the batchjob.
static java.lang.String	BITARCHIVE_LIMIT_FOR_RECORD_DATATRANSFER_IN_FILE settings.common.repository.limitForRecordDatatransferInFile: When the length record exceeds this number, the contents of the record will be transferred using a RemoteFile.
static java.lang.String	CACHE_DIR settings.common.cacheDir: The name of the directory where cache data global to the entire machine can be stored.
static java.lang.String	DB_BASE_URL settings.common.database.baseUrl: The URL to use to connect to the database specified in the DB_SPECIFICS_CLASS setting.
static java.lang.String	DB_CONN_VALID_CHECK_TIMEOUT settings.common.database.validityCheckTimeout: Timeout in seconds to check for the validity of a JDBC connection on the server.
static java.lang.String	DB_DIR settings.common.database.dir: Used for the external harvest definition database.
static java.lang.String	DB_IS_DERBY_IF_CONTAINS If DB_SPECIFICS_CLASS contains this string then a Derby database is in use.
static java.lang.String	DB_MACHINE settings.common.database.machine: Used for the external harvest definition database.
static java.lang.String	DB_POOL_ACQ_INC settings.common.database.pool.acquireInc: Configure the increment size DB connection pool.
static java.lang.String	DB_POOL_IDLE_CONN_TEST_ON_CHECKIN settings.common.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.common.database.pool.idleConnTestPeriod: Configure idle connection testing period in seconds.
static java.lang.String	DB_POOL_IDLE_CONN_TEST_QUERY settings.common.database.pool.idleConnTestQuery: The SQL query to be used when testing an idle connection.
static java.lang.String	DB_POOL_MAX_SIZE settings.common.database.pool.maxSize: Configure the maximum size of the DB connection pool.
static java.lang.String	DB_POOL_MAX_STM settings.common.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.common.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.common.database.pool.minSize: Configure the minimum size of the DB connection pool.
static java.lang.String	DB_PORT settings.common.database.port: Used for the external harvest definition database.
static java.lang.String	DB_SPECIFICS_CLASS settings.common.database.class: The class that defines DB-specific methods.
static java.lang.String	DIR_COMMONTEMPDIR settings.common.tempDir: Common temporary directory for all applications.
static java.lang.String	ENVIRONMENT_NAME settings.common.environmentName: The name of the environment in which this code is running.
static java.lang.String	FREESPACE_PROVIDER_CLASS settings.common.freespaceprovider.class: The implementation class for free space provider, e.g.
static java.lang.String	HARVEST_STATUS_DFT_PAGE_SIZE settings.common.webinterface.harvestStatus.defaultPageSize: The default number of jobs to show in the harvest status section, on one result page.
static java.lang.String	HTTP_PORT_NUMBER settings.common.http.port: The *unique* (per host) port number that may or may not be used to serve http.
static java.lang.String	INDEXSERVER_CLIENT settings.common.indexClient.class: The class instantiated to give access to indices.
static java.lang.String	JMS_BROKER_CLASS settings.common.jms.class: Selects the broker class to be used.
static java.lang.String	JMS_BROKER_RETRIES settings.common.jms.retries: Selects the number of times the JMS connection tries to reconnect to the broker.
static java.lang.String	JMX_ACCESS_FILE settings.common.jmx.accessFile: The access file, containing information about who have which JMX roles have which access privileges.
static java.lang.String	JMX_PASSWORD_FILE settings.common.jmx.passwordFile: The password file, containing information about who may connect to the beans.
static java.lang.String	JMX_PORT settings.common.jmx.port: The port to use for JMX.
static java.lang.String	JMX_RMI_PORT settings.common.jmx.rmiPort: The JMX's RMI port to use for internal communication with beans.
static java.lang.String	JMX_TIMEOUT settings.common.jmx.timeout: How many seconds we will wait before giving up on a JMX connection.
static java.lang.String	MAIL_SERVER settings.common.mail.server: The mail server to use when sending mails.
static java.lang.String	MAX_NUM_BATCH_EXCEPTIONS settings.common.batch.maxExceptions: The maximum number of exceptions to be stored for a batch job.
static java.lang.String	MONITOR_REGISTRY_CLIENT settings.common.monitorregistryClient.class: Which class to use for monitor registry.
static java.lang.String	MONITOR_REGISTRY_CLIENT_REREGISTERDELAY settings.common.monitorregistryClient.reregisterdelay: Delay between every reregistering in minutes, e.g.
static java.lang.String	NOTIFICATIONS_CLASS settings.common.notifications.class: The implementation class for notifications, e.g.
static java.lang.String	PROCESS_TIMEOUT settings.common.processTimeout: The number of milliseconds we wait for processes to react to shutdown requests.
static java.lang.String	REMOTE_FILE_CLASS settings.common.remoteFile.class: The class to use for RemoteFile objects (for transferring files around).
static java.lang.String	REPLICA_IDS settings.common.replicas.replica.replicaId: The identifiers of all replicas in the environment.
static java.lang.String	REPLICA_TAG settings.common.replicas.replica: The path to settings belonging to an individual replica, placed under the replicas setting.
static java.lang.String	REPLICA_TYPES settings.common.replicas.replica.replicaType: The types for all replicas in the environment.
static java.lang.String	REPLICAID_TAG settings.common.replicas.replica.replicaId: The tags for identifier of the replica, placed under the replica tag.
static java.lang.String	REPLICANAME_TAG settings.common.replicas.replica.replicaName: The tags for name of the replica, placed under the replica tag.
static java.lang.String	REPLICAS_SETTINGS settings.common.replicas: The entire settings for all replicas in the environment.
static java.lang.String	REPLICATYPE_TAG settings.common.replicas.replica.replicaType: The tags for type of the replica, placed under the replica tag.
static java.lang.String	SETTINGS The path in the XML-tree for the settings branch.
static java.lang.String	SITESECTION_CLASS settings.common.webinterface.siteSection.class: The subclass of SiteSection that defines a part of the web interface.
static java.lang.String	SITESECTION_WEBAPPLICATION settings.common.webinterface.siteSection.webapplication: The directory or war-file containing the web application for a site section.
static java.lang.String	THIS_PHYSICAL_LOCATION settings.common.thisPhysicalLocation: Physical location of where the application is running.
static java.lang.String	TLDS settings.common.topLevelDomains.tld: Valid top level domain, like .co.uk, .dk, .org.
static java.lang.String	USE_REPLICA_ID settings.common.useReplicaId: Default bitarchive to use for e.g.
static java.lang.String	WEBINTERFACE_LANGUAGE settings.common.webinterface.language: The entire language setting structure under the webinterface setting.
static java.lang.String	WEBINTERFACE_LANGUAGE_LOCALE settings.common.webinterface.language.locale: The locale the GUI is available as under specific language setting.
static java.lang.String	WEBINTERFACE_LANGUAGE_NAME settings.common.webinterface.language.name: The native name of the language for the locale under specific language setting.
static java.lang.String	WEBINTERFACE_SETTINGS settings.common.webinterface: The entire webinterface setting structure.

Constructor Summary

CommonSettings()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

SETTINGS

public static java.lang.String SETTINGS

The path in the XML-tree for the settings branch. (Used by deploy).

ENVIRONMENT_NAME

public static java.lang.String ENVIRONMENT_NAME

settings.common.environmentName:
The name of the environment in which this code is running. E.g. PROD, RELEASETEST. It is used as a Common prefix to all JMS channels created in a NetarchiveSuite installation.

DIR_COMMONTEMPDIR

public static java.lang.String DIR_COMMONTEMPDIR

settings.common.tempDir:
Common temporary directory for all applications. Some subdirs of this directory must be set to have AllPermision in the conf/security.conf file, or the web pages won't work.

REMOTE_FILE_CLASS

public static java.lang.String REMOTE_FILE_CLASS

settings.common.remoteFile.class:
The class to use for RemoteFile objects (for transferring files around). This class must implement the dk.netarkivet.common.distribute.RemoteFile interface.

JMS_BROKER_CLASS

public static java.lang.String JMS_BROKER_CLASS

settings.common.jms.class:
Selects the broker class to be used. Must be subclass of dk.netarkivet.common.distribute.JMSConnection.

JMS_BROKER_RETRIES

public static java.lang.String JMS_BROKER_RETRIES

settings.common.jms.retries:
Selects the number of times the JMS connection tries to reconnect to the broker.

HTTP_PORT_NUMBER

public static java.lang.String HTTP_PORT_NUMBER

settings.common.http.port:
The *unique* (per host) port number that may or may not be used to serve http.

ARC_REPOSITORY_CLIENT

public static java.lang.String ARC_REPOSITORY_CLIENT

settings.common.arcrepositoryClient.class:
The class that implements the ArcRepositoryClient. The class must implement the interface dk.netarkivet.common.distribute.arcrepository.ArcRepositoryClient This class will be instantiated by the ArcRepositoryClientFactory.

MAX_NUM_BATCH_EXCEPTIONS

public static java.lang.String MAX_NUM_BATCH_EXCEPTIONS

settings.common.batch.maxExceptions:
The maximum number of exceptions to be stored for a batch job.

BATCH_LOGGING_INTERVAL

public static java.lang.String BATCH_LOGGING_INTERVAL

settings.common.batch.loggingInterval:
The time between logging the status of a batch job.

BATCH_DEFAULT_TIMEOUT

public static java.lang.String BATCH_DEFAULT_TIMEOUT

settings.common.batch.defaultBatchTimeout:
The default timeout for batchjobs. This will be used for batchjobs which has the batchJobTimeout set to -1 (inherited value from FileBatchJob).

MONITOR_REGISTRY_CLIENT

public static java.lang.String MONITOR_REGISTRY_CLIENT

settings.common.monitorregistryClient.class:
Which class to use for monitor registry. Must implement the interface dk.netarkivet.common.distribute.monitorregistry.MonitorRegistryClient.

MONITOR_REGISTRY_CLIENT_REREGISTERDELAY

public static java.lang.String MONITOR_REGISTRY_CLIENT_REREGISTERDELAY

settings.common.monitorregistryClient.reregisterdelay:
Delay between every reregistering in minutes, e.g. 1 for one minute.

INDEXSERVER_CLIENT

public static java.lang.String INDEXSERVER_CLIENT

settings.common.indexClient.class:
The class instantiated to give access to indices. The class must implement the interface dk.netarkivet.common.distribute.indexserver.JobIndexCache The class instantiations are manufactored by IndexClientFactory.

CACHE_DIR

public static java.lang.String CACHE_DIR

settings.common.cacheDir:
The name of the directory where cache data global to the entire machine can be stored. Various kinds of caches should be stored in subdirectories of this.

PROCESS_TIMEOUT

public static java.lang.String PROCESS_TIMEOUT

settings.common.processTimeout:
The number of milliseconds we wait for processes to react to shutdown requests.

NOTIFICATIONS_CLASS

public static java.lang.String NOTIFICATIONS_CLASS

settings.common.notifications.class:
The implementation class for notifications, e.g. error notification. The class must extend dk.netarkivet.common.utils.Notifications

MAIL_SERVER

public static java.lang.String MAIL_SERVER

settings.common.mail.server:
The mail server to use when sending mails.

JMX_PORT

public static java.lang.String JMX_PORT

settings.common.jmx.port:
The port to use for JMX.

JMX_RMI_PORT

public static java.lang.String JMX_RMI_PORT

settings.common.jmx.rmiPort:
The JMX's RMI port to use for internal communication with beans.

JMX_PASSWORD_FILE

public static java.lang.String JMX_PASSWORD_FILE

settings.common.jmx.passwordFile:
The password file, containing information about who may connect to the beans. The file has a format defined by the JMX standard,

See Also:

JMX_ACCESS_FILE

public static java.lang.String JMX_ACCESS_FILE

settings.common.jmx.accessFile:
The access file, containing information about who have which JMX roles have which access privileges. The file has a format defined by the JMX standard,

See Also:

JMX_TIMEOUT

public static java.lang.String JMX_TIMEOUT

settings.common.jmx.timeout:
How many seconds we will wait before giving up on a JMX connection.

WEBINTERFACE_SETTINGS

public static java.lang.String WEBINTERFACE_SETTINGS

settings.common.webinterface:
The entire webinterface setting structure.

WEBINTERFACE_LANGUAGE

public static java.lang.String WEBINTERFACE_LANGUAGE

settings.common.webinterface.language:
The entire language setting structure under the webinterface setting. Is repeated for each language

WEBINTERFACE_LANGUAGE_LOCALE

public static java.lang.String WEBINTERFACE_LANGUAGE_LOCALE

settings.common.webinterface.language.locale:
The locale the GUI is available as under specific language setting.

WEBINTERFACE_LANGUAGE_NAME

public static java.lang.String WEBINTERFACE_LANGUAGE_NAME

settings.common.webinterface.language.name:
The native name of the language for the locale under specific language setting.

SITESECTION_CLASS

public static java.lang.String SITESECTION_CLASS

settings.common.webinterface.siteSection.class:
The subclass of SiteSection that defines a part of the web interface. Is part of repeated siteSection settings for each part.

SITESECTION_WEBAPPLICATION

public static java.lang.String SITESECTION_WEBAPPLICATION

settings.common.webinterface.siteSection.webapplication:
The directory or war-file containing the web application for a site section. Is part of repeated siteSection settings for each part.

HARVEST_STATUS_DFT_PAGE_SIZE

public static java.lang.String HARVEST_STATUS_DFT_PAGE_SIZE

settings.common.webinterface.harvestStatus.defaultPageSize:
The default number of jobs to show in the harvest status section, on one result page.

TLDS

public static java.lang.String TLDS

settings.common.topLevelDomains.tld:
Valid top level domain, like .co.uk, .dk, .org. Is part of repeated in settings for each top level domain

DB_SPECIFICS_CLASS

public static java.lang.String DB_SPECIFICS_CLASS

settings.common.database.class:
The class that defines DB-specific methods. This class must extend the DBSpecifics class

DB_IS_DERBY_IF_CONTAINS

public static java.lang.String DB_IS_DERBY_IF_CONTAINS

If DB_SPECIFICS_CLASS contains this string then a Derby database is in use.

DB_BASE_URL

public static java.lang.String DB_BASE_URL

settings.common.database.baseUrl:
The URL to use to connect to the database specified in the DB_SPECIFICS_CLASS setting.

DB_MACHINE

public static java.lang.String DB_MACHINE

settings.common.database.machine:
Used for the external harvest definition database. The machine where the harvest definition database is located.

DB_PORT

public static java.lang.String DB_PORT

settings.common.database.port:
Used for the external harvest definition database. The port where the external harvest definition database is attached.

DB_DIR

public static java.lang.String DB_DIR

settings.common.database.dir:
Used for the external harvest definition database. The directory where the external harvest definition database is located.

DB_CONN_VALID_CHECK_TIMEOUT

public static java.lang.String DB_CONN_VALID_CHECK_TIMEOUT

settings.common.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.common.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.common.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.common.database.pool.acquireInc:
Configure the increment size DB connection pool. Default value is 5 (half the max size).

DB_POOL_MAX_STM

public static java.lang.String DB_POOL_MAX_STM

settings.common.database.pool.maxStm:
Configure statement pooling, by setting the global maximum number of pooled prepared statements for a data source. Default value is 0. Note that if both DB_POOL_MAX_STM and DB_POOL_MAX_STM_PER_CONN are set to zero, statement pooling is fully deactivated.

See Also:

documentation.

DB_POOL_MAX_STM_PER_CONN

public static java.lang.String DB_POOL_MAX_STM_PER_CONN

settings.common.database.pool.maxStmPerConn:
Configure statement pooling, by setting the global maximum number of pooled prepared statements for a data source. Default value is 0. Note that if both DB_POOL_MAX_STM and DB_POOL_MAX_STM_PER_CONN are set to zero, statement pooling is fully deactivated.

See Also:

documentation.

DB_POOL_IDLE_CONN_TEST_PERIOD

public static java.lang.String DB_POOL_IDLE_CONN_TEST_PERIOD

settings.common.database.pool.idleConnTestPeriod:
Configure idle connection testing period in seconds. Default is 0, which means no idle connection testing

See Also:

DB_POOL_IDLE_CONN_TEST_ON_CHECKIN

public static java.lang.String DB_POOL_IDLE_CONN_TEST_ON_CHECKIN

settings.common.database.pool.idleConnTestOnCheckin:
Configure if a connection validity should be checked when returned to the pool. Default is false.

See Also:

DB_POOL_IDLE_CONN_TEST_QUERY

public static java.lang.String DB_POOL_IDLE_CONN_TEST_QUERY

settings.common.database.pool.idleConnTestQuery:
The SQL query to be used when testing an idle connection. Default is empty, which means using c3p0 defaults.

See Also:

BITARCHIVE_LIMIT_FOR_RECORD_DATATRANSFER_IN_FILE

public static java.lang.String BITARCHIVE_LIMIT_FOR_RECORD_DATATRANSFER_IN_FILE

settings.common.repository.limitForRecordDatatransferInFile:
When the length record exceeds this number, the contents of the record will be transferred using a RemoteFile.

REPLICAS_SETTINGS

public static java.lang.String REPLICAS_SETTINGS

settings.common.replicas:
The entire settings for all replicas in the environment. NOTE: settings for checksum replicas are not use yet

REPLICA_TAG

public static java.lang.String REPLICA_TAG

settings.common.replicas.replica:
The path to settings belonging to an individual replica, placed under the replicas setting.

REPLICAID_TAG

public static java.lang.String REPLICAID_TAG

settings.common.replicas.replica.replicaId:
The tags for identifier of the replica, placed under the replica tag. The replica id is used internally in e.g. naming of channels.

REPLICANAME_TAG

public static java.lang.String REPLICANAME_TAG

settings.common.replicas.replica.replicaName:
The tags for name of the replica, placed under the replica tag. The replica name is used in interfaces like the GUI or command-line batch-programs. The name can be the same value as the id.

REPLICATYPE_TAG

public static java.lang.String REPLICATYPE_TAG

settings.common.replicas.replica.replicaType:
The tags for type of the replica, placed under the replica tag. The type is used to identify whether it is a bitarchive or a checksum replica. NOTE: checksum replicas are not implemented yet Possible values are defined in ReplicaType

REPLICA_IDS

public static java.lang.String REPLICA_IDS

settings.common.replicas.replica.replicaId:
The identifiers of all replicas in the environment.

REPLICA_TYPES

public static java.lang.String REPLICA_TYPES

settings.common.replicas.replica.replicaType:
The types for all replicas in the environment.

USE_REPLICA_ID

public static java.lang.String USE_REPLICA_ID

settings.common.useReplicaId:
Default bitarchive to use for e.g. batch jobs (if none is specified).

THIS_PHYSICAL_LOCATION

public static java.lang.String THIS_PHYSICAL_LOCATION

settings.common.thisPhysicalLocation:
Physical location of where the application is running. Only use for System state GUI and deploy

APPLICATION_NAME

public static java.lang.String APPLICATION_NAME

settings.common.applicationName:
The name of the application, e.g. "BitarchiveServerApplication". The monitor puts this with each log message.

APPLICATION_INSTANCE_ID

public static java.lang.String APPLICATION_INSTANCE_ID

settings.common.applicationInstanceId:
The identifier of the instance of the application. This is used when there are more than one of the same application running on the same machine, e.g. when more harvesters are running on the same machine or more bitarchive applications are running on the same machine.

FREESPACE_PROVIDER_CLASS

public static java.lang.String FREESPACE_PROVIDER_CLASS

settings.common.freespaceprovider.class:
The implementation class for free space provider, e.g. dk.netarkivet.common.utils.DefaultFreeSpaceProvider. The class must implement FreeSpaceProvider-Interface.

BATCHJOBS_CLASS

public static java.lang.String BATCHJOBS_CLASS

settings.common.batch.batchjobs.batchjob.class:
The list of batchjobs to be runnable from the GUI. Must be the complete path to the batchjob classes (e.g. dk.netarkivet.archive.arcrepository.bitpreservation.ChecksumJob). Must inherit FileBatchJob.

BATCHJOBS_JARFILE

public static java.lang.String BATCHJOBS_JARFILE

settings.common.batch.batchjobs.batchjob.jarfile:
The list of the corresponding jar-files containing the batchjob. This will be used for LoadableJarBatchJobs. If no file is specified, it is assumed, that the batchjob exists with the default classpath of the involved applications (BitarchiveMonitor, ArcRepository, GUIWebServer and BitArchive).

BATCHJOBS_BASEDIR

public static java.lang.String BATCHJOBS_BASEDIR

settings.common.batch.baseDir:
The directory where the resulting files will be placed when running a batchjob through the GUI interface.

Constructor Detail

CommonSettings

public CommonSettings()