org.apache.mina.filter.logging
Class LoggingFilter

java.lang.Object
  extended by org.apache.mina.common.IoFilterAdapter
      extended by org.apache.mina.filter.logging.LoggingFilter
All Implemented Interfaces:
IoFilter

public class LoggingFilter
extends IoFilterAdapter

Logs all MINA protocol events. Each event can be tuned to use a different level based on the user's specific requirements. Methods are in place that allow the user to use either the get or set method for each event and pass in the IoEventType and the LogLevel. By default, all events are logged to the LogLevel.INFO level except IoFilterAdapter.exceptionCaught(IoFilter.NextFilter, IoSession, Throwable), which is logged to LogLevel.WARN.

Version:
$Rev: 616100 $, $Date: 2008-01-28 23:58:32 +0100 (Mon, 28 Jan 2008) $
Author:
Apache Directory Project

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.mina.common.IoFilter
IoFilter.NextFilter
 
Constructor Summary
LoggingFilter()
          Default Constructor.
LoggingFilter(Class<?> clazz)
           
LoggingFilter(String name)
           
 
Method Summary
 void exceptionCaught(IoFilter.NextFilter nextFilter, IoSession session, Throwable cause)
          Filters IoHandler.exceptionCaught(IoSession,Throwable) event.
 LogLevel getExceptionCaughtLogLevel()
          This method returns the LogLevel that is used to log exception caught events.
 LogLevel getLogLevel(IoEventType eventType)
          Returns the log level for the supplied event type.
 LogLevel getMessageReceivedLogLevel()
          This method returns the LogLevel that is used to log message received events.
 LogLevel getMessageSentLogLevel()
          This method returns the LogLevel that is used to log message sent events.
 String getName()
           
 LogLevel getSessionClosedLogLevel()
          This method returns the LogLevel that is used to log session closed events.
 LogLevel getSessionCreatedLogLevel()
          This method returns the LogLevel that is used to log session created events.
 LogLevel getSessionIdleLogLevel()
          This method returns the LogLevel that is used to log session idle events.
 LogLevel getSessionOpenedLogLevel()
          This method returns the LogLevel that is used to log session opened events.
 void messageReceived(IoFilter.NextFilter nextFilter, IoSession session, Object message)
          Filters IoHandler.messageReceived(IoSession,Object) event.
 void messageSent(IoFilter.NextFilter nextFilter, IoSession session, WriteRequest writeRequest)
          Filters IoHandler.messageSent(IoSession,Object) event.
 void sessionClosed(IoFilter.NextFilter nextFilter, IoSession session)
          Filters IoHandler.sessionClosed(IoSession) event.
 void sessionCreated(IoFilter.NextFilter nextFilter, IoSession session)
          Filters IoHandler.sessionCreated(IoSession) event.
 void sessionIdle(IoFilter.NextFilter nextFilter, IoSession session, IdleStatus status)
          Filters IoHandler.sessionIdle(IoSession,IdleStatus) event.
 void sessionOpened(IoFilter.NextFilter nextFilter, IoSession session)
          Filters IoHandler.sessionOpened(IoSession) event.
 void setExceptionCaughtLogLevel(LogLevel logLevel)
          Sets the LogLevel to be used when exceptions are logged.
 void setLogLevel(IoEventType eventType, LogLevel logLevel)
          This method sets the log level for the supplied LogLevel event.
 void setMessageReceivedLogLevel(LogLevel logLevel)
          Sets the LogLevel to be used when message received events are logged.
 void setMessageSentLogLevel(LogLevel logLevel)
          Sets the LogLevel to be used when message sent events are logged.
 void setSessionClosedLogLevel(LogLevel logLevel)
          Sets the LogLevel to be used when session closed events are logged.
 void setSessionCreatedLogLevel(LogLevel logLevel)
          Sets the LogLevel to be used when session created events are logged.
 void setSessionIdleLogLevel(LogLevel logLevel)
          Sets the LogLevel to be used when session idle events are logged.
 void setSessionOpenedLogLevel(LogLevel logLevel)
          Sets the LogLevel to be used when session opened events are logged.
 
Methods inherited from class org.apache.mina.common.IoFilterAdapter
destroy, filterClose, filterSetTrafficMask, filterWrite, init, onPostAdd, onPostRemove, onPreAdd, onPreRemove
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LoggingFilter

public LoggingFilter()
Default Constructor.


LoggingFilter

public LoggingFilter(Class<?> clazz)

LoggingFilter

public LoggingFilter(String name)
Method Detail

getName

public String getName()

exceptionCaught

public void exceptionCaught(IoFilter.NextFilter nextFilter,
                            IoSession session,
                            Throwable cause)
                     throws Exception
Description copied from interface: IoFilter
Filters IoHandler.exceptionCaught(IoSession,Throwable) event.

Specified by:
exceptionCaught in interface IoFilter
Overrides:
exceptionCaught in class IoFilterAdapter
Throws:
Exception

messageReceived

public void messageReceived(IoFilter.NextFilter nextFilter,
                            IoSession session,
                            Object message)
                     throws Exception
Description copied from interface: IoFilter
Filters IoHandler.messageReceived(IoSession,Object) event.

Specified by:
messageReceived in interface IoFilter
Overrides:
messageReceived in class IoFilterAdapter
Throws:
Exception

messageSent

public void messageSent(IoFilter.NextFilter nextFilter,
                        IoSession session,
                        WriteRequest writeRequest)
                 throws Exception
Description copied from interface: IoFilter
Filters IoHandler.messageSent(IoSession,Object) event.

Specified by:
messageSent in interface IoFilter
Overrides:
messageSent in class IoFilterAdapter
Throws:
Exception

sessionClosed

public void sessionClosed(IoFilter.NextFilter nextFilter,
                          IoSession session)
                   throws Exception
Description copied from interface: IoFilter
Filters IoHandler.sessionClosed(IoSession) event.

Specified by:
sessionClosed in interface IoFilter
Overrides:
sessionClosed in class IoFilterAdapter
Throws:
Exception

sessionCreated

public void sessionCreated(IoFilter.NextFilter nextFilter,
                           IoSession session)
                    throws Exception
Description copied from interface: IoFilter
Filters IoHandler.sessionCreated(IoSession) event.

Specified by:
sessionCreated in interface IoFilter
Overrides:
sessionCreated in class IoFilterAdapter
Throws:
Exception

sessionIdle

public void sessionIdle(IoFilter.NextFilter nextFilter,
                        IoSession session,
                        IdleStatus status)
                 throws Exception
Description copied from interface: IoFilter
Filters IoHandler.sessionIdle(IoSession,IdleStatus) event.

Specified by:
sessionIdle in interface IoFilter
Overrides:
sessionIdle in class IoFilterAdapter
Throws:
Exception

sessionOpened

public void sessionOpened(IoFilter.NextFilter nextFilter,
                          IoSession session)
                   throws Exception
Description copied from interface: IoFilter
Filters IoHandler.sessionOpened(IoSession) event.

Specified by:
sessionOpened in interface IoFilter
Overrides:
sessionOpened in class IoFilterAdapter
Throws:
Exception

setExceptionCaughtLogLevel

public void setExceptionCaughtLogLevel(LogLevel logLevel)
Sets the LogLevel to be used when exceptions are logged.

Parameters:
logLevel - The LogLevel to be used when exceptions are logged.

setMessageReceivedLogLevel

public void setMessageReceivedLogLevel(LogLevel logLevel)
Sets the LogLevel to be used when message received events are logged.

Parameters:
logLevel - The LogLevel to be used when message received events are logged.

setMessageSentLogLevel

public void setMessageSentLogLevel(LogLevel logLevel)
Sets the LogLevel to be used when message sent events are logged.

Parameters:
logLevel - The LogLevel to be used when message sent events are logged.

setSessionClosedLogLevel

public void setSessionClosedLogLevel(LogLevel logLevel)
Sets the LogLevel to be used when session closed events are logged.

Parameters:
logLevel - The LogLevel to be used when session closed events are logged.

setSessionCreatedLogLevel

public void setSessionCreatedLogLevel(LogLevel logLevel)
Sets the LogLevel to be used when session created events are logged.

Parameters:
logLevel - The LogLevel to be used when session created events are logged.

setSessionIdleLogLevel

public void setSessionIdleLogLevel(LogLevel logLevel)
Sets the LogLevel to be used when session idle events are logged.

Parameters:
logLevel - The LogLevel to be used when session idle events are logged.

setSessionOpenedLogLevel

public void setSessionOpenedLogLevel(LogLevel logLevel)
Sets the LogLevel to be used when session opened events are logged.

Parameters:
logLevel - The LogLevel to be used when session opened events are logged.

setLogLevel

public void setLogLevel(IoEventType eventType,
                        LogLevel logLevel)
This method sets the log level for the supplied LogLevel event.

Parameters:
eventType - the type of the event that is to be updated with the new LogLevel
logLevel - the new LogLevel to be used to log the specified event

getLogLevel

public LogLevel getLogLevel(IoEventType eventType)
Returns the log level for the supplied event type.

Parameters:
eventType - the type of the event

getExceptionCaughtLogLevel

public LogLevel getExceptionCaughtLogLevel()
This method returns the LogLevel that is used to log exception caught events.

Returns:
The LogLevel used when logging exception caught events

getMessageReceivedLogLevel

public LogLevel getMessageReceivedLogLevel()
This method returns the LogLevel that is used to log message received events.

Returns:
The LogLevel used when logging message received events

getMessageSentLogLevel

public LogLevel getMessageSentLogLevel()
This method returns the LogLevel that is used to log message sent events.

Returns:
The LogLevel used when logging message sent events

getSessionClosedLogLevel

public LogLevel getSessionClosedLogLevel()
This method returns the LogLevel that is used to log session closed events.

Returns:
The LogLevel used when logging session closed events

getSessionCreatedLogLevel

public LogLevel getSessionCreatedLogLevel()
This method returns the LogLevel that is used to log session created events.

Returns:
The LogLevel used when logging session created events

getSessionIdleLogLevel

public LogLevel getSessionIdleLogLevel()
This method returns the LogLevel that is used to log session idle events.

Returns:
The LogLevel used when logging session idle events

getSessionOpenedLogLevel

public LogLevel getSessionOpenedLogLevel()
This method returns the LogLevel that is used to log session opened events.

Returns:
The LogLevel used when logging session opened events


Copyright © 2004-2009 Apache MINA Project. All Rights Reserved.