Class BaseFilter
- java.lang.Object
-
- org.glassfish.grizzly.filterchain.BaseFilter
-
- All Implemented Interfaces:
Filter
- Direct Known Subclasses:
AbstractCodecFilter
,ActivityCheckFilter
,DelayFilter
,EchoFilter
,GZipFilter
,IdleTimeoutFilter
,LogFilter
,LZMAFilter
,SilentConnectionFilter
,SSLBaseFilter
,TCPNIOTransportFilter
,TransportFilter
,UDPNIOTransportFilter
public class BaseFilter extends Object implements Filter
Provides empty implementation forFilter
processing methods.- Author:
- Alexey Stashok
- See Also:
Filter
-
-
Constructor Summary
Constructors Constructor Description BaseFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FilterChainContext
createContext(Connection connection, FilterChainContext.Operation operation)
void
exceptionOccurred(FilterChainContext ctx, Throwable error)
Notification about exception, occurred on theFilterChain
NextAction
handleAccept(FilterChainContext ctx)
Execute a unit of processing work to be performed, when server channel has accepted the client connection.NextAction
handleClose(FilterChainContext ctx)
Execute a unit of processing work to be performed, when connection has been closed.NextAction
handleConnect(FilterChainContext ctx)
Execute a unit of processing work to be performed, when channel gets connected.NextAction
handleEvent(FilterChainContext ctx, FilterChainEvent event)
Handle custom event associated with theConnection
.NextAction
handleRead(FilterChainContext ctx)
Execute a unit of processing work to be performed, when channel will become available for reading.NextAction
handleWrite(FilterChainContext ctx)
Execute a unit of processing work to be performed, when some data should be written on channel.void
onAdded(FilterChain filterChain)
Method is called, when the Filter has been added to the passedFilterChain
.void
onFilterChainChanged(FilterChain filterChain)
Method is called, when theFilterChain
this Filter is part of, has been changed.void
onRemoved(FilterChain filterChain)
Method is called, when the Filter has been removed from the passedFilterChain
.String
toString()
-
-
-
Method Detail
-
onAdded
public void onAdded(FilterChain filterChain)
Method is called, when the Filter has been added to the passedFilterChain
.- Specified by:
onAdded
in interfaceFilter
- Parameters:
filterChain
- theFilterChain
this Filter was added to.
-
onFilterChainChanged
public void onFilterChainChanged(FilterChain filterChain)
Method is called, when theFilterChain
this Filter is part of, has been changed.- Specified by:
onFilterChainChanged
in interfaceFilter
- Parameters:
filterChain
- theFilterChain
.
-
onRemoved
public void onRemoved(FilterChain filterChain)
Method is called, when the Filter has been removed from the passedFilterChain
.- Specified by:
onRemoved
in interfaceFilter
- Parameters:
filterChain
- theFilterChain
this Filter was removed from.
-
handleRead
public NextAction handleRead(FilterChainContext ctx) throws IOException
Execute a unit of processing work to be performed, when channel will become available for reading. ThisFilter
may either complete the required processing and return false, or delegate remaining processing to the nextFilter
in aFilterChain
containing thisFilter
by returning true.- Specified by:
handleRead
in interfaceFilter
- Parameters:
ctx
-FilterChainContext
- Returns:
NextAction
instruction forFilterChain
, how it should continue the execution- Throws:
IOException
-
handleWrite
public NextAction handleWrite(FilterChainContext ctx) throws IOException
Execute a unit of processing work to be performed, when some data should be written on channel. ThisFilter
may either complete the required processing and return false, or delegate remaining processing to the nextFilter
in aFilterChain
containing thisFilter
by returning true.- Specified by:
handleWrite
in interfaceFilter
- Parameters:
ctx
-FilterChainContext
- Returns:
NextAction
instruction forFilterChain
, how it should continue the execution- Throws:
IOException
-
handleConnect
public NextAction handleConnect(FilterChainContext ctx) throws IOException
Execute a unit of processing work to be performed, when channel gets connected. ThisFilter
may either complete the required processing and return false, or delegate remaining processing to the nextFilter
in aFilterChain
containing thisFilter
by returning true.- Specified by:
handleConnect
in interfaceFilter
- Parameters:
ctx
-FilterChainContext
- Returns:
NextAction
instruction forFilterChain
, how it should continue the execution- Throws:
IOException
-
handleAccept
public NextAction handleAccept(FilterChainContext ctx) throws IOException
Execute a unit of processing work to be performed, when server channel has accepted the client connection. ThisFilter
may either complete the required processing and return false, or delegate remaining processing to the nextFilter
in aFilterChain
containing thisFilter
by returning true.- Specified by:
handleAccept
in interfaceFilter
- Parameters:
ctx
-FilterChainContext
- Returns:
NextAction
instruction forFilterChain
, how it should continue the execution- Throws:
IOException
-
handleEvent
public NextAction handleEvent(FilterChainContext ctx, FilterChainEvent event) throws IOException
Handle custom event associated with theConnection
. ThisFilter
may either complete the required processing and returnStopAction
, or delegate remaining processing to the nextFilter
in aFilterChain
containing thisFilter
by returningInvokeAction
.- Specified by:
handleEvent
in interfaceFilter
- Parameters:
ctx
-FilterChainContext
- Returns:
NextAction
instruction forFilterChain
, how it should continue the execution- Throws:
IOException
-
handleClose
public NextAction handleClose(FilterChainContext ctx) throws IOException
Execute a unit of processing work to be performed, when connection has been closed. ThisFilter
may either complete the required processing and return false, or delegate remaining processing to the nextFilter
in aFilterChain
containing thisFilter
by returning true.- Specified by:
handleClose
in interfaceFilter
- Parameters:
ctx
-FilterChainContext
- Returns:
NextAction
instruction forFilterChain
, how it should continue the execution- Throws:
IOException
-
exceptionOccurred
public void exceptionOccurred(FilterChainContext ctx, Throwable error)
Notification about exception, occurred on theFilterChain
- Specified by:
exceptionOccurred
in interfaceFilter
- Parameters:
ctx
- event processingFilterChainContext
error
- error, which occurred during FilterChain execution
-
createContext
public FilterChainContext createContext(Connection connection, FilterChainContext.Operation operation)
-
-