io.netty.handler.ipfilter

Class AbstractRemoteAddressFilter<T extends SocketAddress>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.ipfilter.AbstractRemoteAddressFilter<T>

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

Direct Known Subclasses:

RuleBasedIpFilter, UniqueIpFilter

public abstract class AbstractRemoteAddressFilter<T extends SocketAddress>
extends ChannelInboundHandlerAdapter

This class provides the functionality to either accept or reject new Channels based on their IP address.

You should inherit from this class if you would like to implement your own IP-based filter. Basically you have to implement accept(ChannelHandlerContext, SocketAddress) to decided whether you want to accept or reject a connection from the remote address.

Furthermore overriding channelRejected(ChannelHandlerContext, SocketAddress) gives you the flexibility to respond to rejected (denied) connections. If you do not want to send a response, just have it return null. Take a look at RuleBasedIpFilter for details.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
AbstractRemoteAddressFilter()

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	accept(ChannelHandlerContext ctx, T remoteAddress) This method is called immediately after a Channel gets registered.
protected void	channelAccepted(ChannelHandlerContext ctx, T remoteAddress) This method is called if remoteAddress gets accepted by accept(ChannelHandlerContext, SocketAddress).
void	channelActive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRegistered(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected ChannelFuture	channelRejected(ChannelHandlerContext ctx, T remoteAddress) This method is called if remoteAddress gets rejected by accept(ChannelHandlerContext, SocketAddress).

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelInactive, channelRead, channelReadComplete, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Detail

AbstractRemoteAddressFilter

public AbstractRemoteAddressFilter()

Method Detail

channelRegistered

public void channelRegistered(ChannelHandlerContext ctx)
                       throws Exception

Description copied from class: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelRegistered in interface ChannelInboundHandler

Overrides:

channelRegistered in class ChannelInboundHandlerAdapter

Throws:

Exception

channelActive

public void channelActive(ChannelHandlerContext ctx)
                   throws Exception

Description copied from class: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelActive in interface ChannelInboundHandler

Overrides:

channelActive in class ChannelInboundHandlerAdapter

Throws:

Exception

accept

protected abstract boolean accept(ChannelHandlerContext ctx,
                                  T remoteAddress)
                           throws Exception

This method is called immediately after a Channel gets registered.

Returns:

Return true if connections from this IP address and port should be accepted. False otherwise.

Throws:

Exception

channelAccepted

protected void channelAccepted(ChannelHandlerContext ctx,
                               T remoteAddress)

This method is called if remoteAddress gets accepted by accept(ChannelHandlerContext, SocketAddress). You should override it if you would like to handle (e.g. respond to) accepted addresses.

channelRejected

protected ChannelFuture channelRejected(ChannelHandlerContext ctx,
                                        T remoteAddress)

This method is called if remoteAddress gets rejected by accept(ChannelHandlerContext, SocketAddress). You should override it if you would like to handle (e.g. respond to) rejected addresses.

Returns:

A ChannelFuture if you perform I/O operations, so that the Channel can be closed once it completes. Null otherwise.