oracle.adf.share.logging
Class ADFLogger

java.lang.Object
  oracle.adf.share.logging.ADFLogger

public class ADFLogger
extends java.lang.Object

This is a wrapper class of java logger class. It adds ADF conveneience methods. All other java logger methods as well are available for user.

Since:

10.1.3

Field Summary

static java.lang.String	ADD_CONTEXT_DATA_TAG
static java.lang.String	ADF_ANALYTICS_LOGGER_NAME
static java.lang.String	ADF_LOGGER_MESSAGE_BUNDLE
static java.lang.String	ADF_MESSAGE_ACTION_DESC
static java.lang.String	ADF_MESSAGE_ACTION_NAME
static java.lang.String	ADF_MESSAGE_CONTEXT_DATA
static java.lang.String	ADF_MESSAGE_DEFAULT_CONTEXT_DATA
static java.lang.String	ADF_MESSAGE_DELIMITER
static java.lang.String	ADF_MESSAGE_PAYLOAD
static java.lang.String	ADF_MESSAGE_STATUS
static java.lang.String	ADF_ODL_LOGGER_NAME
static java.lang.String	ADF_PERF_LOGGER_NAME
static java.lang.String	ENTERRING_TAG
static java.util.logging.Level	ERROR
static java.lang.String	EXITING_TAG
static java.util.logging.Level	INTERNAL_ERROR
static java.util.logging.Level	NOTIFICATION
static java.util.logging.Level	TRACE
static java.util.logging.Level	WARNING

Constructor Summary

protected

ADFLogger(java.util.logging.Logger log) The sole private constructor

Method Summary

void	addContextData(java.lang.String actionName, java.util.HashMap<java.lang.String,java.lang.String> contextData)
void	addHandler(java.util.logging.Handler handler) Add a log Handler to receive logging messages.
void	begin(java.lang.String actionName, java.util.HashMap<java.lang.String,java.lang.String> contextData)
void	config(java.lang.String msg) Log a CONFIG message.
void	config(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg) Log a CONFIG message, with no arguments.
void	config(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object param1) Log a CONFIG message, with one object parameter.
void	config(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object[] params) Log a CONFIG message, with an array of object arguments.
static ADFLogger	createADFLogger(java.lang.Class c) Find or create a logger for a named subsystem.
static ADFLogger	createADFLogger(java.lang.Class c, java.lang.String resourceBundleName) Find or create a logger for a named subsystem.
static ADFLogger	createADFLogger(java.lang.Package p) Find or create a logger for a named subsystem.
static ADFLogger	createADFLogger(java.lang.Package p, java.lang.String resourceBundleName) Find or create a logger for a named subsystem.
static ADFLogger	createADFLogger(java.lang.String name) Find or create a logger for a named subsystem.
static ADFLogger	createADFLogger(java.lang.String name, java.lang.String resourceBundleName) Find or create a logger for a named subsystem.
void	end(java.lang.String actionName)
void	entering(java.lang.String sourceClass, java.lang.String sourceMethod) Log a method entry.
void	entering(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.Object param1) Log a method entry, with one parameter.
void	entering(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.Object[] params) Log a method entry, with an array of parameters.
void	exiting(java.lang.String sourceClass, java.lang.String sourceMethod) Log a method return.
void	exiting(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.Object result) Log a method return, with result object.
void	fine(java.lang.String msg) Log a FINE message.
void	fine(java.lang.String message, java.lang.Object param) Log a fine level message with one parameter
void	fine(java.lang.String message, java.lang.Object[] params) Log a fine level message with its parameters
void	fine(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg) Log a FINE message, with no arguments.
void	fine(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object param1) Log a FINE message, with one object parameter.
void	fine(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object[] params) Log a FINE message, with an array of object arguments.
void	fine(java.lang.String message, java.lang.Throwable t) Log a fine level message for the throwable object
void	fine(java.lang.Throwable t) Log a fine level message for the throwable object
void	finer(java.lang.String msg) Log a FINER message.
void	finer(java.lang.String message, java.lang.Object param) Log a finer level message with one parameter
void	finer(java.lang.String message, java.lang.Object[] params) Log a finer level message with its parameters
void	finer(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg) Log a FINER message, with no arguments.
void	finer(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object param1) Log a FINER message, with one object parameter.
void	finer(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object[] params) Log a FINER message, with an array of object arguments.
void	finer(java.lang.String message, java.lang.Throwable t) Log a finer level message for the throwable object
void	finer(java.lang.Throwable t) Log a finer level message for the throwable object
void	finest(java.lang.String msg) Log a FINEST message.
void	finest(java.lang.String message, java.lang.Object param) Log a finest message with one parameter
void	finest(java.lang.String message, java.lang.Object[] params) Log a finest message with its parameters
void	finest(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg) Log a FINEST message, with no arguments.
void	finest(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object param1) Log a FINEST message, with one object parameter.
void	finest(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object[] params) Log a FINEST message, with an array of object arguments.
void	finest(java.lang.String message, java.lang.Throwable t) Log a finest message for the throwable object
void	finest(java.lang.Throwable t) Log a finest message for the throwable object
static void	flush() This API is called by either a standalone application or a devleopment framework(like ADF) to flush performance logging and business analytics logging contents for each individual request.
static ADFLogger	getAnonymousLogger() Create an anonymous Logger.
static ADFLogger	getAnonymousLogger(java.lang.String resourceBundleName) Create an anonymous Logger.
static java.lang.String	getECID() Deprecated. 1. If want to get current ECID string, replace with oracle.adf.share.logging.internal.LoggingUtils.getECID(); 2. If want to pass ecid from parent to child thread, call newChildExecutionContext();
java.util.logging.Filter	getFilter() Get the current filter for this Logger.
java.lang.String	getFormattedMessage(java.lang.String msg) Return a formatted message.
java.lang.String	getFormattedMessage(java.lang.String msg, java.lang.Object[] params) Return a formatted message.
java.util.logging.Handler[]	getHandlers() Get the Handlers associated with this logger.
java.util.logging.Level	getLevel() Get the log Level that has been specified for this Logger.
java.util.logging.Logger	getLogger() Get the Java logger from ADF Logger
java.lang.String	getName() Get the name for this logger.
java.util.logging.Logger	getParent() Return the parent for this Logger.
java.util.ResourceBundle	getResourceBundle() Retrieve the localization resource bundle for this logger for the current default locale.
java.lang.String	getResourceBundleName() Retrieve the localization resource bundle name for this logger.
boolean	getUseParentHandlers() Discover whether or not this logger is sending its output to its parent logger.
void	info(java.lang.String msg) Log an INFO message.
void	info(java.lang.String message, java.lang.Object param) Log an info level message with one parameter
void	info(java.lang.String message, java.lang.Object[] params) Log an info level message with its parameters
void	info(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg) Log a INFO message, with no arguments.
void	info(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object param1) Log a INFO message, with one object parameter.
void	info(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object[] params) Log a INFO message, with an array of object arguments.
void	info(java.lang.String message, java.lang.Throwable t) Log an info level message for the throwable object
void	info(java.lang.Throwable t) Log an info level message for the throwable object
void	internal(java.lang.String message, java.lang.Object param) Log an internal error for the message with one parameter
void	internal(java.lang.String message, java.lang.Object[] params) Log an internal error for the message with its parameters
void	internal(java.lang.String message, java.lang.Throwable t) Log an internal error for the message and the throwable object
void	internal(java.lang.Throwable t) Log an internal error for the throwable object
boolean	isConfig() Returns true if config messages should be logged.
boolean	isFine() Returns true if fine messages should be logged.
boolean	isFiner() Returns true if finer messages should be logged.
boolean	isFinest() Returns true if finest messages should be logged.
boolean	isInfo() Returns true if info messages should be logged.
boolean	isInternal() Returns true if InternalError messages should be logged.
boolean	isLoggable(java.util.logging.Level level) Check if a message of the given level would actually be logged by this logger.
boolean	isSevere() Returns true if severe messages should be logged.
boolean	isWarning() Returns true if warning messages should be logged.
void	log(java.util.logging.Level level, java.lang.String msg) Log a message, with no arguments.
void	log(java.util.logging.Level level, java.lang.String msg, java.lang.Object param1) Log a message, with one object parameter.
void	log(java.util.logging.Level level, java.lang.String msg, java.lang.Object[] params) Log a message, with an array of object arguments.
void	log(java.util.logging.Level level, java.lang.String msg, java.lang.Object[] params, java.lang.Throwable thrown) Log a message, with associated Throwable information.
void	log(java.util.logging.Level level, java.lang.String msg, java.lang.Throwable thrown) Log a message, with associated Throwable information.
void	log(java.util.logging.LogRecord record) Log a LogRecord.
void	log(java.lang.String msg) Log a message, with no arguments.
void	logp(java.util.logging.Level level, java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg) Log a message, specifying source class and method, with no arguments.
void	logp(java.util.logging.Level level, java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object param1) Log a message, specifying source class and method, with a single object parameter to the log message.
void	logp(java.util.logging.Level level, java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object[] params) Log a message, specifying source class and method, with an array of object arguments.
void	logp(java.util.logging.Level level, java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object[] params, java.lang.Throwable thrown) Log a message, specifying source class and method, with associated Throwable information.
void	logp(java.util.logging.Level level, java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object params1, java.lang.Object params2, java.lang.Object params3) Log a message, with an list of object arguments.
void	logp(java.util.logging.Level level, java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Throwable thrown) Log a message, specifying source class and method, with associated Throwable information.
void	logrb(java.util.logging.Level level, java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String bundleName, java.lang.String msg) Log a message, specifying source class, method, and resource bundle name with no arguments.
void	logrb(java.util.logging.Level level, java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String bundleName, java.lang.String msg, java.lang.Object param1) Log a message, specifying source class, method, and resource bundle name, with a single object parameter to the log message.
void	logrb(java.util.logging.Level level, java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String bundleName, java.lang.String msg, java.lang.Object[] params) Log a message, specifying source class, method, and resource bundle name, with an array of object arguments.
void	logrb(java.util.logging.Level level, java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String bundleName, java.lang.String msg, java.lang.Object[] params, java.lang.Throwable thrown) Log a message, specifying source class, method, and resource bundle name, with associated Throwable information.
void	logrb(java.util.logging.Level level, java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String bundleName, java.lang.String msg, java.lang.Throwable thrown) Log a message, specifying source class, method, and resource bundle name, with associated Throwable information.
void	removeHandler(java.util.logging.Handler handler) Remove a log Handler.
static void	setECID(java.lang.String ecid) Deprecated. The pair of getECID(), setECID() should be replaced by newChildExecutionContext(), setExecutionContext(), and deactivateExecutionContext()
void	setFilter(java.util.logging.Filter newFilter) Set a filter to control output on this Logger.
void	setLevel(java.util.logging.Level newLevel) Set the log level specifying which message levels will be logged by this logger.
void	setParent(java.util.logging.Logger parent) Set the parent for this Logger.
void	setUseParentHandlers(boolean useParentHandlers) Specify whether or not this logger should send its output to it's parent Logger.
void	severe(java.lang.String msg) Log a SEVERE message.
void	severe(java.lang.String message, java.lang.Object param) Log a severe level message with one parameter
void	severe(java.lang.String message, java.lang.Object[] params) Log a severe level message with its parameters
void	severe(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg) Log a SEVERE message, with no arguments.
void	severe(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object param1) Log a SEVERE message, with one object parameter.
void	severe(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object[] params) Log a SEVERE message, with an array of object arguments.
void	severe(java.lang.String message, java.lang.Throwable t) Log a severe level message for the throwable object
void	severe(java.lang.Throwable t) Log a severe level message for the throwable object
void	throwing(java.util.logging.Level level, java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.Throwable thrown) Log throwing an exception.
void	throwing(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.Throwable thrown) Log throwing an exception.
void	warning(java.lang.String msg) Log a WARNING message.
void	warning(java.lang.String message, java.lang.Object param) Log a warning message with one parameter
void	warning(java.lang.String message, java.lang.Object[] params) Log a warning message with its parameters
void	warning(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg) Log a WARNING message, with no arguments.
void	warning(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object param1) Log a WARNING message, with one object parameter.
void	warning(java.lang.String sourceClass, java.lang.String sourceMethod, java.lang.String msg, java.lang.Object[] params) Log a WARNING message, with an array of object arguments.
void	warning(java.lang.String message, java.lang.Throwable t) Log a waning message for the throwable object
void	warning(java.lang.Throwable t) Log a warning message for the throwable object

Methods inherited from class java.lang.Object

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

Field Detail

INTERNAL_ERROR

public static final java.util.logging.Level INTERNAL_ERROR

ERROR

public static final java.util.logging.Level ERROR

TRACE

public static final java.util.logging.Level TRACE

NOTIFICATION

public static final java.util.logging.Level NOTIFICATION

WARNING

public static final java.util.logging.Level WARNING

ENTERRING_TAG

public static final java.lang.String ENTERRING_TAG

See Also:

Constant Field Values

EXITING_TAG

public static final java.lang.String EXITING_TAG

See Also:

Constant Field Values

ADD_CONTEXT_DATA_TAG

public static final java.lang.String ADD_CONTEXT_DATA_TAG

See Also:

Constant Field Values

ADF_MESSAGE_DELIMITER

public static final java.lang.String ADF_MESSAGE_DELIMITER

See Also:

Constant Field Values

ADF_MESSAGE_STATUS

public static final java.lang.String ADF_MESSAGE_STATUS

See Also:

Constant Field Values

ADF_MESSAGE_ACTION_NAME

public static final java.lang.String ADF_MESSAGE_ACTION_NAME

See Also:

Constant Field Values

ADF_MESSAGE_ACTION_DESC

public static final java.lang.String ADF_MESSAGE_ACTION_DESC

See Also:

Constant Field Values

ADF_MESSAGE_PAYLOAD

public static final java.lang.String ADF_MESSAGE_PAYLOAD

See Also:

Constant Field Values

ADF_MESSAGE_CONTEXT_DATA

public static final java.lang.String ADF_MESSAGE_CONTEXT_DATA

See Also:

Constant Field Values

ADF_MESSAGE_DEFAULT_CONTEXT_DATA

public static final java.lang.String ADF_MESSAGE_DEFAULT_CONTEXT_DATA

See Also:

Constant Field Values

ADF_ANALYTICS_LOGGER_NAME

public static final java.lang.String ADF_ANALYTICS_LOGGER_NAME

See Also:

Constant Field Values

ADF_PERF_LOGGER_NAME

public static final java.lang.String ADF_PERF_LOGGER_NAME

See Also:

Constant Field Values

ADF_ODL_LOGGER_NAME

public static final java.lang.String ADF_ODL_LOGGER_NAME

See Also:

Constant Field Values

ADF_LOGGER_MESSAGE_BUNDLE

public static final java.lang.String ADF_LOGGER_MESSAGE_BUNDLE

See Also:

Constant Field Values

Constructor Detail

ADFLogger

protected ADFLogger(java.util.logging.Logger log)

The sole private constructor

Parameters:

log - The java.util.logging.Logger object to wrap with

Method Detail

getLogger

public java.util.logging.Logger getLogger()

Get the Java logger from ADF Logger

Returns:

a java logger instance

createADFLogger

public static ADFLogger createADFLogger(java.lang.String name)

Find or create a logger for a named subsystem. If a logger has already been created with the given name it is returned. Otherwise a new logger is created.

If a new logger is created its log level will be configured based on the LogManager configuration and it will configured to also send logging output to its parent's handlers. It will be registered in the LogManager global namespace.

Parameters:

name - A name for the logger. This should be a dot-separated name and should normally be based on the package name or class name of the subsystem, such as java.net or javax.swing

Returns:

a suitable Logger

createADFLogger

public static ADFLogger createADFLogger(java.lang.String name,
                                        java.lang.String resourceBundleName)

Find or create a logger for a named subsystem. If a logger has already been created with the given name it is returned. Otherwise a new logger is created.

If a new logger is created its log level will be configured based on the LogManager and it will configured to also send logging output to its parent loggers Handlers. It will be registered in the LogManager global namespace.

If the named Logger already exists and does not yet have a localization resource bundle then the given resource bundle name is used. If the named Logger already exists and has a different resource bundle name then an IllegalArgumentException is thrown.

Parameters:

name - A name for the logger. This should be a dot-separated name and should normally be based on the package name or class name of the subsystem, such as java.net or javax.swing

resourceBundleName - name of ResourceBundle to be used for localizing messages for this logger.

Returns:

a suitable Logger

Throws:

java.util.MissingResourceException - if the named ResourceBundle cannot be found.

java.lang.IllegalArgumentException - if the Logger already exists and uses a different resource bundle name.

createADFLogger

public static ADFLogger createADFLogger(java.lang.Class c)

Find or create a logger for a named subsystem. If a logger has already been created with the given name it is returned. Otherwise a new logger is created.

If a new logger is created its log level will be configured based on the LogManager configuration and it will configured to also send logging output to its parent's handlers. It will be registered in the LogManager global namespace.

Parameters:

c - A class instance for the logger.

Returns:

a suitable Logger

createADFLogger

public static ADFLogger createADFLogger(java.lang.Class c,
                                        java.lang.String resourceBundleName)

Find or create a logger for a named subsystem. If a logger has already been created with the given name it is returned. Otherwise a new logger is created.

If a new logger is created its log level will be configured based on the LogManager configuration and it will configured to also send logging output to its parent's handlers. It will be registered in the LogManager global namespace.

Parameters:

c - A class instance for the logger.

resourceBundleName - name of ResourceBundle to be used for localizing messages for this logger.

Returns:

a suitable Logger

createADFLogger

public static ADFLogger createADFLogger(java.lang.Package p)

Find or create a logger for a named subsystem. If a logger has already been created with the given name it is returned. Otherwise a new logger is created.

If a new logger is created its log level will be configured based on the LogManager configuration and it will configured to also send logging output to its parent's handlers. It will be registered in the LogManager global namespace.

Parameters:

p - A Package instance for the logger.

Returns:

a suitable Logger

createADFLogger

public static ADFLogger createADFLogger(java.lang.Package p,
                                        java.lang.String resourceBundleName)

Find or create a logger for a named subsystem. If a logger has already been created with the given name it is returned. Otherwise a new logger is created.

If a new logger is created its log level will be configured based on the LogManager configuration and it will configured to also send logging output to its parent's handlers. It will be registered in the LogManager global namespace.

Parameters:

p - A Package instance for the logger.

resourceBundleName - name of ResourceBundle to be used for localizing messages for this logger.

Returns:

a suitable Logger

getAnonymousLogger

public static ADFLogger getAnonymousLogger()

Create an anonymous Logger. The newly created Logger is not registered in the LogManager namespace. There will be no access checks on updates to the logger.

This factory method is primarily intended for use from applets. Because the resulting Logger is anonymous it can be kept private by the creating class. This removes the need for normal security checks, which in turn allows untrusted applet code to update the control state of the Logger. For example an applet can do a setLevel or an addHandler on an anonymous Logger.

Even although the new logger is anonymous, it is configured to have the root logger ("") as its parent. This means that by default it inherits its effective level and handlers from the root logger.

Returns:

a newly created private Logger

getAnonymousLogger

public static ADFLogger getAnonymousLogger(java.lang.String resourceBundleName)

Create an anonymous Logger. The newly created Logger is not registered in the LogManager namespace. There will be no access checks on updates to the logger.

This factory method is primarily intended for use from applets. Because the resulting Logger is anonymous it can be kept private by the creating class. This removes the need for normal security checks, which in turn allows untrusted applet code to update the control state of the Logger. For example an applet can do a setLevel or an addHandler on an anonymous Logger.

Even although the new logger is anonymous, it is configured to have the root logger ("") as its parent. This means that by default it inherits its effective level and handlers from the root logger.

Parameters:

resourceBundleName - name of ResourceBundle to be used for localizing messages for this logger.

Returns:

a newly created private Logger

Throws:

java.util.MissingResourceException - if the named ResourceBundle cannot be found.

getResourceBundle

public java.util.ResourceBundle getResourceBundle()

Retrieve the localization resource bundle for this logger for the current default locale. Note that if the result is null, then the Logger will use a resource bundle inherited from its parent.

Returns:

localization bundle (may be null)

getResourceBundleName

public java.lang.String getResourceBundleName()

Retrieve the localization resource bundle name for this logger. Note that if the result is null, then the Logger will use a resource bundle name inherited from its parent.

Returns:

localization bundle name (may be null)

setFilter

public void setFilter(java.util.logging.Filter newFilter)
               throws java.lang.SecurityException

Set a filter to control output on this Logger.

After passing the initial "level" check, the Logger will call this Filter to check if a log record should really be published.

Parameters:

newFilter - a filter object (may be null)

Throws:

java.lang.SecurityException - if a security manager exists and if the caller does not have LoggingPermission("control").

getFilter

public java.util.logging.Filter getFilter()

Get the current filter for this Logger.

Returns:

a filter object (may be null)

log

public void log(java.util.logging.LogRecord record)

Log a LogRecord.

All the other logging methods in this class call through this method to actually perform any logging. Subclasses can override this single method to capture all log activity.

Parameters:

record - the LogRecord to be published

log

public void log(java.lang.String msg)

Log a message, with no arguments.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message (or a key in the message catalog)

log

public void log(java.util.logging.Level level,
                java.lang.String msg)

Log a message, with no arguments.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

level - One of the message level identifiers, e.g. SEVERE

msg - The string message (or a key in the message catalog)

log

public void log(java.util.logging.Level level,
                java.lang.String msg,
                java.lang.Object param1)

Log a message, with one object parameter.

If the logger is currently enabled for the given message level then a corresponding LogRecord is created and forwarded to all the registered output Handler objects.

Parameters:

level - One of the message level identifiers, e.g. SEVERE

msg - The string message (or a key in the message catalog)

param1 - parameter to the message

log

public void log(java.util.logging.Level level,
                java.lang.String msg,
                java.lang.Object[] params)

Log a message, with an array of object arguments.

If the logger is currently enabled for the given message level then a corresponding LogRecord is created and forwarded to all the registered output Handler objects.

Parameters:

level - One of the message level identifiers, e.g. SEVERE

msg - The string message (or a key in the message catalog)

params - array of parameters to the message

log

public void log(java.util.logging.Level level,
                java.lang.String msg,
                java.lang.Throwable thrown)

Log a message, with associated Throwable information.

If the logger is currently enabled for the given message level then the given arguments are stored in a LogRecord which is forwarded to all registered output handlers.

Note that the thrown argument is stored in the LogRecord thrown property, rather than the LogRecord parameters property. Thus is it processed specially by output Formatters and is not treated as a formatting parameter to the LogRecord message property.

Parameters:

level - One of the message level identifiers, e.g. SEVERE

msg - The string message (or a key in the message catalog)

thrown - Throwable associated with log message.

log

public void log(java.util.logging.Level level,
                java.lang.String msg,
                java.lang.Object[] params,
                java.lang.Throwable thrown)

Log a message, with associated Throwable information.

If the logger is currently enabled for the given message level then the given arguments are stored in a LogRecord which is forwarded to all registered output handlers.

Note that the thrown argument is stored in the LogRecord thrown property, rather than the LogRecord parameters property. Thus is it processed specially by output Formatters and is not treated as a formatting parameter to the LogRecord message property.

Parameters:

level - One of the message level identifiers, e.g. SEVERE

msg - The string message (or a key in the message catalog)

params - array of parameters to the message

thrown - Throwable associated with log message.

logp

public void logp(java.util.logging.Level level,
                 java.lang.String sourceClass,
                 java.lang.String sourceMethod,
                 java.lang.String msg)

Log a message, specifying source class and method, with no arguments.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

level - One of the message level identifiers, e.g. SEVERE

sourceClass - name of class that issued the logging request

sourceMethod - name of method that issued the logging request

msg - The string message (or a key in the message catalog)

logp

public void logp(java.util.logging.Level level,
                 java.lang.String sourceClass,
                 java.lang.String sourceMethod,
                 java.lang.String msg,
                 java.lang.Object param1)

Log a message, specifying source class and method, with a single object parameter to the log message.

If the logger is currently enabled for the given message level then a corresponding LogRecord is created and forwarded to all the registered output Handler objects.

Parameters:

level - One of the message level identifiers, e.g. SEVERE

sourceClass - name of class that issued the logging request

sourceMethod - name of method that issued the logging request

msg - The string message (or a key in the message catalog)

param1 - Parameter to the log message.

logp

public void logp(java.util.logging.Level level,
                 java.lang.String sourceClass,
                 java.lang.String sourceMethod,
                 java.lang.String msg,
                 java.lang.Object[] params)

Log a message, specifying source class and method, with an array of object arguments.

If the logger is currently enabled for the given message level then a corresponding LogRecord is created and forwarded to all the registered output Handler objects.

Parameters:

level - One of the message level identifiers, e.g. SEVERE

sourceClass - name of class that issued the logging request

sourceMethod - name of method that issued the logging request

msg - The string message (or a key in the message catalog)

params - Array of parameters to the message

logp

public void logp(java.util.logging.Level level,
                 java.lang.String sourceClass,
                 java.lang.String sourceMethod,
                 java.lang.String msg,
                 java.lang.Throwable thrown)

Log a message, specifying source class and method, with associated Throwable information.

If the logger is currently enabled for the given message level then the given arguments are stored in a LogRecord which is forwarded to all registered output handlers.

Note that the thrown argument is stored in the LogRecord thrown property, rather than the LogRecord parameters property. Thus is it processed specially by output Formatters and is not treated as a formatting parameter to the LogRecord message property.

Parameters:

level - One of the message level identifiers, e.g. SEVERE

sourceClass - name of class that issued the logging request

sourceMethod - name of method that issued the logging request

msg - The string message (or a key in the message catalog)

thrown - Throwable associated with log message.

logp

public void logp(java.util.logging.Level level,
                 java.lang.String sourceClass,
                 java.lang.String sourceMethod,
                 java.lang.String msg,
                 java.lang.Object[] params,
                 java.lang.Throwable thrown)

Log a message, specifying source class and method, with associated Throwable information.

If the logger is currently enabled for the given message level then the given arguments are stored in a LogRecord which is forwarded to all registered output handlers.

Note that the thrown argument is stored in the LogRecord thrown property, rather than the LogRecord parameters property. Thus is it processed specially by output Formatters and is not treated as a formatting parameter to the LogRecord message property.

Parameters:

level - One of the message level identifiers, e.g. SEVERE

sourceClass - name of class that issued the logging request

sourceMethod - name of method that issued the logging request

msg - The string message (or a key in the message catalog)

params - Array of parameters to the message

thrown - Throwable associated with log message.

logrb

public void logrb(java.util.logging.Level level,
                  java.lang.String sourceClass,
                  java.lang.String sourceMethod,
                  java.lang.String bundleName,
                  java.lang.String msg)

Log a message, specifying source class, method, and resource bundle name with no arguments.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

The msg string is localized using the named resource bundle. If the resource bundle name is null, then the msg string is not localized.

Parameters:

level - One of the message level identifiers, e.g. SEVERE

sourceClass - name of class that issued the logging request

sourceMethod - name of method that issued the logging request

bundleName - name of resource bundle to localize msg

msg - The string message (or a key in the message catalog)

Throws:

java.util.MissingResourceException - if no suitable ResourceBundle can be found.

logrb

public void logrb(java.util.logging.Level level,
                  java.lang.String sourceClass,
                  java.lang.String sourceMethod,
                  java.lang.String bundleName,
                  java.lang.String msg,
                  java.lang.Object param1)

Log a message, specifying source class, method, and resource bundle name, with a single object parameter to the log message.

If the logger is currently enabled for the given message level then a corresponding LogRecord is created and forwarded to all the registered output Handler objects.

The msg string is localized using the named resource bundle. If the resource bundle name is null, then the msg string is not localized.

Parameters:

level - One of the message level identifiers, e.g. SEVERE

sourceClass - name of class that issued the logging request

sourceMethod - name of method that issued the logging request

bundleName - name of resource bundle to localize msg

msg - The string message (or a key in the message catalog)

param1 - Parameter to the log message.

Throws:

java.util.MissingResourceException - if no suitable ResourceBundle can be found.

logrb

public void logrb(java.util.logging.Level level,
                  java.lang.String sourceClass,
                  java.lang.String sourceMethod,
                  java.lang.String bundleName,
                  java.lang.String msg,
                  java.lang.Object[] params)

Log a message, specifying source class, method, and resource bundle name, with an array of object arguments.

If the logger is currently enabled for the given message level then a corresponding LogRecord is created and forwarded to all the registered output Handler objects.

The msg string is localized using the named resource bundle. If the resource bundle name is null, then the msg string is not localized.

Parameters:

level - One of the message level identifiers, e.g. SEVERE

sourceClass - name of class that issued the logging request

sourceMethod - name of method that issued the logging request

bundleName - name of resource bundle to localize msg

msg - The string message (or a key in the message catalog)

params - Array of parameters to the message

Throws:

java.util.MissingResourceException - if no suitable ResourceBundle can be found.

logrb

public void logrb(java.util.logging.Level level,
                  java.lang.String sourceClass,
                  java.lang.String sourceMethod,
                  java.lang.String bundleName,
                  java.lang.String msg,
                  java.lang.Throwable thrown)

Log a message, specifying source class, method, and resource bundle name, with associated Throwable information.

If the logger is currently enabled for the given message level then the given arguments are stored in a LogRecord which is forwarded to all registered output handlers.

The msg string is localized using the named resource bundle. If the resource bundle name is null, then the msg string is not localized.

Note that the thrown argument is stored in the LogRecord thrown property, rather than the LogRecord parameters property. Thus is it processed specially by output Formatters and is not treated as a formatting parameter to the LogRecord message property.

Parameters:

level - One of the message level identifiers, e.g. SEVERE

sourceClass - name of class that issued the logging request

sourceMethod - name of method that issued the logging request

bundleName - name of resource bundle to localize msg

msg - The string message (or a key in the message catalog)

thrown - Throwable associated with log message.

Throws:

java.util.MissingResourceException - if no suitable ResourceBundle can be found.

logrb

public void logrb(java.util.logging.Level level,
                  java.lang.String sourceClass,
                  java.lang.String sourceMethod,
                  java.lang.String bundleName,
                  java.lang.String msg,
                  java.lang.Object[] params,
                  java.lang.Throwable thrown)

Log a message, specifying source class, method, and resource bundle name, with associated Throwable information.

If the logger is currently enabled for the given message level then the given arguments are stored in a LogRecord which is forwarded to all registered output handlers.

The msg string is localized using the named resource bundle. If the resource bundle name is null, then the msg string is not localized.

Note that the thrown argument is stored in the LogRecord thrown property, rather than the LogRecord parameters property. Thus is it processed specially by output Formatters and is not treated as a formatting parameter to the LogRecord message property.

Parameters:

level - One of the message level identifiers, e.g. SEVERE

sourceClass - name of class that issued the logging request

sourceMethod - name of method that issued the logging request

bundleName - name of resource bundle to localize msg

msg - The string message (or a key in the message catalog)

params - Array of parameters to the message

thrown - Throwable associated with log message.

Throws:

java.util.MissingResourceException - if no suitable ResourceBundle can be found.

begin

public void begin(java.lang.String actionName,
                  java.util.HashMap<java.lang.String,java.lang.String> contextData)

addContextData

public void addContextData(java.lang.String actionName,
                           java.util.HashMap<java.lang.String,java.lang.String> contextData)

end

public void end(java.lang.String actionName)

entering

public void entering(java.lang.String sourceClass,
                     java.lang.String sourceMethod)

Log a method entry.

This is a convenience method that can be used to log entry to a method. A LogRecord with message "ENTRY", log level FINER, and the given sourceMethod and sourceClass is logged.

Parameters:

sourceClass - name of class that issued the logging request

sourceMethod - name of method that is being entered

entering

public void entering(java.lang.String sourceClass,
                     java.lang.String sourceMethod,
                     java.lang.Object param1)

Log a method entry, with one parameter.

This is a convenience method that can be used to log entry to a method. A LogRecord with message "ENTRY {0}", log level FINER, and the given sourceMethod, sourceClass, and parameter is logged.

Parameters:

sourceClass - name of class that issued the logging request

sourceMethod - name of method that is being entered

param1 - parameter to the method being entered

entering

public void entering(java.lang.String sourceClass,
                     java.lang.String sourceMethod,
                     java.lang.Object[] params)

Log a method entry, with an array of parameters.

This is a convenience method that can be used to log entry to a method. A LogRecord with message "ENTRY" (followed by a format {N} indicator for each entry in the parameter array), log level FINER, and the given sourceMethod, sourceClass, and parameters is logged.

Parameters:

sourceClass - name of class that issued the logging request

sourceMethod - name of method that is being entered

params - array of parameters to the method being entered

exiting

public void exiting(java.lang.String sourceClass,
                    java.lang.String sourceMethod)

Log a method return.

This is a convenience method that can be used to log returning from a method. A LogRecord with message "RETURN", log level FINER, and the given sourceMethod and sourceClass is logged.

Parameters:

sourceClass - name of class that issued the logging request

sourceMethod - name of the method

exiting

public void exiting(java.lang.String sourceClass,
                    java.lang.String sourceMethod,
                    java.lang.Object result)

Log a method return, with result object.

This is a convenience method that can be used to log returning from a method. A LogRecord with message "RETURN {0}", log level FINER, and the gives sourceMethod, sourceClass, and result object is logged.

Parameters:

sourceClass - name of class that issued the logging request

sourceMethod - name of the method

result - Object that is being returned

throwing

public void throwing(java.lang.String sourceClass,
                     java.lang.String sourceMethod,
                     java.lang.Throwable thrown)

Log throwing an exception.

This is a convenience method to log that a method is terminating by throwing an exception. The logging is done using the FINER level.

If the logger is currently enabled for the given message level then the given arguments are stored in a LogRecord which is forwarded to all registered output handlers. The LogRecord's message is set to "THROW".

Note that the thrown argument is stored in the LogRecord thrown property, rather than the LogRecord parameters property. Thus is it processed specially by output Formatters and is not treated as a formatting parameter to the LogRecord message property.

Parameters:

sourceClass - name of class that issued the logging request

sourceMethod - name of the method.

thrown - The Throwable that is being thrown.

severe

public void severe(java.lang.String msg)

Log a SEVERE message.

If the logger is currently enabled for the SEVERE message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message (or a key in the message catalog)

warning

public void warning(java.lang.String msg)

Log a WARNING message.

If the logger is currently enabled for the WARNING message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message (or a key in the message catalog)

info

public void info(java.lang.String msg)

Log an INFO message.

If the logger is currently enabled for the INFO message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message (or a key in the message catalog)

config

public void config(java.lang.String msg)

Log a CONFIG message.

If the logger is currently enabled for the CONFIG message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message (or a key in the message catalog)

fine

public void fine(java.lang.String msg)

Log a FINE message.

If the logger is currently enabled for the FINE message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message (or a key in the message catalog)

finer

public void finer(java.lang.String msg)

Log a FINER message.

If the logger is currently enabled for the FINER message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message (or a key in the message catalog)

finest

public void finest(java.lang.String msg)

Log a FINEST message.

If the logger is currently enabled for the FINEST message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message (or a key in the message catalog)

throwing

public void throwing(java.util.logging.Level level,
                     java.lang.String sourceClass,
                     java.lang.String sourceMethod,
                     java.lang.Throwable thrown)

Log throwing an exception. Comparing to Java Logging function Logger.throwing(sourceClass, sourceMethod, thrown) this function takes one more parameter "level" so that developers can specify the logging level of an exception. Developers should pass value for the "level" parameter using following convention,

Level.SEVERE -- Serious exceptions or error conditions such that an application can no longer run.

Level.WARNING -- Exceptions or errors that are not fatal, but an application will run with some problems.

Parameters:

level - Java Logging level

sourceClass - name of class that issued the logging request

sourceMethod - name of the method

thrown - The Throwable that is being thrown

severe

public void severe(java.lang.String sourceClass,
                   java.lang.String sourceMethod,
                   java.lang.String msg)

Log a SEVERE message, with no arguments.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

severe

public void severe(java.lang.String sourceClass,
                   java.lang.String sourceMethod,
                   java.lang.String msg,
                   java.lang.Object param1)

Log a SEVERE message, with one object parameter.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

param1 - a parameter to the message

severe

public void severe(java.lang.String sourceClass,
                   java.lang.String sourceMethod,
                   java.lang.String msg,
                   java.lang.Object[] params)

Log a SEVERE message, with an array of object arguments.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

params - an array of parameters to the message

warning

public void warning(java.lang.String sourceClass,
                    java.lang.String sourceMethod,
                    java.lang.String msg)

Log a WARNING message, with no arguments.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

warning

public void warning(java.lang.String sourceClass,
                    java.lang.String sourceMethod,
                    java.lang.String msg,
                    java.lang.Object param1)

Log a WARNING message, with one object parameter.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

param1 - a parameter to the message

warning

public void warning(java.lang.String sourceClass,
                    java.lang.String sourceMethod,
                    java.lang.String msg,
                    java.lang.Object[] params)

Log a WARNING message, with an array of object arguments.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

params - an array of parameters to the message

info

public void info(java.lang.String sourceClass,
                 java.lang.String sourceMethod,
                 java.lang.String msg)

Log a INFO message, with no arguments.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

info

public void info(java.lang.String sourceClass,
                 java.lang.String sourceMethod,
                 java.lang.String msg,
                 java.lang.Object param1)

Log a INFO message, with one object parameter.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

param1 - a parameter to the message

info

public void info(java.lang.String sourceClass,
                 java.lang.String sourceMethod,
                 java.lang.String msg,
                 java.lang.Object[] params)

Log a INFO message, with an array of object arguments.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

params - an array of parameters to the message

config

public void config(java.lang.String sourceClass,
                   java.lang.String sourceMethod,
                   java.lang.String msg)

Log a CONFIG message, with no arguments.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

config

public void config(java.lang.String sourceClass,
                   java.lang.String sourceMethod,
                   java.lang.String msg,
                   java.lang.Object param1)

Log a CONFIG message, with one object parameter.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

param1 - a parameter to the message

config

public void config(java.lang.String sourceClass,
                   java.lang.String sourceMethod,
                   java.lang.String msg,
                   java.lang.Object[] params)

Log a CONFIG message, with an array of object arguments.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

params - an array of parameters to the message

fine

public void fine(java.lang.String sourceClass,
                 java.lang.String sourceMethod,
                 java.lang.String msg)

Log a FINE message, with no arguments.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

fine

public void fine(java.lang.String sourceClass,
                 java.lang.String sourceMethod,
                 java.lang.String msg,
                 java.lang.Object param1)

Log a FINE message, with one object parameter.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

param1 - a parameter to the message

fine

public void fine(java.lang.String sourceClass,
                 java.lang.String sourceMethod,
                 java.lang.String msg,
                 java.lang.Object[] params)

Log a FINE message, with an array of object arguments.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

params - an array of parameters to the message

finer

public void finer(java.lang.String sourceClass,
                  java.lang.String sourceMethod,
                  java.lang.String msg)

Log a FINER message, with no arguments.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

finer

public void finer(java.lang.String sourceClass,
                  java.lang.String sourceMethod,
                  java.lang.String msg,
                  java.lang.Object param1)

Log a FINER message, with one object parameter.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

param1 - a parameter to the message

finer

public void finer(java.lang.String sourceClass,
                  java.lang.String sourceMethod,
                  java.lang.String msg,
                  java.lang.Object[] params)

Log a FINER message, with an array of object arguments.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

params - an array of parameters to the message

finest

public void finest(java.lang.String sourceClass,
                   java.lang.String sourceMethod,
                   java.lang.String msg)

Log a FINEST message, with no arguments.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

finest

public void finest(java.lang.String sourceClass,
                   java.lang.String sourceMethod,
                   java.lang.String msg,
                   java.lang.Object param1)

Log a FINEST message, with one object parameter.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

param1 - a parameter to the message

finest

public void finest(java.lang.String sourceClass,
                   java.lang.String sourceMethod,
                   java.lang.String msg,
                   java.lang.Object[] params)

Log a FINEST message, with an array of object arguments.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

params - an array of parameters to the message

logp

public void logp(java.util.logging.Level level,
                 java.lang.String sourceClass,
                 java.lang.String sourceMethod,
                 java.lang.String msg,
                 java.lang.Object params1,
                 java.lang.Object params2,
                 java.lang.Object params3)

Log a message, with an list of object arguments.

The message is forwarded to appropriate Java Logger objects.

Parameters:

sourceClass - the name of the class that issued the logging request

sourceMethod - the name of the method that issued the logging request

msg - the string message (or a key in the resource bundle)

params1 - Parameter 1 to the log message

params2 - Parameter 2 to the log message

params3 - Parameter 3 to the log message

setLevel

public void setLevel(java.util.logging.Level newLevel)
              throws java.lang.SecurityException

Set the log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded. The level value Level.OFF can be used to turn off logging.

If the new level is null, it means that this node should inherit its level from its nearest ancestor with a specific (non-null) level value.

Parameters:

newLevel - the new value for the log level (may be null)

Throws:

java.lang.SecurityException - if a security manager exists and if the caller does not have LoggingPermission("control").

getLevel

public java.util.logging.Level getLevel()

Get the log Level that has been specified for this Logger. The result may be null, which means that this logger's effective level will be inherited from its parent.

Returns:

this Logger's level

isLoggable

public boolean isLoggable(java.util.logging.Level level)

Check if a message of the given level would actually be logged by this logger. This check is based on the Loggers effective level, which may be inherited from its parent.

Parameters:

level - a message logging level

Returns:

true if the given message level is currently being logged.

getName

public java.lang.String getName()

Get the name for this logger.

Returns:

logger name. Will be null for anonymous Loggers.

addHandler

public void addHandler(java.util.logging.Handler handler)
                throws java.lang.SecurityException

Add a log Handler to receive logging messages.

By default, Loggers also send their output to their parent logger. Typically the root Logger is configured with a set of Handlers that essentially act as default handlers for all loggers.

Parameters:

handler - a logging Handler

Throws:

java.lang.SecurityException - if a security manager exists and if the caller does not have LoggingPermission("control").

removeHandler

public void removeHandler(java.util.logging.Handler handler)
                   throws java.lang.SecurityException

Remove a log Handler.

Returns silently if the given Handler is not found.

Parameters:

handler - a logging Handler

Throws:

java.lang.SecurityException - if a security manager exists and if the caller does not have LoggingPermission("control").

getHandlers

public java.util.logging.Handler[] getHandlers()

Get the Handlers associated with this logger.

Returns:

an array of all registered Handlers

setUseParentHandlers

public void setUseParentHandlers(boolean useParentHandlers)

Specify whether or not this logger should send its output to it's parent Logger. This means that any LogRecords will also be written to the parent's Handlers, and potentially to its parent, recursively up the namespace.

Parameters:

useParentHandlers - true if output is to be sent to the logger's parent.

Throws:

java.lang.SecurityException - if a security manager exists and if the caller does not have LoggingPermission("control").

getUseParentHandlers

public boolean getUseParentHandlers()

Discover whether or not this logger is sending its output to its parent logger.

Returns:

true if output is to be sent to the logger's parent

getParent

public java.util.logging.Logger getParent()

Return the parent for this Logger.

This method returns the nearest extant parent in the namespace. Thus if a Logger is called "a.b.c.d", and a Logger called "a.b" has been created but no logger "a.b.c" exists, then a call of getParent on the Logger "a.b.c.d" will return the Logger "a.b".

The result will be null if it is called on the root Logger in the namespace.

Returns:

nearest existing parent Logger

setParent

public void setParent(java.util.logging.Logger parent)

Set the parent for this Logger. This method is used by the LogManager to update a Logger when the namespace changes.

It should not be called from application code.

Parameters:

parent - the new parent logger

Throws:

java.lang.SecurityException - if a security manager exists and if the caller does not have LoggingPermission("control").

internal

public void internal(java.lang.Throwable t)

Log an internal error for the throwable object

Parameters:

t - the throwable object

internal

public void internal(java.lang.String message,
                     java.lang.Throwable t)

Log an internal error for the message and the throwable object

Parameters:

message - the error message to be logged

t - the throwable object

internal

public void internal(java.lang.String message,
                     java.lang.Object param)

Log an internal error for the message with one parameter

Parameters:

message - the error message to be logged

param - the parameter used in the message

internal

public void internal(java.lang.String message,
                     java.lang.Object[] params)

Log an internal error for the message with its parameters

Parameters:

message - the error message to be logged

params - the parameters used in the message

severe

public void severe(java.lang.Throwable t)

Log a severe level message for the throwable object

Parameters:

t - the throwable object

severe

public void severe(java.lang.String message,
                   java.lang.Throwable t)

Log a severe level message for the throwable object

Parameters:

message - the message to be logged

t - throwable object

severe

public void severe(java.lang.String message,
                   java.lang.Object param)

Log a severe level message with one parameter

Parameters:

message - the message to be logged

param - the parameter used in the message

severe

public void severe(java.lang.String message,
                   java.lang.Object[] params)

Log a severe level message with its parameters

Parameters:

message - the message to be logged

params - the parameters used in the message

warning

public void warning(java.lang.Throwable t)

Log a warning message for the throwable object

Parameters:

t - the throwable object

warning

public void warning(java.lang.String message,
                    java.lang.Throwable t)

Log a waning message for the throwable object

Parameters:

message - the message to be logged

t - the throwable object

warning

public void warning(java.lang.String message,
                    java.lang.Object param)

Log a warning message with one parameter

Parameters:

message - the message to be logged

param - the parameter used in the message

warning

public void warning(java.lang.String message,
                    java.lang.Object[] params)

Log a warning message with its parameters

Parameters:

message - the message to be logged

params - the parameters used in the message

info

public void info(java.lang.Throwable t)

Log an info level message for the throwable object

Parameters:

t - the throwable object

info

public void info(java.lang.String message,
                 java.lang.Throwable t)

Log an info level message for the throwable object

Parameters:

message - the message to be logged

t - the throwable object

info

public void info(java.lang.String message,
                 java.lang.Object param)

Log an info level message with one parameter

Parameters:

message - the message to be logged

param - the parameter used by message

info

public void info(java.lang.String message,
                 java.lang.Object[] params)

Log an info level message with its parameters

Parameters:

message - the message to be logged

params - the parameters used by message

fine

public void fine(java.lang.Throwable t)

Log a fine level message for the throwable object

Parameters:

t - the throwable object

fine

public void fine(java.lang.String message,
                 java.lang.Throwable t)

Log a fine level message for the throwable object

Parameters:

message - the message to be logged

t -

fine

public void fine(java.lang.String message,
                 java.lang.Object param)

Log a fine level message with one parameter

Parameters:

message - the message to be logged

param - the parameter used in the message

fine

public void fine(java.lang.String message,
                 java.lang.Object[] params)

Log a fine level message with its parameters

Parameters:

message - the message to be logged

params - the parameters used in the message

finer

public void finer(java.lang.Throwable t)

Log a finer level message for the throwable object

Parameters:

t - the throwable object

finer

public void finer(java.lang.String message,
                  java.lang.Throwable t)

Log a finer level message for the throwable object

Parameters:

message - the message to be logged

t - the throwable object

finer

public void finer(java.lang.String message,
                  java.lang.Object param)

Log a finer level message with one parameter

Parameters:

message - the message to be loggged

param - the parameter used in the message

finer

public void finer(java.lang.String message,
                  java.lang.Object[] params)

Log a finer level message with its parameters

Parameters:

message - the message to be logged

params - the parameters used in the message

finest

public void finest(java.lang.Throwable t)

Log a finest message for the throwable object

Parameters:

t - the throwable object

finest

public void finest(java.lang.String message,
                   java.lang.Throwable t)

Log a finest message for the throwable object

Parameters:

message - the message to be logged

t - the throwable object

finest

public void finest(java.lang.String message,
                   java.lang.Object param)

Log a finest message with one parameter

Parameters:

message - the message to be logged

param - the parameter used in the message

finest

public void finest(java.lang.String message,
                   java.lang.Object[] params)

Log a finest message with its parameters

Parameters:

message - the message to be logged

params - the parameters used in the message

isInternal

public boolean isInternal()

Returns true if InternalError messages should be logged.

isSevere

public boolean isSevere()

Returns true if severe messages should be logged.

isWarning

public boolean isWarning()

Returns true if warning messages should be logged.

isInfo

public boolean isInfo()

Returns true if info messages should be logged.

isConfig

public boolean isConfig()

Returns true if config messages should be logged.

isFine

public boolean isFine()

Returns true if fine messages should be logged.

isFiner

public boolean isFiner()

Returns true if finer messages should be logged.

isFinest

public boolean isFinest()

Returns true if finest messages should be logged.

flush

public static void flush()

This API is called by either a standalone application or a devleopment framework(like ADF) to flush performance logging and business analytics logging contents for each individual request. Normally an OC4J developer should not call this API directly.

getECID

@Deprecated
public static java.lang.String getECID()

Deprecated. 1. If want to get current ECID string, replace with oracle.adf.share.logging.internal.LoggingUtils.getECID(); 2. If want to pass ecid from parent to child thread, call newChildExecutionContext();

Get ECID for current running thread

Returns:

the ecid string

setECID

@Deprecated
public static void setECID(java.lang.String ecid)

Deprecated. The pair of getECID(), setECID() should be replaced by newChildExecutionContext(), setExecutionContext(), and deactivateExecutionContext()

Set ECID for current thread

Parameters:

ecid - the ecid string. Normally it can be retrieved from getECID from another thread which already has ecid set

getFormattedMessage

public java.lang.String getFormattedMessage(java.lang.String msg)

Return a formatted message.

Generates a localize message that can be pass to Exception

Parameters:

msg - The string message (or a key in the message catalog)

Returns:

formatted message

getFormattedMessage

public java.lang.String getFormattedMessage(java.lang.String msg,
                                            java.lang.Object[] params)

Return a formatted message.

Generates a localize message that can be pass to Exception

Parameters:

msg - The string message (or a key in the message catalog)

params - array of parameters to the message

Returns:

formatted message