Class Constants


  • public final class Constants
    extends Object
    Class containing the constant variables.

    SETTINGS_ = path to branches from the settings branch. COMPLETE_ = path from beyond the settings branch.

    • Field Detail

      • WAIT_TIME_DURING_RESTART

        public static final int WAIT_TIME_DURING_RESTART
        The amount of seconds to wait for the restart script.
        See Also:
        Constant Field Values
      • ARGUMENTS_REQUIRED

        public static final int ARGUMENTS_REQUIRED
        The minimum number of arguments required.
        See Also:
        Constant Field Values
      • TEST_ARGUMENTS_REQUIRED

        public static final int TEST_ARGUMENTS_REQUIRED
        The exact number of arguments required for test.
        See Also:
        Constant Field Values
      • TEST_OFFSET_INTEGER_MAXIMUM_VALUE

        public static final int TEST_OFFSET_INTEGER_MAXIMUM_VALUE
        The maximum integer value in a character.
        See Also:
        Constant Field Values
      • BASEFILEDIR_SUBDIRECTORIES

        public static final String[] BASEFILEDIR_SUBDIRECTORIES
        Directories to install under baseFileDir.
      • DEFAULT_MENULOGO_FILENAME

        public static final String DEFAULT_MENULOGO_FILENAME
        The default menulogo filename
        See Also:
        Constant Field Values
      • WARFILENAMES

        public static final String[] WARFILENAMES
        The war filenames in the webpages directory
      • BUILD_COMPLETE_SETTINGS_FILE_PATH

        public static final String BUILD_COMPLETE_SETTINGS_FILE_PATH
        The path to the complete settings file.
        See Also:
        Constant Field Values
      • FILE_TEMPORARY_RUN_WINDOWS_NAME

        public static final String FILE_TEMPORARY_RUN_WINDOWS_NAME
        The name of the temporary run-file for windows.
        See Also:
        Constant Field Values
      • ARG_CONFIG_FILE

        public static final String ARG_CONFIG_FILE
        For giving the configuration file as argument.
        See Also:
        Constant Field Values
      • ARG_NETARCHIVE_SUITE_FILE

        public static final String ARG_NETARCHIVE_SUITE_FILE
        For giving the NetarchiveSuite package file as argument.
        See Also:
        Constant Field Values
      • ARG_SECURITY_FILE

        public static final String ARG_SECURITY_FILE
        For giving the security file as argument.
        See Also:
        Constant Field Values
      • ARG_SLF4J_CONFIG_FILE

        public static final String ARG_SLF4J_CONFIG_FILE
        For giving the SLF4J xml file as argument.
        See Also:
        Constant Field Values
      • ARG_OUTPUT_DIRECTORY

        public static final String ARG_OUTPUT_DIRECTORY
        For giving the optional output directory as argument.
        See Also:
        Constant Field Values
      • ARG_DATABASE_FILE

        public static final String ARG_DATABASE_FILE
        For giving the optional database file as argument.
        See Also:
        Constant Field Values
      • ARG_JAR_FOLDER

        public static final String ARG_JAR_FOLDER
        For installing external libraries through deploy.
        See Also:
        Constant Field Values
      • ARG_DEFAULT_BUNDLER_ZIP

        public static final String ARG_DEFAULT_BUNDLER_ZIP
        Optional definition of a default Heritrix3 bundler zip file.
        See Also:
        Constant Field Values
      • ARG_BITMAG_SOURCE_DIR

        public static final String ARG_BITMAG_SOURCE_DIR
        Optional definition of a bitmagasin source directory.
        See Also:
        Constant Field Values
      • ARG_DEFAULT_HERITRIX3_CERTIFICATE

        public static final String ARG_DEFAULT_HERITRIX3_CERTIFICATE
        Optional definition of a default Heritrix3 bundler zip file.
        See Also:
        Constant Field Values
      • ARG_SOURCE_ENCODING

        public static final String ARG_SOURCE_ENCODING
        Encoding to use for source files.
        See Also:
        Constant Field Values
      • REGEX_DOT_CHARACTER

        public static final String REGEX_DOT_CHARACTER
        Regular expression for finding the '.' character.
        See Also:
        Constant Field Values
      • REGEX_COMMA_CHARACTER

        public static final String REGEX_COMMA_CHARACTER
        Regular expression for finding the ',' character.
        See Also:
        Constant Field Values
      • REGEX_SLASH_CHARACTER

        public static final String REGEX_SLASH_CHARACTER
        Regular expression for finding the '/' character.
        See Also:
        Constant Field Values
      • REGEX_BACKSLASH_CHARACTER

        public static final String REGEX_BACKSLASH_CHARACTER
        Regular expression for finding the '/' character.
        See Also:
        Constant Field Values
      • VALID_REGEX_ENVIRONMENT_NAME

        public static final String VALID_REGEX_ENVIRONMENT_NAME
        The regular expression for validating the environment name.
        See Also:
        Constant Field Values
      • EXTERNAL_JAR_DIRECTORY

        public static final String EXTERNAL_JAR_DIRECTORY
        The folder for the external jar-files to be copied into.
        See Also:
        Constant Field Values
      • MSG_ERROR_PARSE_ARGUMENTS

        public static final String MSG_ERROR_PARSE_ARGUMENTS
        The error message for error in parsing the arguments.
        See Also:
        Constant Field Values
      • MSG_ERROR_TOO_MANY_ARGUMENTS

        public static final String MSG_ERROR_TOO_MANY_ARGUMENTS
        The error message when too many arguments are given.
        See Also:
        Constant Field Values
      • MSG_ERROR_NOT_ENOUGH_ARGUMENTS

        public static final String MSG_ERROR_NOT_ENOUGH_ARGUMENTS
        The error message when not enough arguments are given.
        See Also:
        Constant Field Values
      • MSG_ERROR_NO_CONFIG_FILE_ARG

        public static final String MSG_ERROR_NO_CONFIG_FILE_ARG
        The error message when no deploy-config file is given.
        See Also:
        Constant Field Values
      • MSG_ERROR_NO_NETARCHIVESUITE_FILE_ARG

        public static final String MSG_ERROR_NO_NETARCHIVESUITE_FILE_ARG
        The error message when no NetarchiveSuite file is given.
        See Also:
        Constant Field Values
      • MSG_ERROR_NO_SECURITY_FILE_ARG

        public static final String MSG_ERROR_NO_SECURITY_FILE_ARG
        The error message when no security file is given.
        See Also:
        Constant Field Values
      • MSG_ERROR_NO_SLF4J_CONFIG_FILE_ARG

        public static final String MSG_ERROR_NO_SLF4J_CONFIG_FILE_ARG
        The error message when no slf4j log property file is given.
        See Also:
        Constant Field Values
      • MSG_ERROR_NO_CONFIG_FILE_FOUND

        public static final String MSG_ERROR_NO_CONFIG_FILE_FOUND
        The error message when config file does not exist.
        See Also:
        Constant Field Values
      • MSG_ERROR_NO_NETARCHIVESUITE_FILE_FOUND

        public static final String MSG_ERROR_NO_NETARCHIVESUITE_FILE_FOUND
        The error message when NetarchiveSuite file does not exist.
        See Also:
        Constant Field Values
      • MSG_ERROR_NO_SECURITY_FILE_FOUND

        public static final String MSG_ERROR_NO_SECURITY_FILE_FOUND
        The error message when security file does not exist.
        See Also:
        Constant Field Values
      • MSG_ERROR_NO_SLF4J_CONFIG_FILE_FOUND

        public static final String MSG_ERROR_NO_SLF4J_CONFIG_FILE_FOUND
        The error message when SLF4J config file does not exist.
        See Also:
        Constant Field Values
      • MSG_ERROR_NO_DATABASE_FILE_FOUND

        public static final String MSG_ERROR_NO_DATABASE_FILE_FOUND
        The error message when database file does not exist.
        See Also:
        Constant Field Values
      • MSG_ERROR_NO_BPDB_FILE_FOUND

        public static final String MSG_ERROR_NO_BPDB_FILE_FOUND
        The error message when archive database file does not exist.
        See Also:
        Constant Field Values
      • MSG_ERROR_NO_JAR_FOLDER

        public static final String MSG_ERROR_NO_JAR_FOLDER
        The error message when the folder with the external jar-library-files does not exist.
        See Also:
        Constant Field Values
      • MSG_ERROR_NO_HERITRIX3_CERTIFICATE_FILE

        public static final String MSG_ERROR_NO_HERITRIX3_CERTIFICATE_FILE
        See Also:
        Constant Field Values
      • MSG_ERROR_NO_BITMAG_FOLDER

        public static final String MSG_ERROR_NO_BITMAG_FOLDER
        The error message for missing bitmagasin source directory.
        See Also:
        Constant Field Values
      • MSG_ERROR_CONFIG_EXTENSION

        public static final String MSG_ERROR_CONFIG_EXTENSION
        The error message for wrong deploy-config file extension.
        See Also:
        Constant Field Values
      • MSG_ERROR_NETARCHIVESUITE_EXTENSION

        public static final String MSG_ERROR_NETARCHIVESUITE_EXTENSION
        The error message for wrong NetarchiveSuite file extension.
        See Also:
        Constant Field Values
      • MSG_ERROR_SECURITY_EXTENSION

        public static final String MSG_ERROR_SECURITY_EXTENSION
        The error message for wrong security file extension.
        See Also:
        Constant Field Values
      • MSG_ERROR_SLF4J_CONFIG_EXTENSION

        public static final String MSG_ERROR_SLF4J_CONFIG_EXTENSION
        The error message for wrong SLF4J config file extension.
        See Also:
        Constant Field Values
      • MSG_ERROR_DATABASE_EXTENSION

        public static final String MSG_ERROR_DATABASE_EXTENSION
        The error message for wrong database extension.
        See Also:
        Constant Field Values
      • MSG_ERROR_BPDB_EXTENSION

        public static final String MSG_ERROR_BPDB_EXTENSION
        The error message for wrong archive database extension.
        See Also:
        Constant Field Values
      • MSG_ERROR_TEST_ARGUMENTS

        public static final String MSG_ERROR_TEST_ARGUMENTS
        The error message when test wrong number of test arguments.
        See Also:
        Constant Field Values
      • MSG_ERROR_TEST_OFFSET

        public static final String MSG_ERROR_TEST_OFFSET
        The error message when offset value are too different from httpport.
        See Also:
        Constant Field Values
      • MSG_ERROR_RESET_ARGUMENT

        public static final String MSG_ERROR_RESET_ARGUMENT
        The error message when reset directory has wrong argument.
        See Also:
        Constant Field Values
      • MSG_ERROR_PHYSICAL_LOCATION_NO_NAME

        public static final String MSG_ERROR_PHYSICAL_LOCATION_NO_NAME
        The error message when a physical location has no name attribute.
        See Also:
        Constant Field Values
      • MSG_ERROR_ZIP_CANNONICAL_PATH

        public static final String MSG_ERROR_ZIP_CANNONICAL_PATH
        The error message when IOException during cannocial path of zip file.
        See Also:
        Constant Field Values
      • MSG_ERROR_INVALID_TEST_ENVIRONMENT_NAME

        public static final String MSG_ERROR_INVALID_TEST_ENVIRONMENT_NAME
        The error message when the environment name for the test instance is invalid.
        See Also:
        Constant Field Values
      • MSG_ERROR_INVALID_ENVIRONMENT_NAME

        public static final String MSG_ERROR_INVALID_ENVIRONMENT_NAME
        The error message when the environment name is invalid.
        See Also:
        Constant Field Values
      • MSG_ERROR_WAIT_FILE

        public static final String MSG_ERROR_WAIT_FILE
        The error message when the wait script file cannot be written.
        See Also:
        Constant Field Values
      • MSG_ERROR_RESTART_FILE

        public static final String MSG_ERROR_RESTART_FILE
        The error message when the restart script cannot be written.
        See Also:
        Constant Field Values
      • MSG_ERROR_DB_START_FILE

        public static final String MSG_ERROR_DB_START_FILE
        The error message when the db-start script cannot be written.
        See Also:
        Constant Field Values
      • MSG_ERROR_DB_KILL_FILE

        public static final String MSG_ERROR_DB_KILL_FILE
        The error message when the db-kill script cannot be written.
        See Also:
        Constant Field Values
      • MSG_WARN_TOO_MANY_JMXREMOTE_FILE_PATHS

        public static final String MSG_WARN_TOO_MANY_JMXREMOTE_FILE_PATHS
        The warning when more than one jmxremote.access or jmxremote.password file path is defined.
        See Also:
        Constant Field Values
      • MSG_WARN_ZIPFILE_ALREADY_EXISTS

        public static final String MSG_WARN_ZIPFILE_ALREADY_EXISTS
        The warning when the NetarchiveSuite file will be overridden, since another file with same name exists.
        See Also:
        Constant Field Values
    • Method Detail

      • changeToXMLBeginScope

        public static String changeToXMLBeginScope​(String scope)
                                            throws ArgumentNotValid
        Create the beginning of a scope in XML (e.g. html = \< html \>).
        Parameters:
        scope - The name of the XML-scope to have the start created.
        Returns:
        The beginning of the XML-scope.
        Throws:
        ArgumentNotValid - If the scope is null or empty.
      • changeToXMLEndScope

        public static String changeToXMLEndScope​(String scope)
                                          throws ArgumentNotValid
        Create the ending of a scope in XML (e.g. html = \< \html \>).
        Parameters:
        scope - The name of the XML-scope to have the end created.
        Returns:
        The ending of the XML-scope.
        Throws:
        ArgumentNotValid - If the scope is null or empty.
      • validEnvironmentName

        public static boolean validEnvironmentName​(String name)
                                            throws ArgumentNotValid
        Checks whether a string is valid for environment name. The string is checked against a regular expression.
        Parameters:
        name - The environment name to validate.
        Returns:
        Whether the environment name is valid.
        Throws:
        ArgumentNotValid - If the name is null or empty.