Package io.netty.handler.ipfilter

Class RuleBasedIpFilter

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

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

io.netty.handler.ipfilter.RuleBasedIpFilter

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

@Sharable
public class RuleBasedIpFilter
extends AbstractRemoteAddressFilter<InetSocketAddress>

This class allows one to filter new Channels based on the IpFilterRules passed to its constructor. If no rules are provided, all connections will be accepted.

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

Consider using IpSubnetFilter for better performance while not as general purpose as this filter.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor	Description
RuleBasedIpFilter(boolean acceptIfNotFound, IpFilterRule... rules)	Create new Instance of RuleBasedIpFilter and filter incoming connections based on their IP address and rules applied.
RuleBasedIpFilter(IpFilterRule... rules)	Deprecated. Use RuleBasedIpFilter(boolean, IpFilterRule...)

Method Summary

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

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

Constructor Detail

RuleBasedIpFilter

@Deprecated
public RuleBasedIpFilter(IpFilterRule... rules)

Deprecated.

Use RuleBasedIpFilter(boolean, IpFilterRule...)

Create new Instance of RuleBasedIpFilter and filter incoming connections based on their IP address and rules applied.

acceptIfNotFound is set to true.

Parameters:

rules - An array of IpFilterRule containing all rules.

RuleBasedIpFilter

public RuleBasedIpFilter(boolean acceptIfNotFound,
                         IpFilterRule... rules)

Create new Instance of RuleBasedIpFilter and filter incoming connections based on their IP address and rules applied.

Parameters:

acceptIfNotFound - If true then accept connection from IP Address if it doesn't match any rule.

rules - An array of IpFilterRule containing all rules.

Method Detail

accept

protected boolean accept(io.netty.channel.ChannelHandlerContext ctx,
                         InetSocketAddress remoteAddress)
                  throws Exception

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.

Throws:

Exception