dk.netarkivet.common
Class Constants

java.lang.Object
  dk.netarkivet.common.Constants

public class Constants
extends java.lang.Object

This class is used for global constants only. If your constant is only to be used in a single package, put it in a Constants-class in that package, and make sure it is package private (no modifiers). If your constant is used in a single class only, put it in that class, and make sure it is private Remember everything placed here MUST be constants. This class is never instantiated, so thread security is not an issue.

Field Summary

static java.lang.String	ALL_PATTERN Pattern that matches everything.
static java.lang.String	ARCDIRECTORY_NAME The directory name of the heritrix directory with arcfiles.
static java.lang.String	CDX_MIME_PATTERN Pattern that matches our our CDX mimetype.
static java.lang.String	CDX_MIME_TYPE The mimetype for a list of CDX entries.
static int	IO_BUFFER_SIZE How big a buffer we use for read()/write() operations on InputStream/ OutputStream.
static long	IO_CHUNK_SIZE Read this much data when copying data from a file channel.
static java.util.regex.Pattern	IP_KEY_REGEXP A full string matcher for an IP-address.
static java.lang.String	IP_REGEX_STRING The pattern for an IP-address key.
static java.util.regex.Pattern	IPv6_KEY_REGEXP A full string matcher for an IPv6-address.
static int	MAJORVERSION Major version number.
static java.lang.String	METADATA_FILE_PATTERN_SUFFIX The suffix of a regular expression that matches the metadata files.
static int	MINORVERSION Minor version number.
static long	ONE_DAY_IN_MILLIES One day in milliseconds.
static long	ONE_MIN_IN_MILLIES One minute in milliseconds.
static java.lang.String	ORGANIZATION_NAME The organization behind the harvesting.
static int	PATCHVERSION Patch version number.
static java.lang.String	TRANSLATIONS_BUNDLE Internationalisation resource bundle for common module.
static java.lang.String	XML_EXTENSION Extension of XML file names.

Method Summary

static java.lang.String	getHeritrixVersionString() Get the Heritrix version presently in use.
static java.text.SimpleDateFormat	getIsoDateFormatter() Get a formatter that can read and write a date in ISO format including hours/minutes/seconds and timezone.
static java.lang.String	getVersionString() Get a human-readable version string.

Methods inherited from class java.lang.Object

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

Field Detail

IP_REGEX_STRING

public static final java.lang.String IP_REGEX_STRING

The pattern for an IP-address key.

See Also:

Constant Field Values

IP_KEY_REGEXP

public static final java.util.regex.Pattern IP_KEY_REGEXP

A full string matcher for an IP-address.

IPv6_KEY_REGEXP

public static final java.util.regex.Pattern IPv6_KEY_REGEXP

A full string matcher for an IPv6-address.

METADATA_FILE_PATTERN_SUFFIX

public static final java.lang.String METADATA_FILE_PATTERN_SUFFIX

The suffix of a regular expression that matches the metadata files. Add job IDs to the front as necessary.

See Also:

Constant Field Values

CDX_MIME_TYPE

public static final java.lang.String CDX_MIME_TYPE

The mimetype for a list of CDX entries.

See Also:

Constant Field Values

XML_EXTENSION

public static final java.lang.String XML_EXTENSION

Extension of XML file names.

See Also:

Constant Field Values

MAJORVERSION

public static final int MAJORVERSION

Major version number.

See Also:

Constant Field Values

MINORVERSION

public static final int MINORVERSION

Minor version number.

See Also:

Constant Field Values

PATCHVERSION

public static final int PATCHVERSION

Patch version number.

See Also:

Constant Field Values

IO_CHUNK_SIZE

public static final long IO_CHUNK_SIZE

Read this much data when copying data from a file channel. Note that due to a bug in java, this should never be set larger than Integer.MAX_VALUE, since a call to fileChannel.transferFrom/To fails with an error while calling mmap.

See Also:

Constant Field Values

ARCDIRECTORY_NAME

public static final java.lang.String ARCDIRECTORY_NAME

The directory name of the heritrix directory with arcfiles.

See Also:

Constant Field Values

IO_BUFFER_SIZE

public static final int IO_BUFFER_SIZE

How big a buffer we use for read()/write() operations on InputStream/ OutputStream.

See Also:

Constant Field Values

ORGANIZATION_NAME

public static final java.lang.String ORGANIZATION_NAME

The organization behind the harvesting. Only used by the HarvestDocumentation class

See Also:

Constant Field Values

TRANSLATIONS_BUNDLE

public static final java.lang.String TRANSLATIONS_BUNDLE

Internationalisation resource bundle for common module.

See Also:

Constant Field Values

ONE_MIN_IN_MILLIES

public static final long ONE_MIN_IN_MILLIES

One minute in milliseconds.

See Also:

Constant Field Values

ONE_DAY_IN_MILLIES

public static final long ONE_DAY_IN_MILLIES

One day in milliseconds.

See Also:

Constant Field Values

CDX_MIME_PATTERN

public static java.lang.String CDX_MIME_PATTERN

Pattern that matches our our CDX mimetype.

ALL_PATTERN

public static java.lang.String ALL_PATTERN

Pattern that matches everything.

Method Detail

getVersionString

public static java.lang.String getVersionString()

Get a human-readable version string.

Returns:

A string telling current version and status of code.

getHeritrixVersionString

public static java.lang.String getHeritrixVersionString()

Get the Heritrix version presently in use.

Returns:

the Heritrix version presently in use

getIsoDateFormatter

public static java.text.SimpleDateFormat getIsoDateFormatter()

Get a formatter that can read and write a date in ISO format including hours/minutes/seconds and timezone.

Returns:

The formatter.