Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.9.0)

E52932-01


oracle.adfinternal.model.logging.contextual
Class LoggerProvider<L extends BasicContextualLogger>

java.lang.Object
  extended by oracle.adfinternal.model.logging.contextual.LoggerProvider<L>

Type Parameters:
L - The speficic BasicContextualLogger implementation the provider will work with.
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ContextualLoggerProvider, FunctionalLoggerProvider

public abstract class LoggerProvider<L extends BasicContextualLogger>
extends java.lang.Object
implements java.io.Serializable

This is the base class for any logger provider that will work with the ContextualLoggingManager.

Logger providers will be used by the ContextualLoggingManager as logger factories, via method createLogger().

Any provider will be accepted as a valid member of a logging domain if and only if the provider's logger name is a sublogger (or subpackage) of the domain's root logger.

Consumers are free to extend this class to provide their own implementation of the BasicContextualLogger interface via custom implementation of abstract method createLogger().

Since:
11.1.1.7.2
See Also:
LogDomain, ContextualLoggingManager, Serialized Form

Constructor Summary
protected LoggerProvider(java.lang.String loggerName)
          Constructor.
protected LoggerProvider(java.lang.String loggerName, java.lang.String componentName)
          Constructor.
protected LoggerProvider(java.lang.String loggerName, java.lang.String componentName, java.lang.String resourceBundle)
          Constructor.

 

Method Summary
protected abstract  L createLogger()
          This method will be used as a logger factory by the ContextualLoggingManager and will create a new logger instance of the provider's parameterized type L.
 boolean equals(java.lang.Object obj)
          2 providers will be considered to be equal if and only if all conditions bellow are true: their logger names are identical their resource bundle names are identical
 java.lang.String getComponentName()
          The logger's component name
 java.lang.String getLoggerName()
          Retrieve the name which will be given to any logger created by the provider, as defined at the provider's construction.
 java.lang.String getResourceBundle()
          The name of the resource bundle to be associated with any logger created by the provider, if any, as defined at the provider's construction.
 int hashCode()
           
 java.lang.String toString()
          Will return the logger name defined for the provider

 

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

 

Constructor Detail

LoggerProvider

protected LoggerProvider(java.lang.String loggerName)
Constructor.
Parameters:
loggerName - The name given to loggers created by this provider

LoggerProvider

protected LoggerProvider(java.lang.String loggerName,
                         java.lang.String componentName)
Constructor.
Parameters:
loggerName - The name given to loggers created by this provider
componentName - Logger's optional component name

LoggerProvider

protected LoggerProvider(java.lang.String loggerName,
                         java.lang.String componentName,
                         java.lang.String resourceBundle)
Constructor.
Parameters:
loggerName - The name given to loggers created by this provider
componentName - Logger's optional component name
resourceBundle - Name of the resource bundle to be associated with loggers created by this provider

Method Detail

createLogger

protected abstract L createLogger()

This method will be used as a logger factory by the ContextualLoggingManager and will create a new logger instance of the provider's parameterized type L.

The logger's name will be the one declared at the provider's construction.

Returns:
New logger instance named as the logger name declared at the provider's construction.

getLoggerName

public final java.lang.String getLoggerName()
Retrieve the name which will be given to any logger created by the provider, as defined at the provider's construction.
Returns:
The name to be given to loggers created by the provider

getComponentName

public final java.lang.String getComponentName()
The logger's component name
Returns:
Component name

getResourceBundle

public final java.lang.String getResourceBundle()
The name of the resource bundle to be associated with any logger created by the provider, if any, as defined at the provider's construction.
Returns:
Resource bundle's name or null if none was defined when the provider was instantiated

equals

public boolean equals(java.lang.Object obj)
2 providers will be considered to be equal if and only if all conditions bellow are true:
  1. their logger names are identical
  2. their resource bundle 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 logger name defined for the provider
Overrides:
toString in class java.lang.Object
Returns:

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.9.0)

E52932-01


Copyright © 1997, 2015, Oracle. All rights reserved.