org.objectweb.util.monolog.api
Interface Handler

All Known Subinterfaces:

Logger, TopicalLogger

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 String	APPEND_MODE_ATTRIBUTE
static 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 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 String	LEVEL_ATTRIBUTE
static byte	LOGGER_HANDLER_TYPE Deprecated. the type is a string now: "logger"
static String	MAX_SIZE_ATTRIBUTE
static String	OUTPUT_ATTRIBUTE
static 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

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

Field Detail

FILE_HANDLER_TYPE

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

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

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

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

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

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

static final String OUTPUT_ATTRIBUTE

See Also:

Constant Field Values

PATTERN_ATTRIBUTE

static final String PATTERN_ATTRIBUTE

See Also:

Constant Field Values

LEVEL_ATTRIBUTE

static final String LEVEL_ATTRIBUTE

See Also:

Constant Field Values

APPEND_MODE_ATTRIBUTE

static final String APPEND_MODE_ATTRIBUTE

See Also:

Constant Field Values

FILE_NUMBER_ATTRIBUTE

static final String FILE_NUMBER_ATTRIBUTE

See Also:

Constant Field Values

MAX_SIZE_ATTRIBUTE

static final String MAX_SIZE_ATTRIBUTE

See Also:

Constant Field Values

BUFFER_ATTRIBUTE

static final String BUFFER_ATTRIBUTE

See Also:

Constant Field Values

Method Detail

getName

String getName()

It retrieves the name of the handler

setName

void setName(String name)

It assigns the name of the handler

getType

String getType()

It retrieves the Handler type

getAttributeNames

String[] getAttributeNames()

It retrieves the attributes of the handler

getAttribute

Object getAttribute(String name)

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

Parameters:

name - is an attribute name

setAttribute

Object setAttribute(String name,
                    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