Class IpAllowlist

java.lang.Object

eu.cloudnetservice.node.impl.util.IpAllowlist

public final class IpAllowlist
extends Object

An allowlist for IP addresses that is able to parse and process subnets and static IP addresses.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final record	IpAllowlist.ParsedAllowlistEntry	An allowlist entry that was parsed from a subnet.

Field Summary

Fields

Modifier and Type	Field	Description
private final Collection<IpAllowlist.ParsedAllowlistEntry>	entries
private static final org.slf4j.Logger	LOGGER
private final int	originalAllowlistHashCode

Constructor Summary

Constructors

Modifier	Constructor	Description
private	IpAllowlist(int originalAllowlistHashCode, @NonNull Collection<IpAllowlist.ParsedAllowlistEntry> entries)	Constructs a new allowlist instance.

Method Summary

Modifier and Type	Method	Description
boolean	allows(@NonNull InetAddress address)	Checks if the given address is allowed by an entry of this allowlist.
static @NonNull IpAllowlist	parse(@NonNull Collection<String> allowlist)	Parses an allowlist from the given collection of subnets or static ip addresses.
@NonNull IpAllowlist	updateIfNecessary(@NonNull Collection<String> allowList)	Updates this allowlist instance if the given allowlist is different from the original allowlist that was used to construct this instance.

Methods inherited from class Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

originalAllowlistHashCode

private final int originalAllowlistHashCode

entries

private final Collection<IpAllowlist.ParsedAllowlistEntry> entries

Constructor Details

IpAllowlist

private IpAllowlist(int originalAllowlistHashCode,
 @NonNull
 @NonNull Collection<IpAllowlist.ParsedAllowlistEntry> entries)

Constructs a new allowlist instance. For internal use only, use parse(Collection) instead.

Parameters:

originalAllowlistHashCode - the hashcode of the original allowlist that was parsed.

entries - the entries of the newly constructed allowlist.

Throws:

NullPointerException - if the given entries collection is null.

Method Details

parse

@NonNull
public static @NonNull IpAllowlist parse(@NonNull
 @NonNull Collection<String> allowlist)

Parses an allowlist from the given collection of subnets or static ip addresses. All null entries are ignored, for invalid entries a warning log message is printed.

Parameters:

allowlist - the allowlist to parse.

Returns:

a new allowlist instance based on the parsed given allowlist.

Throws:

NullPointerException - if the given allowlist is null.

updateIfNecessary

@CheckReturnValue
@NonNull
public @NonNull IpAllowlist updateIfNecessary(@NonNull
 @NonNull Collection<String> allowList)

Updates this allowlist instance if the given allowlist is different from the original allowlist that was used to construct this instance. If the given allowlist is the same as the original allowlist, this instance is returned. Otherwise, a new instance is created for the given allowlist and returned instead.

Parameters:

allowList - the allowlist to check for changes and return a new instance for, if necessary.

Returns:

a new allowlist if the given allowlist is different from the original allowlist, otherwise this instance.

Throws:

NullPointerException - if the given allowlist is null.

allows

public boolean allows(@NonNull
 @NonNull InetAddress address)

Checks if the given address is allowed by an entry of this allowlist.

Parameters:

address - the address to check.

Returns:

true if the given address is allowed, false otherwise.

Throws:

NullPointerException - if the given address is null.