Package io.netty.handler.ipfilter

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 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	acceptIfNotFound
private final IpFilterRuleType	ipFilterRuleTypeIPv4
private final IpFilterRuleType	ipFilterRuleTypeIPv6
private final IpSubnetFilterRule[]	ipv4Rules
private final IpSubnetFilterRule[]	ipv6Rules

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.
private static IpSubnetFilterRule[]	sortAndFilter(List<IpSubnetFilterRule> rules)	Sort the list Remove over-lapping subnet Sort the list again

Methods inherited from class io.netty.handler.ipfilter.AbstractRemoteAddressFilter

channelAccepted, channelActive, channelRegistered, channelRejected

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

Field Details

acceptIfNotFound

private final boolean acceptIfNotFound

ipv4Rules

private final IpSubnetFilterRule[] ipv4Rules

ipv6Rules

private final IpSubnetFilterRule[] ipv6Rules

ipFilterRuleTypeIPv4

private final IpFilterRuleType ipFilterRuleTypeIPv4

ipFilterRuleTypeIPv6

private final IpFilterRuleType ipFilterRuleTypeIPv6

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.

sortAndFilter

private static IpSubnetFilterRule[] sortAndFilter(List<IpSubnetFilterRule> rules)

1. Sort the list
2. Remove over-lapping subnet
3. Sort the list again