|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.mina.common.IoFilterAdapter
org.apache.mina.filter.logging.LoggingFilter
public class LoggingFilter
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
.
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 |
---|
public LoggingFilter()
public LoggingFilter(Class<?> clazz)
public LoggingFilter(String name)
Method Detail |
---|
public String getName()
public void exceptionCaught(IoFilter.NextFilter nextFilter, IoSession session, Throwable cause) throws Exception
IoFilter
IoHandler.exceptionCaught(IoSession,Throwable)
event.
exceptionCaught
in interface IoFilter
exceptionCaught
in class IoFilterAdapter
Exception
public void messageReceived(IoFilter.NextFilter nextFilter, IoSession session, Object message) throws Exception
IoFilter
IoHandler.messageReceived(IoSession,Object)
event.
messageReceived
in interface IoFilter
messageReceived
in class IoFilterAdapter
Exception
public void messageSent(IoFilter.NextFilter nextFilter, IoSession session, WriteRequest writeRequest) throws Exception
IoFilter
IoHandler.messageSent(IoSession,Object)
event.
messageSent
in interface IoFilter
messageSent
in class IoFilterAdapter
Exception
public void sessionClosed(IoFilter.NextFilter nextFilter, IoSession session) throws Exception
IoFilter
IoHandler.sessionClosed(IoSession)
event.
sessionClosed
in interface IoFilter
sessionClosed
in class IoFilterAdapter
Exception
public void sessionCreated(IoFilter.NextFilter nextFilter, IoSession session) throws Exception
IoFilter
IoHandler.sessionCreated(IoSession)
event.
sessionCreated
in interface IoFilter
sessionCreated
in class IoFilterAdapter
Exception
public void sessionIdle(IoFilter.NextFilter nextFilter, IoSession session, IdleStatus status) throws Exception
IoFilter
IoHandler.sessionIdle(IoSession,IdleStatus)
event.
sessionIdle
in interface IoFilter
sessionIdle
in class IoFilterAdapter
Exception
public void sessionOpened(IoFilter.NextFilter nextFilter, IoSession session) throws Exception
IoFilter
IoHandler.sessionOpened(IoSession)
event.
sessionOpened
in interface IoFilter
sessionOpened
in class IoFilterAdapter
Exception
public void setExceptionCaughtLogLevel(LogLevel logLevel)
LogLevel
to be used when exceptions are logged.
logLevel
- The LogLevel
to be used when exceptions are logged.public void setMessageReceivedLogLevel(LogLevel logLevel)
LogLevel
to be used when message received events are logged.
logLevel
- The LogLevel
to be used when message received events are logged.public void setMessageSentLogLevel(LogLevel logLevel)
LogLevel
to be used when message sent events are logged.
logLevel
- The LogLevel
to be used when message sent events are logged.public void setSessionClosedLogLevel(LogLevel logLevel)
LogLevel
to be used when session closed events are logged.
logLevel
- The LogLevel
to be used when session closed events are logged.public void setSessionCreatedLogLevel(LogLevel logLevel)
LogLevel
to be used when session created events are logged.
logLevel
- The LogLevel
to be used when session created events are logged.public void setSessionIdleLogLevel(LogLevel logLevel)
LogLevel
to be used when session idle events are logged.
logLevel
- The LogLevel
to be used when session idle events are logged.public void setSessionOpenedLogLevel(LogLevel logLevel)
LogLevel
to be used when session opened events are logged.
logLevel
- The LogLevel
to be used when session opened events are logged.public void setLogLevel(IoEventType eventType, LogLevel logLevel)
LogLevel
event.
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 eventpublic LogLevel getLogLevel(IoEventType eventType)
eventType
- the type of the eventpublic LogLevel getExceptionCaughtLogLevel()
LogLevel
that is used to log
exception caught events.
LogLevel
used when logging exception caught eventspublic LogLevel getMessageReceivedLogLevel()
LogLevel
that is used to log
message received events.
LogLevel
used when logging message received eventspublic LogLevel getMessageSentLogLevel()
LogLevel
that is used to log
message sent events.
LogLevel
used when logging message sent eventspublic LogLevel getSessionClosedLogLevel()
LogLevel
that is used to log
session closed events.
LogLevel
used when logging session closed eventspublic LogLevel getSessionCreatedLogLevel()
LogLevel
that is used to log
session created events.
LogLevel
used when logging session created eventspublic LogLevel getSessionIdleLogLevel()
LogLevel
that is used to log
session idle events.
LogLevel
used when logging session idle eventspublic LogLevel getSessionOpenedLogLevel()
LogLevel
that is used to log
session opened events.
LogLevel
used when logging session opened events
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |