Package io.netty.handler.ipfilter

Class IpSubnetFilterRule

java.lang.Object

io.netty.handler.ipfilter.IpSubnetFilterRule

All Implemented Interfaces:

IpFilterRule, java.lang.Comparable<IpSubnetFilterRule>

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	IpSubnetFilterRule.Ip4SubnetFilterRule
(package private) static class	IpSubnetFilterRule.Ip6SubnetFilterRule

Field Summary

Fields

Modifier and Type	Field	Description
private IpFilterRule	filterRule
private java.lang.String	ipAddress

Constructor Summary

Constructors

Constructor	Description
IpSubnetFilterRule(java.lang.String ipAddress, int cidrPrefix, IpFilterRuleType ruleType)	Create a new IpSubnetFilterRule instance
IpSubnetFilterRule(java.lang.String ipAddressWithCidr, IpFilterRuleType ruleType)	Create a new IpSubnetFilterRule instance
IpSubnetFilterRule(java.net.InetAddress ipAddress, int cidrPrefix, IpFilterRuleType ruleType)	Create a new IpSubnetFilterRule instance

Method Summary

Modifier and Type	Method	Description
private static int	compareInt(int x, int y)	IPv4 addresses are compared as unsigned values, so 128.0.0.0 and above sort after 127.255.255.255.
int	compareTo(IpSubnetFilterRule ipSubnetFilterRule)
(package private) int	compareTo(java.net.InetSocketAddress inetSocketAddress)	It'll compare IP address with IpSubnetFilterRule.Ip4SubnetFilterRule.networkAddress or IpSubnetFilterRule.Ip6SubnetFilterRule.networkAddress.
(package private) boolean	contains(IpSubnetFilterRule other)	true if every address matched by other is also matched by this rule.
(package private) IpFilterRule	getFilterRule()	IpSubnetFilterRule.Ip4SubnetFilterRule or IpSubnetFilterRule.Ip6SubnetFilterRule
(package private) java.lang.String	getIpAddress()	Get IP Address of this rule
boolean	matches(java.net.InetSocketAddress remoteAddress)
IpFilterRuleType	ruleType()
private static IpFilterRule	selectFilterRule(java.net.InetAddress ipAddress, int cidrPrefix, IpFilterRuleType ruleType)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

filterRule

private final IpFilterRule filterRule

ipAddress

private final java.lang.String ipAddress

Constructor Detail

IpSubnetFilterRule

public IpSubnetFilterRule(java.lang.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(java.lang.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(java.net.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

selectFilterRule

private static IpFilterRule selectFilterRule(java.net.InetAddress ipAddress,
                                             int cidrPrefix,
                                             IpFilterRuleType ruleType)

matches

public boolean matches(java.net.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.

getIpAddress

java.lang.String getIpAddress()

Get IP Address of this rule

getFilterRule

IpFilterRule getFilterRule()

IpSubnetFilterRule.Ip4SubnetFilterRule or IpSubnetFilterRule.Ip6SubnetFilterRule

compareTo

public int compareTo(IpSubnetFilterRule ipSubnetFilterRule)

Specified by:

compareTo in interface java.lang.Comparable<IpSubnetFilterRule>

compareTo

int compareTo(java.net.InetSocketAddress inetSocketAddress)

It'll compare IP address with IpSubnetFilterRule.Ip4SubnetFilterRule.networkAddress or IpSubnetFilterRule.Ip6SubnetFilterRule.networkAddress.

Parameters:

inetSocketAddress - InetSocketAddress to match

Returns:

0 if IP Address match else difference index.

contains

boolean contains(IpSubnetFilterRule other)

true if every address matched by other is also matched by this rule.

compareInt

private static int compareInt(int x,
                              int y)

IPv4 addresses are compared as unsigned values, so 128.0.0.0 and above sort after 127.255.255.255.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object