org.objectweb.util.monolog.api
Interface Handler

All Known Subinterfaces:

Logger, TopicalLogger

All Known Implementing Classes:

BasicHandler, BasicLogger, ConsoleHandler, FileHandler, FileHandler, GenericHandler, GenericHandler, JMXHandler, Logger, LoggerImpl, MonologCategory, MonologCategory, NTEventLogHandler, RollingFileHandler

public interface Handler

Handler is an output. For example a handler might be a console, a file, a socket, or a Logger.

Author:

Sebastien Chassande-Barrioz

Field Summary

static java.lang.String	APPEND_MODE_ATTRIBUTE
static java.lang.String	BUFFER_ATTRIBUTE
static byte	CONSOLE_HANDLER_TYPE Deprecated. the type is a string now: "console"
static byte	FILE_HANDLER_TYPE Deprecated. the type is a string now: "file"
static java.lang.String	FILE_NUMBER_ATTRIBUTE
static byte	GENERIC_HANDLER_TYPE Deprecated. the type is a string now: "generic"
static byte	JMX_HANDLER_TYPE Deprecated. the type is a string now: "logger"
static java.lang.String	LEVEL_ATTRIBUTE
static byte	LOGGER_HANDLER_TYPE Deprecated. the type is a string now: "logger"
static java.lang.String	MAX_SIZE_ATTRIBUTE
static java.lang.String	OUTPUT_ATTRIBUTE
static java.lang.String	PATTERN_ATTRIBUTE
static byte	ROLLING_FILE_HANDLER_TYPE This constant is used to represent an handler which stores message into several files.

Method Summary

java.lang.Object	getAttribute(java.lang.String name) It retrieves the value of an attribute value of the handler.
java.lang.String[]	getAttributeNames() It retrieves the attributes of the handler
java.lang.String	getName() It retrieves the name of the handler
java.lang.String	getType() It retrieves the Handler type
java.lang.Object	setAttribute(java.lang.String name, java.lang.Object value) It assigns an attributte to the handler.
void	setName(java.lang.String name) It assigns the name of the handler

Field Detail

FILE_HANDLER_TYPE

public static final byte FILE_HANDLER_TYPE

Deprecated. the type is a string now: "file"

This constant is used to represent an handler which stores message into one file.

See Also:

Constant Field Values

CONSOLE_HANDLER_TYPE

public static final byte CONSOLE_HANDLER_TYPE

Deprecated. the type is a string now: "console"

This constant is used to represent an handler which prints message on a console.

See Also:

Constant Field Values

ROLLING_FILE_HANDLER_TYPE

public static final byte ROLLING_FILE_HANDLER_TYPE

This constant is used to represent an handler which stores message into several files.

See Also:

Constant Field Values

GENERIC_HANDLER_TYPE

public static final byte GENERIC_HANDLER_TYPE

Deprecated. the type is a string now: "generic"

This constant is used to represent an handler which stores message into several files.

See Also:

Constant Field Values

LOGGER_HANDLER_TYPE

public static final byte LOGGER_HANDLER_TYPE

Deprecated. the type is a string now: "logger"

This constant is used to represent an handler which is a Logger.

See Also:

Constant Field Values

JMX_HANDLER_TYPE

public static final byte JMX_HANDLER_TYPE

Deprecated. the type is a string now: "logger"

This constant is used to represent a handler witch is a JMX notification emetter.

See Also:

Constant Field Values

OUTPUT_ATTRIBUTE

public static final java.lang.String OUTPUT_ATTRIBUTE

See Also:

Constant Field Values

PATTERN_ATTRIBUTE

public static final java.lang.String PATTERN_ATTRIBUTE

See Also:

Constant Field Values

LEVEL_ATTRIBUTE

public static final java.lang.String LEVEL_ATTRIBUTE

See Also:

Constant Field Values

APPEND_MODE_ATTRIBUTE

public static final java.lang.String APPEND_MODE_ATTRIBUTE

See Also:

Constant Field Values

FILE_NUMBER_ATTRIBUTE

public static final java.lang.String FILE_NUMBER_ATTRIBUTE

See Also:

Constant Field Values

MAX_SIZE_ATTRIBUTE

public static final java.lang.String MAX_SIZE_ATTRIBUTE

See Also:

Constant Field Values

BUFFER_ATTRIBUTE

public static final java.lang.String BUFFER_ATTRIBUTE

See Also:

Constant Field Values

Method Detail

getName

public java.lang.String getName()

It retrieves the name of the handler

setName

public void setName(java.lang.String name)

It assigns the name of the handler

getType

public java.lang.String getType()

It retrieves the Handler type

getAttributeNames

public java.lang.String[] getAttributeNames()

It retrieves the attributes of the handler

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

It retrieves the value of an attribute value of the handler.

Parameters:

name - is an attribute name

setAttribute

public java.lang.Object setAttribute(java.lang.String name,
                                     java.lang.Object value)

It assigns an attributte to the handler.

Parameters:

name - is the attribute name

value - is the attribute value

Returns:

the old value is the attribute was already defined