org.apache.mina.io

Interface IoFilter

All Known Implementing Classes:

BlacklistFilter, IoFilterAdapter, IoLoggingFilter, IoThreadPoolFilter, SSLFilter

public interface IoFilter

A filter which intercepts IoHandler events like Servlet filters. Filters can be used for these purposes:

• Event logging,
• Performance measurement,
• Data transformation (e.g. SSL support),
• Firewalling,
• and many more.

Please refer to BlacklistFilter example.

Please NEVER implement your filters to wrap IoSessions. Users can cache the reference to the session, which might malfunction if any filters are added or removed later.

Version:

$Rev: 326586 $, $Date: 2005-10-19 17:50:29 +0200 (Wed, 19 Oct 2005) $

Author:

The Apache Directory Project (dev@directory.apache.org)

See Also:

IoFilterAdapter

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IoFilter.NextFilter

Method Summary

Modifier and Type	Method and Description
void	dataRead(IoFilter.NextFilter nextFilter, IoSession session, ByteBuffer buf) Filters IoHandler.dataRead(IoSession, ByteBuffer) event.
void	dataWritten(IoFilter.NextFilter nextFilter, IoSession session, java.lang.Object marker) Filters IoHandler.dataWritten(IoSession, Object) event.
void	exceptionCaught(IoFilter.NextFilter nextFilter, IoSession session, java.lang.Throwable cause) Filters IoHandler.exceptionCaught(IoSession, Throwable) event.
void	filterWrite(IoFilter.NextFilter nextFilter, IoSession session, ByteBuffer buf, java.lang.Object marker) Filters IoSession.write(ByteBuffer, Object) method invocation.
void	sessionClosed(IoFilter.NextFilter nextFilter, IoSession session) Filters IoHandler.sessionClosed(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.

Method Detail

sessionOpened

void sessionOpened(IoFilter.NextFilter nextFilter,
                   IoSession session)
            throws java.lang.Exception

Filters IoHandler.sessionOpened(IoSession) event.

Throws:

java.lang.Exception

sessionClosed

void sessionClosed(IoFilter.NextFilter nextFilter,
                   IoSession session)
            throws java.lang.Exception

Filters IoHandler.sessionClosed(IoSession) event.

Throws:

java.lang.Exception

sessionIdle

void sessionIdle(IoFilter.NextFilter nextFilter,
                 IoSession session,
                 IdleStatus status)
          throws java.lang.Exception

Filters IoHandler.sessionIdle(IoSession, IdleStatus) event.

Throws:

java.lang.Exception

exceptionCaught

void exceptionCaught(IoFilter.NextFilter nextFilter,
                     IoSession session,
                     java.lang.Throwable cause)
              throws java.lang.Exception

Filters IoHandler.exceptionCaught(IoSession, Throwable) event.

Throws:

java.lang.Exception

dataRead

void dataRead(IoFilter.NextFilter nextFilter,
              IoSession session,
              ByteBuffer buf)
       throws java.lang.Exception

Filters IoHandler.dataRead(IoSession, ByteBuffer) event.

Throws:

java.lang.Exception

dataWritten

void dataWritten(IoFilter.NextFilter nextFilter,
                 IoSession session,
                 java.lang.Object marker)
          throws java.lang.Exception

Filters IoHandler.dataWritten(IoSession, Object) event.

Throws:

java.lang.Exception

filterWrite

void filterWrite(IoFilter.NextFilter nextFilter,
                 IoSession session,
                 ByteBuffer buf,
                 java.lang.Object marker)
          throws java.lang.Exception

Filters IoSession.write(ByteBuffer, Object) method invocation.

Throws:

java.lang.Exception