oracle.adfinternal.model.logging.contextual

Class LogDomain<L extends BasicContextualLogger>

java.lang.Object

oracle.adfinternal.model.logging.contextual.LogDomain<L>

Type Parameters:

L - The speficic BasicContextualLogger implementation the domain will work with.

All Implemented Interfaces:

java.io.Serializable

public final class LogDomain<L extends BasicContextualLogger>
extends java.lang.Object
implements java.io.Serializable

Defines a logging domain, establishing a ADFContext-scoped namespace for loggers sharing one common root logger.

For example, if a logging domain is created having "oracle.adf" as the name of its root logger, then only the root logger itself or loggers whose names qualify subloggers (or subpackages) of "oracle.adf", such as "oracle.adf.model" or "oracle.adf.share.logging", will be allowed to join the domain.

Member loggers are never associated directly with a logging domain. This must be done through logger providers instead.

See Also:

LoggerProvider, ContextualLoggingManager, Serialized Form

Constructor Summary

Constructors

Constructor and Description
LogDomain(java.lang.String name, LoggerProvider<L> root) Creates a domain without any component name that can exist only in a ADFContext's request scope.
LogDomain(java.lang.String name, LoggerProvider<L> root, java.lang.String scopeName) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(LoggerProvider provider) Check if a logger provider belongs to the domain.
boolean	contains(java.lang.String loggerName) Check if a logger name is in the namespace defined by the domain's root logger.
boolean	equals(java.lang.Object obj) 2 domains will be considered to be equal if and only if all conditions bellow are true: their names are identical their root logger providers are identical their scope names are identical
LoggerProvider<L>	getDefaultLoggerProvider() This method will return either the domain's root logger provider or the latest logger provider set via setDefaultLoggerProvider(oracle.adfinternal.model.logging.contextual.LoggerProvider<L>), unless this was set to null, in which case the root logger will also be returned.
java.lang.String	getName() Get the name of the logging domain
LoggerProvider<L>	getRootLoggerProvider() Retrive the root logger provider for this domain
java.lang.String	getScopeName() Name of the ADFContext's scope where the logging domain will exist
int	hashCode()
void	setDefaultLoggerProvider(LoggerProvider<L> provider) Set a default logger provider for the domain.
java.lang.String	toString() Will return the domain's name

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LogDomain

public LogDomain(java.lang.String name,
         LoggerProvider<L> root)

Creates a domain without any component name that can exist only in a ADFContext's request scope.

Parameters:

name - The domain's name

root - The root logger provider defining the namespace for the domain

LogDomain

public LogDomain(java.lang.String name,
         LoggerProvider<L> root,
         java.lang.String scopeName)

Constructor.

Parameters:

name - The domain's name

root - The root logger provider defining the namespace for the domain

scopeName - The name of a valid scope within ADFContext where the domain will exist

Method Detail

getName

public java.lang.String getName()

Get the name of the logging domain

Returns:

The domain's name

getScopeName

public java.lang.String getScopeName()

Name of the ADFContext's scope where the logging domain will exist

Returns:

ADFContext's scope name

getRootLoggerProvider

public LoggerProvider<L> getRootLoggerProvider()

Retrive the root logger provider for this domain

Returns:

This domain's root looger provider

getDefaultLoggerProvider

public LoggerProvider<L> getDefaultLoggerProvider()

This method will return either the domain's root logger provider or the latest logger provider set via setDefaultLoggerProvider(oracle.adfinternal.model.logging.contextual.LoggerProvider<L>), unless this was set to null, in which case the root logger will also be returned. Therefore, it is safe to assume that this method should never return null.

Returns:

The logger provider most recently set via setDefaultLoggerProvider(oracle.adfinternal.model.logging.contextual.LoggerProvider<L>). The domain's root logger provider will be returned if no other is currently set as default.

setDefaultLoggerProvider

public void setDefaultLoggerProvider(LoggerProvider<L> provider)

Set a default logger provider for the domain.

Having a default logger provider set guarantees that the ContextualLoggingManager managing the domain will use this provider to implicitly open a new logger and set it as current if method ContextualLoggingManager.openLogger(oracle.adfinternal.model.logging.contextual.LoggerProvider<L>) is called and the internal logger stack is empty.

Parameters:

provider - The provider to be set as default for the domain

contains

public boolean contains(java.lang.String loggerName)

Check if a logger name is in the namespace defined by the domain's root logger.

Parameters:

loggerName - The logger name to validate

Returns:

true if and only if the logger name designates a sublogger or subpackage of the domain's root logger

contains

public boolean contains(LoggerProvider provider)

Check if a logger provider belongs to the domain.

Parameters:

provider - The logger provider to validate

Returns:

true if and only if the provider's logger name designates a sublogger or subpackage of the domain's root logger

equals

public boolean equals(java.lang.Object obj)

2 domains will be considered to be equal if and only if all conditions bellow are true:

1. their names are identical
2. their root logger providers are identical
3. their scope names are identical

Overrides:

equals in class java.lang.Object

Parameters:

obj -

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Will return the domain's name

Overrides:

toString in class java.lang.Object

Returns: