Module com.aoindustries.firewalld

Package com.aoindustries.firewalld

Class Target

java.lang.Object

com.aoindustries.firewalld.Target

All Implemented Interfaces:

Comparable<Target>

public class Target
extends Object
implements Comparable<Target>

A "target" is a single address/prefix, protocol, and optional port range.

Each Service may have multiple targets, but all targets will be within its IPv4 destination and IPv6 destination.

A ServiceSet goes beyond the single-destination limits of Service and allows any arbitrary set of targets.

We choose the name "target" as it is the primary new concept and purpose of this API and is otherwise not used in standard firewalld service terminology.

Author:

AO Industries, Inc.

Constructor Summary

Constructors

Constructor	Description
Target(InetAddressPrefix destination, IPortRange portRange)	Creates a new target.
Target(InetAddressPrefix destination, Protocol protocol)	Creates a new target.

Method Summary

Modifier and Type	Method	Description
Target	coalesce(Target other)	Combines this target with the given target if possible.
int	compareTo(Target other)	Ordered by destination, portRange, protocol; those with port ranges before those that are protocol-only.
boolean	equals(Object obj)
InetAddressPrefix	getDestination()	Gets the destination network range for this target.
IPortRange	getPortRange()	Gets the optional port range for this target.
Protocol	getProtocol()	Gets the protocol for this target.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Target

public Target(InetAddressPrefix destination,
 IPortRange portRange)

Creates a new target.

Parameters:

destination - The destination is normalized

Target

public Target(InetAddressPrefix destination,
 Protocol protocol)

Creates a new target.

Parameters:

destination - The destination is normalized

Method Details

toString

public String toString()

Overrides:

toString in class Object

Returns:

The target in form [port[-range]/]protocol@address[/prefix].

See Also:

• IPortRange.toString()
• Protocol.toString()
• InetAddressPrefix.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Target other)

Ordered by destination, portRange, protocol; those with port ranges before those that are protocol-only.

Specified by:

compareTo in interface Comparable<Target>

See Also:

• InetAddressPrefix.compareTo(com.aoapps.net.InetAddressPrefix)
• IPortRange.compareTo(com.aoapps.net.IPortRange)

getDestination

public InetAddressPrefix getDestination()

Gets the destination network range for this target.

Returns:

The normalized destination

getProtocol

public Protocol getProtocol()

Gets the protocol for this target.

getPortRange

public IPortRange getPortRange()

Gets the optional port range for this target.

coalesce

public Target coalesce(Target other)

Combines this target with the given target if possible.

If have the same destination, tries to combine by protocol and port range. If have the same protocol and port range, tries to combine by destination network prefixes.

When combining by protocol and port range, a target with no port range matches all ports on that protocol.

Returns:

The new target that represents the union of this and the other target or null when they cannot be combined.