at.jku.fim.rubanetra.config.model

Class PortSpecification

java.lang.Object

at.jku.fim.rubanetra.config.model.PortSpecification

Direct Known Subclasses:

PortSpecification.UniversalPortSpecification

public class PortSpecification
extends Object

This class constitutes a higher level specification of the mapping between an application layer protocol and the associated transport layer (TCP/UDP) port numbers and/or port ranges. It is utilized for a number of Kraken application layer protocol parser to transport layer mapping abstractions, e.g. TransportLayerMappingStrategy, and configured by an instance of KrakenProtocolConfigurationBuilder resulting in a KrakenProtocolConfiguration object. Note, that this implementation currently utilizes the Java 8 - Stream API for performing PortRange bound checking via predicates, see contains(Port). Additionally, the subclass PortSpecification.UniversalPortSpecification was defined for convenience reasons. This class is not thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PortSpecification.UniversalPortSpecification A port specification that returns either always true or always false for any given port number.

Constructor Summary

Constructors

Constructor and Description
PortSpecification()

Method Summary

Modifier and Type	Method and Description
void	add(Port singlePort) Adds a single port to this specification.
void	add(PortRange portRange) Adds a new port-range to this specification.
boolean	contains(int destinationPort) This is a convenience method for contains(Port).
boolean	contains(Port destinationPort) Performs a bound check according to the underlying specification.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortSpecification

public PortSpecification()

Method Detail

add

public void add(Port singlePort)

Adds a single port to this specification. A previously defined port with the same port number will be overwritten silently.

Parameters:

singlePort - the port to add to this specification

Throws:

IllegalArgumentException - if singlePort == null

add

public void add(PortRange portRange)

Adds a new port-range to this specification. A HashSet is used internally to store the port ranges.

Parameters:

portRange - the port range to add to this specification

Throws:

IllegalArgumentException - if the portRange is null

contains

public boolean contains(int destinationPort)

This is a convenience method for contains(Port). A new Port is constructed for the passed integer argument.

Parameters:

destinationPort - the port number to check against this specification

Returns:

false, if the given port was null or if it does not conform to the bounds of this specification, true, iff the given port is backed by either a port-range or a single port number.

Throws:

IllegalArgumentException - if the port number is invalid

See Also:

contains(Port)

contains

public boolean contains(Port destinationPort)

Performs a bound check according to the underlying specification. A port adheres to the specification iff it was specified as a single Port or any specified PortRange returns true by calling PortRange.isWithinRange(Port). A Java 8 predicate check via the new stream-API is currently used for this check.

Parameters:

destinationPort - the port to check against this specification

Returns:

false, if the given port was null or if it does not conform to the bounds of this specification, true, iff the given port is backed by either a port-range or a single port number.