Package org.forgerock.opendj.ldap

Class AddressMask

java.lang.Object
org.forgerock.opendj.ldap.AddressMask
public final class AddressMask extends Object
An address mask can be used to perform efficient comparisons against IP addresses to determine whether a particular IP address is in a given range.

  • Method Details

    • isIn

      public static boolean isIn(Collection<AddressMask> masks, InetAddress address)
      Returns true if an address matches any of the provided address masks.
      Parameters:
      masks - A collection of address masks to check.
      address - The address.
      Returns:
      true if an address matches any of the provided address masks

    • isAllowed

      public static boolean isAllowed(Collection<AddressMask> masks, InetAddress address)
      Returns true if an address is in the provided allow list. The address is tested only when a non-empty collection of address masks is provided.
      Parameters:
      masks - A collection of address masks to check.
      address - The address.
      Returns:
      true if an address is in the provided allow list

    • isDenied

      public static boolean isDenied(Collection<AddressMask> masks, InetAddress address)
      Returns true if an address is in the provided deny list.
      Parameters:
      masks - A collection of address masks to check.
      address - The address.
      Returns:
      true if an address is in the provided deny list

    • valueOf

      public static AddressMask valueOf(String mask)
      Parses the provided string as an address mask.
      Parameters:
      mask - The address mask string to be parsed.
      Returns:
      The parsed address mask.
      Throws:
      LocalizedIllegalArgumentException - If the provided string cannot be decoded as an address mask.

    • matches

      public boolean matches(InetAddress address)
      Returns true if this address mask matches the provided address.
      Parameters:
      address - The address
      Returns:
      true if this address mask matches the provided address

    • toString

      public String toString()
      Overrides:
      toString in class Object