This project has retired. For details please refer to its Attic page.

org.apache.cocoon.util.log
Class XMLCocoonLogFormatter

java.lang.Object
  org.apache.cocoon.util.log.XMLCocoonLogFormatter

All Implemented Interfaces:

Formatter

Deprecated. This class will be removed in 2.2

public class XMLCocoonLogFormatter
extends Object
implements Formatter

A refactoring of org.apache.log.format.PatternFormatter and org.apache.cocoon.util.log.CocoonLogFormatter for producing XML format. This formater formats the LogEntries according to given input types. Each log entry is inside a <log-entry> element and each information is inside an own element.

• class : outputs the name of the class that has logged the message. The optional short subformat removes the package name. Warning : this pattern works only if formatting occurs in the same thread as the call to Logger, i.e. it won't work with AsyncLogTarget. The class name is embeded by a <class> element.
• thread : outputs the name of the current thread (first element on the context stack). The thread name is surrounded by a <thread> element.
• uri : outputs the request URI (<uri>).
• category : outputs the log category (<category>).
• message : outputs the message (<message>).
• time : outputs the time (<time>).
• rtime : outputs the relative time (<relative-time>).
• throwable : outputs the exception (<throwable>).
• priority : outputs the priority (<priority>).
• host : outputs the request host header (<priority>).

Version:

CVS $Id: XMLCocoonLogFormatter.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Peter Donald, Sylvain Wallez, Carsten Ziegeler

Nested Class Summary

static class

XMLCocoonLogFormatter.CallStack Deprecated. Hack to get the call stack as an array of classes.

Field Summary

protected SimpleDateFormat	dateFormatter Deprecated.
protected static int	TYPE_CATEGORY Deprecated.
protected static int	TYPE_CLASS Deprecated.
protected static int	TYPE_CLASS_SHORT Deprecated.
protected static String	TYPE_CLASS_SHORT_STR Deprecated.
protected static String	TYPE_CLASS_STR Deprecated.
protected static int	TYPE_HOST Deprecated.
protected static int	TYPE_MESSAGE Deprecated.
protected static int	TYPE_PRIORITY Deprecated.
protected static int	TYPE_RELATIVE_TIME Deprecated.
protected static int	TYPE_REQUEST_URI Deprecated.
protected static int	TYPE_THREAD Deprecated.
protected static int	TYPE_THROWABLE Deprecated.
protected static int	TYPE_TIME Deprecated.
protected int[]	types Deprecated.
static String[]	typeStrings Deprecated.

Constructor Summary

XMLCocoonLogFormatter()
Deprecated.

Method Summary

String	format(LogEvent event) Deprecated. Format the event according to the pattern.
protected int	getTypeIdFor(String type) Deprecated. Retrieve the type-id for a particular string.
void	setTypes(String typeString) Deprecated. Set the types from a whitespace separated string
void	setTypes(String[] typeStrings) Deprecated. Set the types from an array of strings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_CLASS_STR

protected static final String TYPE_CLASS_STR

Deprecated.

See Also:

Constant Field Values

TYPE_CLASS_SHORT_STR

protected static final String TYPE_CLASS_SHORT_STR

Deprecated.

See Also:

Constant Field Values

TYPE_REQUEST_URI

protected static final int TYPE_REQUEST_URI

Deprecated.

See Also:

Constant Field Values

TYPE_CATEGORY

protected static final int TYPE_CATEGORY

Deprecated.

See Also:

Constant Field Values

TYPE_MESSAGE

protected static final int TYPE_MESSAGE

Deprecated.

See Also:

Constant Field Values

TYPE_TIME

protected static final int TYPE_TIME

Deprecated.

See Also:

Constant Field Values

TYPE_RELATIVE_TIME

protected static final int TYPE_RELATIVE_TIME

Deprecated.

See Also:

Constant Field Values

TYPE_THROWABLE

protected static final int TYPE_THROWABLE

Deprecated.

See Also:

Constant Field Values

TYPE_PRIORITY

protected static final int TYPE_PRIORITY

Deprecated.

See Also:

Constant Field Values

TYPE_CLASS

protected static final int TYPE_CLASS

Deprecated.

See Also:

Constant Field Values

TYPE_CLASS_SHORT

protected static final int TYPE_CLASS_SHORT

Deprecated.

See Also:

Constant Field Values

TYPE_THREAD

protected static final int TYPE_THREAD

Deprecated.

See Also:

Constant Field Values

TYPE_HOST

protected static final int TYPE_HOST

Deprecated.

See Also:

Constant Field Values

typeStrings

public static final String[] typeStrings

Deprecated.

dateFormatter

protected final SimpleDateFormat dateFormatter

Deprecated.

types

protected int[] types

Deprecated.

Constructor Detail

XMLCocoonLogFormatter

public XMLCocoonLogFormatter()

Deprecated.

Method Detail

format

public String format(LogEvent event)

Deprecated.

Format the event according to the pattern.

Specified by:

format in interface Formatter

Parameters:

event - the event

Returns:

the formatted output

getTypeIdFor

protected int getTypeIdFor(String type)

Deprecated.

Retrieve the type-id for a particular string.

Parameters:

type - the string

Returns:

the type-id

setTypes

public void setTypes(String[] typeStrings)

Deprecated.

Set the types from an array of strings.

setTypes

public void setTypes(String typeString)

Deprecated.

Set the types from a whitespace separated string