/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at opensso/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* $Id: LogConstants.java,v 1.16 2008/09/18 22:56:31 veiming Exp $
*
* Portions Copyrighted 2011-2015 ForgeRock AS.
* Portions Copyrighted 2013 Cybernetica AS.
* Portions Copyrighted 2014 Nomura Research Institute, Ltd
*/
/**
* Defines constants used in the Logging service. <tt> LogConstants </TT>
* helps in maintaining a central repository of all the constants used in the
* package.
* @supported.api
*/
public class LogConstants {
/**
* Attribute defining the maximum (flat) file size, above which
* the files are either archived or rotated.
* @supported.api
*/
"iplanet-am-logging-max-file-size";
/**
* Attribute defining the location where the logs go.
* @supported.api
*/
/**
* Constant for the default base directory "prefix"
* for Flat File logging, indicating that the instance's
* Configuration directory + server URI should be used.
*/
/**
* Attribute defining whether the logs to be stored in
* flat-files or to a Database.
* @supported.api
*/
/**
* Attribute defining the user name of the database (for
* authenticating to the Database)
*/
/**
* Attribute defining the password for the user of the db
* (for authenticating to DB)
*/
/**
* Attribute defining the Database Driver.
* @supported.api
*/
/**
* Attribute defining the currently present list of logs in the Directory.
*/
/**
* Attribute defining the set of all fields being logged. These fields are
* predefined to be time, Date, LoginID, Domain, LogLevel, Data, IPAddr,
* and HostName.
* @supported.api
*/
/**
* Attribute defining the fields currently selected by the administrator
* to be logged.
* @supported.api
*/
/**
* Attribute defining the FileHandler class
*/
"iplanet-am-logging-file-handler";
/**
* Attribute defining the Database Handler class
*/
/**
* Attribute defining the Syslog Handler class.
*/
/**
* Attribute defining the number of history files a (flat file)
* log should have.
* @supported.api
*/
"iplanet-am-logging-num-hist-file";
/**
* Attribute defining the RemoteHandler class
*/
"iplanet-am-logging-remote-handler";
/**
* Default value for remote handler class
*/
"com.sun.identity.log.handlers.RemoteHandler";
/**
* Attribute defining the ELFFormatter class.
* (OpenAM ELF Formatting. Hence FHandler
* should be associated with a ELFFormatter).
*/
"iplanet-am-logging-elf-formatter";
/**
* Attribute defining the RemoteFormatter class which creates a
* xml string for a log action and sends it across to the remote
* OpenAM.
*/
"iplanet-am-logging-remote-formatter";
/**
* Default value for remote formatter class
*/
"com.sun.identity.log.handlers.RemoteFormatter";
/**
* Attribute defining the DBFormatter class
*/
"iplanet-am-logging-db-formatter";
/**
* Attribute defining the SyslogFormatter class
*/
/**
* Attribute defining the Authorization class used to see if a particular
* user is authorized to perform a particular task.
*/
/**
* Attribute defining the Token Class used to generate a Token internally
* for use within the logging components.
*/
"iplanet-am-logging-token-class";
/**
* Attribute defining the Archiver class
*
*/
/**
* Platform attribute defining the locale
*/
"iplanet-am-platform-locale";
/**
* Naming attribute defining the logging service url.
*/
"iplanet-am-naming-logging-url";
/**
* Defines CarriageReturn/LineFeed characters.
* @supported.api
*/
/**
* Defines the LoggingService name.
* @supported.api
*/
/**
* Defines the LoggingService name.
*/
/**
* Defines the LoggingService name.
*/
/**
* Defines the secure LoggingService log verify period.
*/
"iplanet-am-logging-verify-period-in-seconds";
/**
* Defines the LogSign period in seconds.
*/
"iplanet-am-logging-signature-period-in-seconds";
/**
* Attribute defining the Log Security status; ON or OFF.
*/
"iplanet-am-logging-security-status";
/**
* Defines the File Read Handler class.
*/
"iplanet-am-logging-file-read-handler";
/**
* Defines the Secure File Handler class.
*/
"iplanet-am-logging-secure-file-handler";
/**
* Defines the Secure ELF Formatter class.
*/
"iplanet-am-logging-secure-elf-formatter";
/**
* Defines the DB Read Handler class.
*/
"sun-am-logging-db-read-handler";
/**
* Attribute defining the maximum records for flat file logs.
* Also the default number of maximum records to be read.
*/
/**
* Default max records if none entered
*/
/**
* Default max records, int version
*/
/**
* Attribute defining the number of files per keystore after which
* the keystore should be reinitialized.
*/
"iplanet-am-logging-files-per-keystore";
/**
* Attribute defining the Class that implements what the
* Verifier does when verification fails
*/
"iplanet-am-logging-verifier-action-class";
/**
* Attribute defining the Directory where the logger certificate
* store is stored.
*/
"iplanet-am-logging-secure-certificate-store";
/**
* Attribute defining the Class that implements the custom
* debug method in the case of log failure.
* @supported.api
*/
"iplanet-am-logging-debug-class";
/**
* Logging property prefix.
*/
"iplanet-am-logging";
/**
* Attribute defining the Buffer size.
* @supported.api
*/
/**
* Attribute defining the Maximum LogRecords held in memory if
* DB logging fails.
* @supported.api
*/
"sun-am-logging-db-max-in-mem";
/**
* Attribute defining the Buffering time.
* @supported.api
*/
"iplanet-am-logging-buffer-time-in-seconds";
/**
* Attribute defining the Time Buffering Status; ON or OFF.
* @supported.api
*/
"iplanet-am-logging-time-buffering-status";
/**
* Attribute defining the Filter Class Name
*/
"iplanet-am-logging-filter-class-name";
/**
* Attribute defining the Secure Timestamp generator class
*/
"iplanet-am-logging-secure-timestamp-generator";
/**
* Attribute defining the secure log helper class
*/
"iplanet-am-logging-secure-log-helper-class-name";
/**
* Attribute defining the default secure log helper class
*/
"com.sun.identity.log.secure.SecureLogHelperJSSImpl";
/**
* Attribute defining the security initializer class name
*/
"iplanet-am-logging-security-initializer-class-name";
/**
* Attribute defining the security signing algorithm
*/
"iplanet-am-logging-secure-signing-algorithm";
/**
* Attribute defining the default security signing algorithm
*/
"SHA1withRSA";
/**
* Attribute defining the log file logging level
*/
/**
* Attribute defining the Oracle DB data type for the DATA field
*/
"sun-am-logging-oradbdata-fieldtype";
/**
* Attribute defining the MySQL DB data type for the DATA field
*/
"sun-am-logging-mysqldbdata-fieldtype";
/**
*/
"sun-am-logging-ora-dbdate-format";
/**
*/
"sun-am-logging-mysql-dbdate-format";
/**
* Attribute defining syslog host.
*/
/**
* Attribute defining syslog port.
*/
/**
* Attribute defining syslog protocol, UDP or TCP.
*/
/**
* Attribute defining syslog facility.
*/
/**
* Attribute defining syslog connection timeout.
*/
public static final String SYSLOG_CONNECTION_TIMEOUT = "iplanet-am-logging-syslog-connection-timeout";
/**
* Property defining whether logging is enabled
* @supported.api
*/
"com.iplanet.am.logstatus";
/**
* Property defining Logging subdirectory.
*/
"com.sun.identity.log.logSubdir";
/*
*logInfoMap keys
*/
/**
* any log record.
* @supported.api
*/
/**
* The Data field. This field is one of the two required in
* any log record.
* @supported.api
*/
/**
* The LogLevel field. The level at which the log record was
* logged.
* @supported.api
*/
/**
* The Domain field. The AM Domain pertaining to the log record's
* Data field.
* @supported.api
*/
/**
* The LoginID field. The AM Login ID pertaining to the log record's
* Data field.
* @supported.api
*/
/**
* The IPAddr field. The IP Address pertaining to the log record's
* Data field.
* @supported.api
*/
/**
* The HostName field. The HostName pertaining to the log record's
* Data field.
* @supported.api
*/
/**
* The ModuleName field. The AM Module pertaining to the log record's
* Data field.
* @supported.api
*/
/**
* The LoggedBy field. The ID associated with who logged the record.
* @supported.api
*/
/**
* The ContextID field. The ID associated with the user's session
* that is the subject of this log record.
* @supported.api
*/
/**
* 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.
*/
/**
* The MessageID field. The unique Message Identifier associated with
* this particular log record data field.
* @supported.api
*/
/**
* The NameID field. The Name Identifier associated with
* this particular log record data field.
* @supported.api
*/
/**
* 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.
* @supported.api
*/
"amAuthentication.access";
"amAuthentication.error";
"amPasswordReset.access";
ADMIN_ERROR };
/**
*/
"com.sun.identity.log.resolveHostName";
/**
*/
"resolveHostName";
/**
* Attribute name for logging status
*/
"logstatus";
/**
* the "Not Available" String for when a field is not provided
*/
/**
* default logging level
*/
/**
* logging start due to container starting
*/
"LOG_START_NEW_LOGGER";
/**
* logging ending due to container terminating
*/
/**
* logging start due to logging configuration change
*/
/**
* logging termination due to logging configuration change
*/
/**
* System properties which specifies the log directory.
*/
/**
* Attribute defining the prefix for the logfiles
*/
/**
* Attribute defining the suffix for the logfiles. This should be a valid
* dateformat string.
*/
/**
* Attribute defining the rotation interval in minutes.
*/
/**
*/
}