org.openas2.logging

Class BaseLogger

java.lang.Object

org.openas2.BaseComponent

org.openas2.logging.BaseLogger

All Implemented Interfaces:

Component, Logger

Direct Known Subclasses:

ConsoleLogger, EmailLogger, FileLogger, SentryLogger, SocketLogger

public abstract class BaseLogger
extends BaseComponent
implements Logger

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_EXCEPTIONS
static String	PARAM_SHOW
static String	VALUE_SHOW_ALL
static String	VALUE_SHOW_EXCEPTIONS
static String	VALUE_SHOW_INFO
static String	VALUE_SHOW_TERMINATED

Constructor Summary

Constructors

Constructor and Description
BaseLogger()

Method Summary

Modifier and Type	Method and Description
protected abstract void	doLog(Level level, String msgText, Message message)
protected abstract void	doLog(Throwable throwable, boolean terminated)
Formatter	getFormatter()
protected abstract String	getShowDefaults()
void	init(Session session, Map<String,String> parameters) Component lifecycle hook.
boolean	isLogExceptionTrace()
protected boolean	isLogging(OpenAS2Exception exception)
protected boolean	isShowing(String value)
void	log(Level level, String msgText, Message message, Throwable t) level msgText message
void	log(Throwable t, Level level, boolean terminated)
void	setFormatter(Formatter formatter)
void	setLogExceptionTrace(boolean logExceptionTrace)

Methods inherited from class org.openas2.BaseComponent

destroy, getName, getParameter, getParameter, getParameterInt, getParameters, getSession, setParameter, setParameter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openas2.Component

destroy, getName, getParameters, getSession

Field Detail

PARAM_EXCEPTIONS

public static final String PARAM_EXCEPTIONS

See Also:

Constant Field Values

PARAM_SHOW

public static final String PARAM_SHOW

See Also:

Constant Field Values

VALUE_SHOW_ALL

public static final String VALUE_SHOW_ALL

See Also:

Constant Field Values

VALUE_SHOW_TERMINATED

public static final String VALUE_SHOW_TERMINATED

See Also:

Constant Field Values

VALUE_SHOW_EXCEPTIONS

public static final String VALUE_SHOW_EXCEPTIONS

See Also:

Constant Field Values

VALUE_SHOW_INFO

public static final String VALUE_SHOW_INFO

See Also:

Constant Field Values

Constructor Detail

BaseLogger

public BaseLogger()

Method Detail

init

public void init(Session session,
                 Map<String,String> parameters)
          throws OpenAS2Exception

Description copied from interface: Component

Component lifecycle hook. After creating a Component object, this method should be called to set any parameters used by the component. Component implementations typically have required parameter checking and code to start timers and threads within this method.

Specified by:

init in interface Component

Overrides:

init in class BaseComponent

Parameters:

session - the component uses this object to access other components

parameters - configuration values for the component

Throws:

OpenAS2Exception - If an error occurs while initializing the component

See Also:

Session

isLogExceptionTrace

public boolean isLogExceptionTrace()

setLogExceptionTrace

public void setLogExceptionTrace(boolean logExceptionTrace)

setFormatter

public void setFormatter(Formatter formatter)

Specified by:

setFormatter in interface Logger

getFormatter

public Formatter getFormatter()

Specified by:

getFormatter in interface Logger

log

public void log(Throwable t,
                Level level,
                boolean terminated)

Specified by:

log in interface Logger

log

public void log(Level level,
                String msgText,
                Message message,
                Throwable t)

level msgText message

Specified by:

log in interface Logger

Parameters:

level - The log level we are spewing out

msgText - The message to log

message - The context object that will provide additional information

isLogging

protected boolean isLogging(OpenAS2Exception exception)

getShowDefaults

protected abstract String getShowDefaults()

isShowing

protected boolean isShowing(String value)

doLog

protected abstract void doLog(Throwable throwable,
                              boolean terminated)

doLog

protected abstract void doLog(Level level,
                              String msgText,
                              Message message)