Package org.kiwiproject.registry.model

Class Port

java.lang.Object

org.kiwiproject.registry.model.Port

public class Port
extends Object

Model that defines a port being used by a service, including the port number, the purpose of the port, and whether the port is secure or not.

For the type/purpose of the port, we are assuming that a service has a separate ports for the main application and the administrative endpoints (e.g. status and health checks)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Port.PortType	Enum defining the type of connector the port is used for.
static class	Port.Security	Enum defining whether the port is secure or not.

Constructor Summary

Constructors

Constructor	Description
Port()

Method Summary

Modifier and Type	Method	Description
String	getScheme()	Return the scheme used by the Port.Security of this port.
boolean	isAdmin()	Is this an admin port?
boolean	isApplication()	Is this an application port?
boolean	isSecure()	Is this port secure?
static Port	of(int number, Port.PortType portType, Port.Security security)	Convenience factory method to create a new Port.

Methods inherited from class java.lang.Object

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

Constructor Detail

Port

public Port()

Method Detail

of

public static Port of(int number,
                      @Nullable
                      Port.PortType portType,
                      @Nullable
                      Port.Security security)

Convenience factory method to create a new Port.

Default values are assigned to the port type and security if null arguments are supplied.

Parameters:

number - the port number, must be in range 0 to 65535

portType - the type of port (defaults to APPLICATION if null)

security - is the port secure? (defaults to SECURE if null)

Returns:

a new instance

isSecure

public boolean isSecure()

Is this port secure?

Returns:

true if this port is Port.Security.SECURE

getScheme

public String getScheme()

Return the scheme used by the Port.Security of this port.

Returns:

the scheme (e.g. "https") for connecting to this port

isApplication

public boolean isApplication()

Is this an application port?

Returns:

true if port type is Port.PortType.APPLICATION

isAdmin

public boolean isAdmin()

Is this an admin port?

Returns:

true if port type is Port.PortType.ADMIN