Package org.kiwiproject.config

Class EndpointConfiguration

java.lang.Object

org.kiwiproject.config.EndpointConfiguration

public class EndpointConfiguration
extends Object

Configuration for a specific REST endpoint. Can be used standalone or in conjunction with SecureEndpointsConfiguration.

As this is a configuration class generally intended to be populated from external configuration, it is mutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EndpointConfiguration.Builder	To use this EndpointConfiguration.Builder standalone, use the builder() method.

Constructor Summary

Constructors

Constructor	Description
EndpointConfiguration()

Method Summary

Modifier and Type	Method	Description
static EndpointConfiguration.Builder	builder()	Return a new builder instance to create a standalone EndpointConfiguration.
static EndpointConfiguration.Builder	builder(SecureEndpointsConfiguration.Builder parent)	Return a new builder instance to create a EndpointConfiguration within a SecureEndpointsConfiguration.
String	getDomain()	A single domain, or a comma-separated list of domains.
List<String>	getDomains()	Return the domains as a list.
String	getPath()	The path component of the URI.
String	getPort()	The port the endpoint listens on.
String	getScheme()	The connection scheme, e.g. https or https.
String	getTag()	Use this to uniquely identify an endpoint within a SecureEndpointsConfiguration, or to provide a way to find an EndpointConfiguration in any collection of them, e.g. using a Stream.filter(Predicate) on a stream of endpoint configurations.
String	getURI()	Uses this endpoint's path to build a URI as a String.
URI	getUriObject()	Uses this endpoint's path to build a URI.
UrlRewriteConfiguration	getUrlRewriteConfiguration()	Configures any URI rewriting that should be performed when building URIs.
boolean	isSecure()	Returns true if the scheme is "wss" or "https".
void	setDomain(String singleDomainOrCsv)	Set the domain(s), which can be a single domain (e.g. example.org) or multiple domains separated by commas.
void	setPath(String path)	The path component of the URI.
void	setPort(String port)	The port the endpoint listens on.
void	setScheme(String scheme)	The connection scheme, e.g. https or https.
void	setTag(String tag)	Use this to uniquely identify an endpoint within a SecureEndpointsConfiguration, or to provide a way to find an EndpointConfiguration in any collection of them, e.g. using a Stream.filter(Predicate) on a stream of endpoint configurations.
void	setUrlRewriteConfiguration(UrlRewriteConfiguration urlRewriteConfiguration)	Configures any URI rewriting that should be performed when building URIs.
jakarta.ws.rs.core.UriBuilder	toUriBuilder()	Converts the URI returned by getURI() into a Jakarta REST UriBuilder.

Methods inherited from class java.lang.Object

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

Constructor Details

EndpointConfiguration

public EndpointConfiguration()

Method Details

builder

public static EndpointConfiguration.Builder builder()

Return a new builder instance to create a standalone EndpointConfiguration.

Returns:

the builder instance

builder

public static EndpointConfiguration.Builder builder(SecureEndpointsConfiguration.Builder parent)

Return a new builder instance to create a EndpointConfiguration within a SecureEndpointsConfiguration. Supply the SecureEndpointsConfiguration.Builder which is being used to build the SecureEndpointsConfiguration.

Parameters:

parent - the parent builder

Returns:

the builder instance

isSecure

public boolean isSecure()

Returns true if the scheme is "wss" or "https".

Returns:

true if using a secure scheme

setDomain

public void setDomain(String singleDomainOrCsv)

Set the domain(s), which can be a single domain (e.g. example.org) or multiple domains separated by commas. If a comma-separated list of domains is specified, whitespace is allowed and trimmed. For example this is valid: " domain-1.test , domain-2.test , domain-3.test " and results in the three domains "domain-1.test", "domain-2.test", and "domain-3.test".

Parameters:

singleDomainOrCsv - a single domain like example.org or a comma-delimited list of domains

getDomains

public List<String> getDomains()

Return the domains as a list.

Returns:

the list of domains

getURI

public String getURI()

Uses this endpoint's path to build a URI as a String. The host in the returned URI will be the result of round-robin among the domains returned by getDomains().

Returns:

the URI as a String

Implementation Note:

This currently builds URIs using simple string substitution, any leading or trailing slashes on the domain are stripped.

getUriObject

public URI getUriObject()

Uses this endpoint's path to build a URI.

Returns:

the URI as a URI

See Also:

• getURI()

toUriBuilder

public jakarta.ws.rs.core.UriBuilder toUriBuilder()

Converts the URI returned by getURI() into a Jakarta REST UriBuilder.

Note that Jakarta REST must be in the classpath when calling this method.

Returns:

a new UriBuilder instance

getTag

public String getTag()

Use this to uniquely identify an endpoint within a SecureEndpointsConfiguration, or to provide a way to find an EndpointConfiguration in any collection of them, e.g. using a Stream.filter(Predicate) on a stream of endpoint configurations.

See Also:

• SecureEndpointsConfiguration.getEndpointByTag(String)
• SecureEndpointsConfiguration.getEndpointByTagOrEmpty(String)

getScheme

public String getScheme()

The connection scheme, e.g. https or https.

getDomain

public String getDomain()

A single domain, or a comma-separated list of domains.

See Also:

• setDomain(String)

getPort

public String getPort()

The port the endpoint listens on.

getPath

public String getPath()

The path component of the URI.

getUrlRewriteConfiguration

public UrlRewriteConfiguration getUrlRewriteConfiguration()

Configures any URI rewriting that should be performed when building URIs.

setTag

public void setTag(String tag)

Use this to uniquely identify an endpoint within a SecureEndpointsConfiguration, or to provide a way to find an EndpointConfiguration in any collection of them, e.g. using a Stream.filter(Predicate) on a stream of endpoint configurations.

See Also:

• SecureEndpointsConfiguration.getEndpointByTag(String)
• SecureEndpointsConfiguration.getEndpointByTagOrEmpty(String)

setScheme

public void setScheme(String scheme)

The connection scheme, e.g. https or https.

setPort

public void setPort(String port)

The port the endpoint listens on.

setPath

public void setPath(String path)

The path component of the URI.

setUrlRewriteConfiguration

public void setUrlRewriteConfiguration(UrlRewriteConfiguration urlRewriteConfiguration)

Configures any URI rewriting that should be performed when building URIs.