io.netty.handler.ipfilter

Class IpSubnetFilterRule

java.lang.Object

io.netty.handler.ipfilter.IpSubnetFilterRule

All Implemented Interfaces:

IpFilterRule, Comparable<IpSubnetFilterRule>

public final class IpSubnetFilterRule
extends Object
implements IpFilterRule, Comparable<IpSubnetFilterRule>

Use this class to create rules for RuleBasedIpFilter that group IP addresses into subnets. Supports both, IPv4 and IPv6.

Constructor Summary

Constructors

Constructor and Description
IpSubnetFilterRule(InetAddress ipAddress, int cidrPrefix, IpFilterRuleType ruleType) Create a new IpSubnetFilterRule instance
IpSubnetFilterRule(String ipAddress, int cidrPrefix, IpFilterRuleType ruleType) Create a new IpSubnetFilterRule instance
IpSubnetFilterRule(String ipAddressWithCidr, IpFilterRuleType ruleType) Create a new IpSubnetFilterRule instance

Method Summary

Modifier and Type	Method and Description
int	compareTo(IpSubnetFilterRule ipSubnetFilterRule)
boolean	matches(InetSocketAddress remoteAddress)
IpFilterRuleType	ruleType()

Methods inherited from class java.lang.Object

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

Constructor Detail

IpSubnetFilterRule

public IpSubnetFilterRule(String ipAddressWithCidr,
                          IpFilterRuleType ruleType)

Create a new IpSubnetFilterRule instance

Parameters:

ipAddressWithCidr - IP Address with CIDR notation, e.g. (192.168.0.0/16) or (2001:db8::/32)

ruleType - IpFilterRuleType to use

IpSubnetFilterRule

public IpSubnetFilterRule(String ipAddress,
                          int cidrPrefix,
                          IpFilterRuleType ruleType)

Create a new IpSubnetFilterRule instance

Parameters:

ipAddress - IP Address as String

cidrPrefix - CIDR Prefix

ruleType - IpFilterRuleType to use

IpSubnetFilterRule

public IpSubnetFilterRule(InetAddress ipAddress,
                          int cidrPrefix,
                          IpFilterRuleType ruleType)

Create a new IpSubnetFilterRule instance

Parameters:

ipAddress - IP Address as InetAddress

cidrPrefix - CIDR Prefix

ruleType - IpFilterRuleType to use

Method Detail

matches

public boolean matches(InetSocketAddress remoteAddress)

Specified by:

matches in interface IpFilterRule

Returns:

This method should return true if remoteAddress is valid according to your criteria. False otherwise.

ruleType

public IpFilterRuleType ruleType()

Specified by:

ruleType in interface IpFilterRule

Returns:

This method should return IpFilterRuleType.ACCEPT if all IpFilterRule.matches(InetSocketAddress) for which IpFilterRule.matches(InetSocketAddress) returns true should the accepted. If you want to exclude all of those IP addresses then IpFilterRuleType.REJECT should be returned.

compareTo

public int compareTo(IpSubnetFilterRule ipSubnetFilterRule)

Specified by:

compareTo in interface Comparable<IpSubnetFilterRule>