DefaultIoFilterChain (Apache MINA 2.0.0-RC1 API Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.mina.core.filterchain
Class DefaultIoFilterChain

java.lang.Object
  org.apache.mina.core.filterchain.DefaultIoFilterChain

All Implemented Interfaces:: IoFilterChain

public class DefaultIoFilterChain
extends Object
implements IoFilterChain
extends Object
implements IoFilterChain

A default implementation of IoFilterChain that provides all operations for developers who want to implement their own transport layer once used with AbstractIoSession.

Author:: Apache MINA Project

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.mina.core.filterchain.IoFilterChain
`IoFilterChain.Entry`

Field Summary
`static AttributeKey`	`SESSION_CREATED_FUTURE` A session attribute that stores an `IoFuture` related with the `IoSession`.

Constructor Summary
`DefaultIoFilterChain(AbstractIoSession session)` Create a new default chain, associated with a session.

Method Summary
`void`	`addAfter(String baseName, String name, IoFilter filter)` Adds the specified filter with the specified name just after the filter whose name is `baseName` in this chain.
`void`	`addBefore(String baseName, String name, IoFilter filter)` Adds the specified filter with the specified name just before the filter whose name is `baseName` in this chain.
`void`	`addFirst(String name, IoFilter filter)` Adds the specified filter with the specified name at the beginning of this chain.
`void`	`addLast(String name, IoFilter filter)` Adds the specified filter with the specified name at the end of this chain.
`void`	`clear()` Removes all filters added to this chain.
`boolean`	`contains(Class<? extends IoFilter> filterType)` Returns `true` if this chain contains an `IoFilter` of the specified `filterType`.
`boolean`	`contains(IoFilter filter)` Returns `true` if this chain contains the specified `filter`.
`boolean`	`contains(String name)` Returns `true` if this chain contains an `IoFilter` with the specified `name`.
`void`	`fireExceptionCaught(Throwable cause)` Fires a `IoHandler.exceptionCaught(IoSession, Throwable)` event.
`void`	`fireFilterClose()` Fires a `IoSession.close()` event.
`void`	`fireFilterWrite(WriteRequest writeRequest)` Fires a `IoSession.write(Object)` event.
`void`	`fireMessageReceived(Object message)` Fires a `IoFilterChain.fireMessageReceived(Object)` event.
`void`	`fireMessageSent(WriteRequest request)` Fires a `IoHandler.sessionOpened(IoSession)` event.
`void`	`fireSessionClosed()` Fires a `IoHandler.sessionClosed(IoSession)` event.
`void`	`fireSessionCreated()` Fires a `IoHandler.sessionCreated(IoSession)` event.
`void`	`fireSessionIdle(IdleStatus status)` Fires a `IoHandler.sessionIdle(IoSession, IdleStatus)` event.
`void`	`fireSessionOpened()` Fires a `IoHandler.sessionOpened(IoSession)` event.
`IoFilter`	`get(Class<? extends IoFilter> filterType)` Returns the `IoFilter` with the specified `filterType` in this chain.
`IoFilter`	`get(String name)` Returns the `IoFilter` with the specified `name` in this chain.
`List<IoFilterChain.Entry>`	`getAll()` Returns the list of all `IoFilterChain.Entry`s this chain contains.
`List<IoFilterChain.Entry>`	`getAllReversed()` Returns the reversed list of all `IoFilterChain.Entry`s this chain contains.
`IoFilterChain.Entry`	`getEntry(Class<? extends IoFilter> filterType)` Returns the `IoFilterChain.Entry` with the specified `filterType` in this chain.
`IoFilterChain.Entry`	`getEntry(IoFilter filter)` Returns the `IoFilterChain.Entry` with the specified `filter` in this chain.
`IoFilterChain.Entry`	`getEntry(String name)` Returns the `IoFilterChain.Entry` with the specified `name` in this chain.
`IoFilter.NextFilter`	`getNextFilter(Class<? extends IoFilter> filterType)` Returns the `IoFilter.NextFilter` of the specified `filterType` in this chain.
`IoFilter.NextFilter`	`getNextFilter(IoFilter filter)` Returns the `IoFilter.NextFilter` of the specified `IoFilter` in this chain.
`IoFilter.NextFilter`	`getNextFilter(String name)` Returns the `IoFilter.NextFilter` of the `IoFilter` with the specified `name` in this chain.
`IoSession`	`getSession()` Returns the parent `IoSession` of this chain.
`IoFilter`	`remove(Class<? extends IoFilter> filterType)` Replace the filter of the specified type with the specified new filter.
`void`	`remove(IoFilter filter)` Replace the filter with the specified name with the specified new filter.
`IoFilter`	`remove(String name)` Removes the filter with the specified name from this chain.
`IoFilter`	`replace(Class<? extends IoFilter> oldFilterType, IoFilter newFilter)` Replace the filter of the specified type with the specified new filter.
`void`	`replace(IoFilter oldFilter, IoFilter newFilter)` Replace the filter with the specified name with the specified new filter.
`IoFilter`	`replace(String name, IoFilter newFilter)` Replace the filter with the specified name with the specified new filter.
`String`	`toString()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

SESSION_CREATED_FUTURE

public static final AttributeKey SESSION_CREATED_FUTURE

A session attribute that stores an IoFuture related with the IoSession. DefaultIoFilterChain clears this attribute and notifies the future when fireSessionCreated() or fireExceptionCaught(Throwable) is invoked.

Constructor Detail

DefaultIoFilterChain

public DefaultIoFilterChain(AbstractIoSession session)

Create a new default chain, associated with a session. It will only contain a HeadFilter and a TailFilter.

Parameters:: session - The session associated with the created filter chain

Method Detail