com.communote.server.core.security.iprange

Class IpRangeHelper

java.lang.Object

com.communote.server.core.security.iprange.IpRangeHelper

public class IpRangeHelper
extends Object

Helper class for IpV6 address calculations.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
static String	byteToString(byte[] value) Transform byte array to ipv6 notation.
static BigInteger	getBroadcastAddress(BigInteger ip, BigInteger netmask) Gets the broadcast address.
static BigInteger	getNetAddress(BigInteger ip, BigInteger netmask) Gets the net address.
static BigInteger	getSubNetMask(int bits) Gets the bit mask.
static BigInteger	getSubNetMask(String ip) Gets the sub net mask for the given ip.
static boolean	ipInRange(BigInteger ip, BigInteger start, BigInteger end) Checks if if the IP is in range.
static boolean	ipInRange(String ip, String start, String end) Checks if if the IP is in range.
static BigInteger	ipToInt(String ip) Transform the given ipv6 address to 128 bit integer.
static String	ipToString(BigInteger ip) Transform the given 128 bit value to ipv6 notation.
static String	rangesToString(Collection<IpRange> ranges, String delimiter) Transform ranges to string.
static IpRange	stringToRange(String iprange) Parse an iP range.
static List<IpRange>	stringToRanges(String text, String delimiter) Parses multiple IP ranges.
static boolean	validateIP(String ip) Validate ip.

Methods inherited from class java.lang.Object

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

Method Detail

byteToString

public static String byteToString(byte[] value)

Transform byte array to ipv6 notation.

Parameters:

value - the byte array

Returns:

the string in ipv6 notation

getBroadcastAddress

public static BigInteger getBroadcastAddress(BigInteger ip,
                                             BigInteger netmask)

Gets the broadcast address.

Parameters:

ip - the ip

netmask - the netmask

Returns:

the broadcast address

getNetAddress

public static BigInteger getNetAddress(BigInteger ip,
                                       BigInteger netmask)

Gets the net address.

Parameters:

ip - the ip

netmask - the netmask

Returns:

the net address

getSubNetMask

public static BigInteger getSubNetMask(int bits)

Gets the bit mask.

Parameters:

bits - the bits to set

Returns:

the net mask

getSubNetMask

public static BigInteger getSubNetMask(String ip)

Gets the sub net mask for the given ip.

Parameters:

ip - the ip

Returns:

the sub net mask

ipInRange

public static boolean ipInRange(BigInteger ip,
                                BigInteger start,
                                BigInteger end)

Checks if if the IP is in range.

Parameters:

ip - the ip

start - the start of the range

end - the end of the range

Returns:

true, if IP is in range

ipInRange

public static boolean ipInRange(String ip,
                                String start,
                                String end)
                         throws InvalidIpRangeException,
                                InvalidIpAddressException

Checks if if the IP is in range.

Parameters:

ip - the ip

start - the start of the range

end - the end of the range

Returns:

true, if IP is in range

Throws:

InvalidIpRangeException - the invalid IP range exception

InvalidIpAddressException - the invalid IP address exception

ipToInt

public static BigInteger ipToInt(String ip)
                          throws InvalidIpAddressException

Transform the given ipv6 address to 128 bit integer.

Parameters:

ip - the ip

Returns:

the IP as 128 bit integer

Throws:

InvalidIpAddressException - the invalid IP address exception

ipToString

public static String ipToString(BigInteger ip)

Transform the given 128 bit value to ipv6 notation.

Parameters:

ip - the ip

Returns:

the string in ipv6 notation

rangesToString

public static String rangesToString(Collection<IpRange> ranges,
                                    String delimiter)

Transform ranges to string. The method will first look for the stringRepresentation member of the IpRange and take it if it is not null. Otherwise the members start and end will be converted to an IPv6 IP address range.

Parameters:

ranges - the ranges

delimiter - the delimiter

Returns:

the string

stringToRange

public static IpRange stringToRange(String iprange)
                             throws InvalidIpRangeException,
                                    InvalidIpAddressException

Parse an iP range.

Parameters:

iprange - the iprange

Returns:

the iP range

Throws:

InvalidIpRangeException - the invalid IP range exception

InvalidIpAddressException - the invalid IP address exception

stringToRanges

public static List<IpRange> stringToRanges(String text,
                                           String delimiter)
                                    throws InvalidIpRangeException,
                                           InvalidIpAddressException

Parses multiple IP ranges.

Parameters:

text - the text

delimiter - the delimiter

Returns:

a list of IP ranges

Throws:

InvalidIpRangeException - the invalid IP range exception

InvalidIpAddressException - the invalid IP address exception

validateIP

public static boolean validateIP(String ip)

Validate ip. Accepts ipv4 and ipv6 notation.

Parameters:

ip - the ip

Returns:

true, if successful