Class IpSubnetFilter

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

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

io.netty.handler.ipfilter.IpSubnetFilter

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

@Sharable
public class IpSubnetFilter
extends AbstractRemoteAddressFilter<InetSocketAddress>

This class allows one to filter new Channels based on the IpSubnetFilters passed to its constructor. If no rules are provided, all connections will be accepted since acceptIfNotFound is true by default.

If you would like to explicitly take action on rejected Channels, you should override AbstractRemoteAddressFilter.channelRejected(ChannelHandlerContext, SocketAddress).

Few Points to keep in mind:

1. Since IpSubnetFilter uses Binary search algorithm, it's a good idea to insert IP addresses in incremental order.
2. Remove any over-lapping CIDR.

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Modifier and Type	Interface	Description
static @interface	ChannelHandler.Sharable	Indicates that the same instance of the annotated ChannelHandler can be added to one or more ChannelPipelines multiple times without a race condition.

Constructor Summary

Constructors

Constructor	Description
IpSubnetFilter(boolean acceptIfNotFound, IpSubnetFilterRule... rules)	Create new IpSubnetFilter Instance with specified IpSubnetFilterRule as array and specify if we'll accept a connection if we don't find it in the rule(s).
IpSubnetFilter(boolean acceptIfNotFound, List<IpSubnetFilterRule> rules)	Create new IpSubnetFilter Instance with specified IpSubnetFilterRule as List and specify if we'll accept a connection if we don't find it in the rule(s).
IpSubnetFilter(IpSubnetFilterRule... rules)	Create new IpSubnetFilter Instance with specified IpSubnetFilterRule as array.
IpSubnetFilter(List<IpSubnetFilterRule> rules)	Create new IpSubnetFilter Instance with specified IpSubnetFilterRule as List.

Method Summary

Modifier and Type	Method	Description
protected boolean	accept(ChannelHandlerContext ctx, InetSocketAddress remoteAddress)	This method is called immediately after a Channel gets registered.

Methods inherited from class AbstractRemoteAddressFilter

channelAccepted, channelActive, channelRegistered, channelRejected

Modifier and Type	Method	Description
protected void	channelAccepted(ChannelHandlerContext ctx, InetSocketAddress remoteAddress)	This method is called if remoteAddress gets accepted by AbstractRemoteAddressFilter.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, InetSocketAddress remoteAddress)	This method is called if remoteAddress gets rejected by AbstractRemoteAddressFilter.accept(ChannelHandlerContext, SocketAddress).

Methods inherited from class ChannelInboundHandlerAdapter

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

Modifier and Type	Method	Description
void	channelInactive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRead(ChannelHandlerContext ctx, Object msg)	Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelReadComplete(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelUnregistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelWritabilityChanged(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
void	userEventTriggered(ChannelHandlerContext ctx, Object evt)	Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Modifier and Type	Method	Description
protected void	ensureNotSharable()	Throws IllegalStateException if ChannelHandlerAdapter.isSharable() returns true
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
void	handlerRemoved(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
boolean	isSharable()	Return true if the implementation is ChannelHandler.Sharable and so can be added to different ChannelPipelines.

Methods inherited from class Object

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

Constructor Details

IpSubnetFilter

public IpSubnetFilter(IpSubnetFilterRule... rules)

Create new IpSubnetFilter Instance with specified IpSubnetFilterRule as array.

acceptIfNotFound is set to true.

Parameters:

rules - IpSubnetFilterRule as an array

IpSubnetFilter

public IpSubnetFilter(boolean acceptIfNotFound,
 IpSubnetFilterRule... rules)

Create new IpSubnetFilter Instance with specified IpSubnetFilterRule as array and specify if we'll accept a connection if we don't find it in the rule(s).

Parameters:

acceptIfNotFound - true if we'll accept connection if not found in rule(s).

rules - IpSubnetFilterRule as an array

IpSubnetFilter

public IpSubnetFilter(List<IpSubnetFilterRule> rules)

Create new IpSubnetFilter Instance with specified IpSubnetFilterRule as List.

acceptIfNotFound is set to true.

Parameters:

rules - IpSubnetFilterRule as a List

IpSubnetFilter

public IpSubnetFilter(boolean acceptIfNotFound,
 List<IpSubnetFilterRule> rules)

Create new IpSubnetFilter Instance with specified IpSubnetFilterRule as List and specify if we'll accept a connection if we don't find it in the rule(s).

Parameters:

acceptIfNotFound - true if we'll accept connection if not found in rule(s).

rules - IpSubnetFilterRule as a List

Method Details

accept

protected boolean accept(ChannelHandlerContext ctx,
 InetSocketAddress remoteAddress)

Description copied from class: AbstractRemoteAddressFilter

This method is called immediately after a Channel gets registered.

Specified by:

accept in class AbstractRemoteAddressFilter<InetSocketAddress>

Returns:

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