org.apache.avalon.logging.provider
Interface LoggingCriteria

All Superinterfaces:
Map
All Known Implementing Classes:
DefaultLoggingCriteria

public interface LoggingCriteria
extends Map

LoggingCriteria is convinience interface that extends Map with a set of operations that enable easy manipulation of the logging system parameters.

Version:
$Revision: 1.3 $
Author:
Avalon Development Team

Nested Class Summary
 
Nested classes inherited from class java.util.Map
Map.Entry
 
Field Summary
static String LOGGING_BASEDIR_KEY
          The key of a the criteria argument that declares the base directory to be used for persistent content.
static String LOGGING_BOOTSTRAP_KEY
          The logging system bootstrap logger key.
static String LOGGING_CONFIGURATION_KEY
          The logging configuration key.
static String LOGGING_DEBUG_KEY
          Debug mode.
static String LOGGING_INTERVAL_KEY
          Update Interval.
 
Method Summary
 File getBaseDirectory()
          Returns the base directory for logging resources.
 Logger getBootstrapLogger()
          Get the bootstrap logging channel
 URL getLoggingConfiguration()
          Returns an external logging system configuration file
 long getUpdateInterval()
          Returns the logging configuration update interval.
 boolean isDebugEnabled()
          Returns debug policy.
 void setBaseDirectory(File dir)
          Set the base directory.
 void setBootstrapLogger(Logger logger)
          Set the bootstrap logging channel
 void setDebugEnabled(boolean mode)
          Set the debug enabled policy
 void setLoggingConfiguration(URL url)
          Set the configuration URL.
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 

Field Detail

LOGGING_CONFIGURATION_KEY

public static final String LOGGING_CONFIGURATION_KEY
The logging configuration key.

See Also:
Constant Field Values

LOGGING_BOOTSTRAP_KEY

public static final String LOGGING_BOOTSTRAP_KEY
The logging system bootstrap logger key.

See Also:
Constant Field Values

LOGGING_BASEDIR_KEY

public static final String LOGGING_BASEDIR_KEY
The key of a the criteria argument that declares the base directory to be used for persistent content. For example, logging file should be created in the directory assigned to this key.

See Also:
Constant Field Values

LOGGING_INTERVAL_KEY

public static final String LOGGING_INTERVAL_KEY
Update Interval. Logging subsystems that supports changes on-the-fly, will be passed this argument.

See Also:
Constant Field Values

LOGGING_DEBUG_KEY

public static final String LOGGING_DEBUG_KEY
Debug mode.

See Also:
Constant Field Values
Method Detail

setDebugEnabled

public void setDebugEnabled(boolean mode)
Set the debug enabled policy

Parameters:
mode - TRUE to enabled debug mode else FALSE

setBootstrapLogger

public void setBootstrapLogger(Logger logger)
Set the bootstrap logging channel

Parameters:
logger - the boootstrap logging channel

setBaseDirectory

public void setBaseDirectory(File dir)
Set the base directory.

Parameters:
dir - the base directory

setLoggingConfiguration

public void setLoggingConfiguration(URL url)
Set the configuration URL.

Parameters:
url - the configuration URL

getBootstrapLogger

public Logger getBootstrapLogger()
Get the bootstrap logging channel

Returns:
the boootstrap logging channel

getBaseDirectory

public File getBaseDirectory()
Returns the base directory for logging resources.

Returns:
the base directory

isDebugEnabled

public boolean isDebugEnabled()
Returns debug policy. If TRUE all logging channels will be set to debug level.

Returns:
the debug policy

getLoggingConfiguration

public URL getLoggingConfiguration()
Returns an external logging system configuration file

Returns:
the configuration file (possibly null)

getUpdateInterval

public long getUpdateInterval()
Returns the logging configuration update interval.



Copyright © The Apache Software Foundation. All Rights Reserved.