Class LogConstants


  • public class LogConstants
    extends Object
    Defines constants used in the Logging service. LogConstants helps in maintaining a central repository of all the constants used in the package.
    • Field Detail

      • MAX_FILE_SIZE

        public static final String MAX_FILE_SIZE
        Attribute defining the maximum (flat) file size, above which the files are either archived or rotated.
        See Also:
        Constant Field Values
      • LOG_LOCATION

        public static final String LOG_LOCATION
        Attribute defining the location where the logs go.
        See Also:
        Constant Field Values
      • DEF_FF_LOG_LOC_BASE

        public static final String DEF_FF_LOG_LOC_BASE
        Constant for the default base directory "prefix" for Flat File logging, indicating that the instance's Configuration directory + server URI should be used.
        See Also:
        Constant Field Values
      • BACKEND

        public static final String BACKEND
        Attribute defining whether the logs to be stored in flat-files or to a Database.
        See Also:
        Constant Field Values
      • DB_USER

        public static final String DB_USER
        Attribute defining the user name of the database (for authenticating to the Database)
        See Also:
        Constant Field Values
      • DB_PASSWORD

        public static final String DB_PASSWORD
        Attribute defining the password for the user of the db (for authenticating to DB)
        See Also:
        Constant Field Values
      • LOG_LIST

        public static final String LOG_LIST
        Attribute defining the currently present list of logs in the Directory.
        See Also:
        Constant Field Values
      • ALL_FIELDS

        public static final String ALL_FIELDS
        Attribute defining the set of all fields being logged. These fields are predefined to be time, Date, LoginID, Domain, LogLevel, Data, IPAddr, and HostName.
        See Also:
        Constant Field Values
      • LOG_FIELDS

        public static final String LOG_FIELDS
        Attribute defining the fields currently selected by the administrator to be logged.
        See Also:
        Constant Field Values
      • SYSLOG_HANDLER

        public static final String SYSLOG_HANDLER
        Attribute defining the Syslog Handler class.
        See Also:
        Constant Field Values
      • NUM_HISTORY_FILES

        public static final String NUM_HISTORY_FILES
        Attribute defining the number of history files a (flat file) log should have.
        See Also:
        Constant Field Values
      • DEFAULT_REMOTE_HANDER

        public static final String DEFAULT_REMOTE_HANDER
        Default value for remote handler class
        See Also:
        Constant Field Values
      • ELF_FORMATTER

        public static final String ELF_FORMATTER
        Attribute defining the ELFFormatter class. (OpenAM ELF Formatting. Hence FHandler should be associated with a ELFFormatter).
        See Also:
        Constant Field Values
      • REMOTE_FORMATTER

        public static final String REMOTE_FORMATTER
        Attribute defining the RemoteFormatter class which creates a xml string for a log action and sends it across to the remote OpenAM.
        See Also:
        Constant Field Values
      • DEFAULT_REMOTE_FORMATTER

        public static final String DEFAULT_REMOTE_FORMATTER
        Default value for remote formatter class
        See Also:
        Constant Field Values
      • SYSLOG_FORMATTER

        public static final String SYSLOG_FORMATTER
        Attribute defining the SyslogFormatter class
        See Also:
        Constant Field Values
      • AUTHZ

        public static final String AUTHZ
        Attribute defining the Authorization class used to see if a particular user is authorized to perform a particular task.
        See Also:
        Constant Field Values
      • TOKEN_PROVIDER

        public static final String TOKEN_PROVIDER
        Attribute defining the Token Class used to generate a Token internally for use within the logging components.
        See Also:
        Constant Field Values
      • LOGGING_SERVICE_URL

        public static final String LOGGING_SERVICE_URL
        Naming attribute defining the logging service url.
        See Also:
        Constant Field Values
      • LOGVERIFY_PERIODINSECONDS

        public static final String LOGVERIFY_PERIODINSECONDS
        Defines the secure LoggingService log verify period.
        See Also:
        Constant Field Values
      • LOGVERIFY_PERIODINSECONDS_DEFAULT

        public static final long LOGVERIFY_PERIODINSECONDS_DEFAULT
        See Also:
        Constant Field Values
      • LOGSIGN_PERIODINSECONDS

        public static final String LOGSIGN_PERIODINSECONDS
        Defines the LogSign period in seconds.
        See Also:
        Constant Field Values
      • LOGSIGN_PERIODINSECONDS_DEFAULT

        public static final long LOGSIGN_PERIODINSECONDS_DEFAULT
        See Also:
        Constant Field Values
      • SECURITY_STATUS

        public static final String SECURITY_STATUS
        Attribute defining the Log Security status; ON or OFF.
        See Also:
        Constant Field Values
      • SECURE_FILE_HANDLER

        public static final String SECURE_FILE_HANDLER
        Defines the Secure File Handler class.
        See Also:
        Constant Field Values
      • SECURE_ELF_FORMATTER

        public static final String SECURE_ELF_FORMATTER
        Defines the Secure ELF Formatter class.
        See Also:
        Constant Field Values
      • MAX_RECORDS

        public static final String MAX_RECORDS
        Attribute defining the maximum records for flat file logs. Also the default number of maximum records to be read.
        See Also:
        Constant Field Values
      • MAX_RECORDS_DEFAULT

        public static final String MAX_RECORDS_DEFAULT
        Default max records if none entered
        See Also:
        Constant Field Values
      • MAX_RECORDS_DEFAULT_INT

        public static final int MAX_RECORDS_DEFAULT_INT
        Default max records, int version
        See Also:
        Constant Field Values
      • FILES_PER_KEYSTORE

        public static final String FILES_PER_KEYSTORE
        Attribute defining the number of files per keystore after which the keystore should be reinitialized.
        See Also:
        Constant Field Values
      • VERIFIER_ACTION_CLASS

        public static final String VERIFIER_ACTION_CLASS
        Attribute defining the Class that implements what the Verifier does when verification fails
        See Also:
        Constant Field Values
      • LOGGER_CERT_STORE

        public static final String LOGGER_CERT_STORE
        Attribute defining the Directory where the logger certificate store is stored.
        See Also:
        Constant Field Values
      • DEBUG_IMPL_CLASS

        public static final String DEBUG_IMPL_CLASS
        Attribute defining the Class that implements the custom debug method in the case of log failure.
        See Also:
        Constant Field Values
      • DB_MEM_MAX_RECS

        public static final String DB_MEM_MAX_RECS
        Attribute defining the Maximum LogRecords held in memory if DB logging fails.
        See Also:
        Constant Field Values
      • TIME_BUFFERING_STATUS

        public static final String TIME_BUFFERING_STATUS
        Attribute defining the Time Buffering Status; ON or OFF.
        See Also:
        Constant Field Values
      • FILTER_CLASS_NAME

        public static final String FILTER_CLASS_NAME
        Attribute defining the Filter Class Name
        See Also:
        Constant Field Values
      • SECURE_TIMESTAMP_GENERATOR

        public static final String SECURE_TIMESTAMP_GENERATOR
        Attribute defining the Secure Timestamp generator class
        See Also:
        Constant Field Values
      • SECURE_LOG_HELPER

        public static final String SECURE_LOG_HELPER
        Attribute defining the secure log helper class
        See Also:
        Constant Field Values
      • SECURE_DEFAULT_LOG_HELPER

        public static final String SECURE_DEFAULT_LOG_HELPER
        Attribute defining the default secure log helper class
        See Also:
        Constant Field Values
      • SECURITY_INITIALIZER

        public static final String SECURITY_INITIALIZER
        Attribute defining the security initializer class name
        See Also:
        Constant Field Values
      • SECURITY_SIGNING_ALGORITHM

        public static final String SECURITY_SIGNING_ALGORITHM
        Attribute defining the security signing algorithm
        See Also:
        Constant Field Values
      • DEFAULT_SECURITY_SIGNING_ALGORITHM

        public static final String DEFAULT_SECURITY_SIGNING_ALGORITHM
        Attribute defining the default security signing algorithm
        See Also:
        Constant Field Values
      • LOGGING_LEVEL

        public static final String LOGGING_LEVEL
        Attribute defining the log file logging level
        See Also:
        Constant Field Values
      • ORA_DBDATA_FIELDTYPE

        public static final String ORA_DBDATA_FIELDTYPE
        Attribute defining the Oracle DB data type for the DATA field
        See Also:
        Constant Field Values
      • MYSQL_DBDATA_FIELDTYPE

        public static final String MYSQL_DBDATA_FIELDTYPE
        Attribute defining the MySQL DB data type for the DATA field
        See Also:
        Constant Field Values
      • ORA_DBDATETIME_FORMAT

        public static final String ORA_DBDATETIME_FORMAT
        Attribute defining the format for the Oracle DATE/TIME field
        See Also:
        Constant Field Values
      • MYSQL_DBDATETIME_FORMAT

        public static final String MYSQL_DBDATETIME_FORMAT
        Attribute defining the format for the MySQL DATE/TIME field
        See Also:
        Constant Field Values
      • SYSLOG_PROTOCOL

        public static final String SYSLOG_PROTOCOL
        Attribute defining syslog protocol, UDP or TCP.
        See Also:
        Constant Field Values
      • SYSLOG_CONNECTION_TIMEOUT

        public static final String SYSLOG_CONNECTION_TIMEOUT
        Attribute defining syslog connection timeout.
        See Also:
        Constant Field Values
      • LOG_LOCATION_SUBDIR

        public static final String LOG_LOCATION_SUBDIR
        Property defining Logging subdirectory.
        See Also:
        Constant Field Values
      • TIME

        public static final String TIME
        The Date/Time field. This field is one of the two required in any log record.
        See Also:
        Constant Field Values
      • DATA

        public static final String DATA
        The Data field. This field is one of the two required in any log record.
        See Also:
        Constant Field Values
      • LOG_LEVEL

        public static final String LOG_LEVEL
        The LogLevel field. The level at which the log record was logged.
        See Also:
        Constant Field Values
      • DOMAIN

        public static final String DOMAIN
        The Domain field. The AM Domain pertaining to the log record's Data field.
        See Also:
        Constant Field Values
      • LOGIN_ID

        public static final String LOGIN_ID
        The LoginID field. The AM Login ID pertaining to the log record's Data field.
        See Also:
        Constant Field Values
      • IP_ADDR

        public static final String IP_ADDR
        The IPAddr field. The IP Address pertaining to the log record's Data field.
        See Also:
        Constant Field Values
      • HOST_NAME

        public static final String HOST_NAME
        The HostName field. The HostName pertaining to the log record's Data field.
        See Also:
        Constant Field Values
      • MODULE_NAME

        public static final String MODULE_NAME
        The ModuleName field. The AM Module pertaining to the log record's Data field.
        See Also:
        Constant Field Values
      • LOGGED_BY

        public static final String LOGGED_BY
        The LoggedBy field. The ID associated with who logged the record.
        See Also:
        Constant Field Values
      • CONTEXT_ID

        public static final String CONTEXT_ID
        The ContextID field. The ID associated with the user's session that is the subject of this log record.
        See Also:
        Constant Field Values
      • NO_SESSION

        public static final String NO_SESSION
        The NoSession field. Whether the authentication request was made with the noSession query parameter and that no permanent session was created when the authentication was successful.
        See Also:
        Constant Field Values
      • MESSAGE_ID

        public static final String MESSAGE_ID
        The MessageID field. The unique Message Identifier associated with this particular log record data field.
        See Also:
        Constant Field Values
      • NAME_ID

        public static final String NAME_ID
        The NameID field. The Name Identifier associated with this particular log record data field.
        See Also:
        Constant Field Values
      • MAX_FIELDS

        public static final int MAX_FIELDS
        The maximum number of fields in a "regular" record. Includes Time, Data, LogLevel, Domain, LoginID, IPAddr, HostName, ModuleName, LoggedBy, ContextID, MessageID, NameID. Be sure to increment if more fields are added.
        See Also:
        Constant Field Values
      • LOGFILENAMES

        public static final String[] LOGFILENAMES
      • LOG_RESOLVE_HOSTNAME

        public static final String LOG_RESOLVE_HOSTNAME
        Key name for enable/disable Hostname resolution
        See Also:
        Constant Field Values
      • LOG_RESOLVE_HOSTNAME_ATTR

        public static final String LOG_RESOLVE_HOSTNAME_ATTR
        Attribute name for enable/disable Hostname resolution
        See Also:
        Constant Field Values
      • NOTAVAIL

        public static final String NOTAVAIL
        the "Not Available" String for when a field is not provided
        See Also:
        Constant Field Values
      • DEFAULT_LOGGING_LEVEL_STR

        public static final String DEFAULT_LOGGING_LEVEL_STR
        default logging level
        See Also:
        Constant Field Values
      • DEFAULT_LOGGING_LEVEL

        public static final Level DEFAULT_LOGGING_LEVEL
      • START_LOG_NEW_LOGGER_NAME

        public static final String START_LOG_NEW_LOGGER_NAME
        logging start due to container starting
        See Also:
        Constant Field Values
      • START_LOG_CONFIG_NAME

        public static final String START_LOG_CONFIG_NAME
        logging start due to logging configuration change
        See Also:
        Constant Field Values
      • END_LOG_CONFIG_NAME

        public static final String END_LOG_CONFIG_NAME
        logging termination due to logging configuration change
        See Also:
        Constant Field Values
      • SYS_PROP_LOG_DIR

        public static final String SYS_PROP_LOG_DIR
        System properties which specifies the log directory.
        See Also:
        Constant Field Values
      • LOGFILE_PREFIX

        public static final String LOGFILE_PREFIX
        Attribute defining the prefix for the logfiles
        See Also:
        Constant Field Values
      • LOGFILE_SUFFIX

        public static final String LOGFILE_SUFFIX
        Attribute defining the suffix for the logfiles. This should be a valid dateformat string.
        See Also:
        Constant Field Values
      • LOGFILE_ROTATION

        public static final String LOGFILE_ROTATION
        Attribute defining the rotation interval in minutes.
        See Also:
        Constant Field Values
      • ENABLE_ROTATION

        public static final String ENABLE_ROTATION
        Key name for enable/disable log rotation.
        See Also:
        Constant Field Values
    • Constructor Detail

      • LogConstants

        public LogConstants()