Module io.netty5.handler

Package io.netty5.handler.ipfilter

Class IpSubnetFilter

java.lang.Object

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

io.netty5.handler.ipfilter.IpSubnetFilter

All Implemented Interfaces:

ChannelHandler

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.

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.
boolean	isSharable()	Returns true if this handler is sharable and thus can be added to more than one ChannelPipeline.

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

channelAccepted, channelActive, channelRegistered, channelRejected

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty5.channel.ChannelHandler

bind, channelExceptionCaught, channelInactive, channelInboundEvent, channelRead, channelReadComplete, channelShutdown, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, flush, handlerAdded, handlerRemoved, pendingOutboundBytes, read, register, sendOutboundEvent, shutdown, write

Constructor Detail

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 Detail

isSharable

public boolean isSharable()

Description copied from interface: ChannelHandler

Returns true if this handler is sharable and thus can be added to more than one ChannelPipeline. By default, this method returns false. If this method returns false, you have to create a new handler instance every time you add it to a pipeline because it has unshared state such as member variables.

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.