Package org.kiwiproject.config

Class EndpointConfiguration.Builder

java.lang.Object

org.kiwiproject.config.EndpointConfiguration.Builder

Enclosing class:

EndpointConfiguration

public static class EndpointConfiguration.Builder
extends Object

To use this EndpointConfiguration.Builder standalone, use the EndpointConfiguration.builder() method. When using this, do not call buildEndpoint() or else an IllegalStateException will be thrown since this method assumes the endpoint is being built in the context of a SecureEndpointsConfiguration.

To use this EndpointConfiguration.Builder as part of building a SecureEndpointsConfiguration, use the EndpointConfiguration.builder(SecureEndpointsConfiguration.Builder) method and supply the SecureEndpointsConfiguration instance that becomes the "parent" of this endpoint.

Implementation Note:

This was implemented well before we started using Lombok, thus the manual builder code. Since there are some differences here, e.g. the constructor accepting the "parent" and the buildEndpoint() method, not sure how feasible it is to refactor to use Lombok, or if it's worth bothering. In addition, we have left the original setXxx() methods in here and added Lombok-style xxx() methods. While permissible, you should be consistent in using all xxx() or all setXxx().

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(SecureEndpointsConfiguration.Builder parent)

Method Summary

Modifier and Type	Method	Description
EndpointConfiguration	build()
SecureEndpointsConfiguration.Builder	buildEndpoint()	Call this to add this EndpointConfiguration to the parent SecureEndpointsConfiguration and return to building the SecureEndpointsConfiguration, which can include more endpoints.
EndpointConfiguration.Builder	domain(String domain)
EndpointConfiguration.Builder	path(String path)
EndpointConfiguration.Builder	port(String port)
EndpointConfiguration.Builder	scheme(String scheme)
EndpointConfiguration.Builder	setDomain(String domain)
EndpointConfiguration.Builder	setPath(String path)
EndpointConfiguration.Builder	setPort(String port)
EndpointConfiguration.Builder	setScheme(String scheme)
EndpointConfiguration.Builder	setTag(String tag)
EndpointConfiguration.Builder	setUrlRewriteConfiguration(UrlRewriteConfiguration urlRewriteConfig)
EndpointConfiguration.Builder	tag(String tag)
EndpointConfiguration.Builder	urlRewriteConfiguration(UrlRewriteConfiguration urlRewriteConfig)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder(SecureEndpointsConfiguration.Builder parent)

Method Detail

tag

public EndpointConfiguration.Builder tag(String tag)

setTag

public EndpointConfiguration.Builder setTag(String tag)

scheme

public EndpointConfiguration.Builder scheme(String scheme)

setScheme

public EndpointConfiguration.Builder setScheme(String scheme)

domain

public EndpointConfiguration.Builder domain(String domain)

setDomain

public EndpointConfiguration.Builder setDomain(String domain)

port

public EndpointConfiguration.Builder port(String port)

setPort

public EndpointConfiguration.Builder setPort(String port)

path

public EndpointConfiguration.Builder path(String path)

setPath

public EndpointConfiguration.Builder setPath(String path)

urlRewriteConfiguration

public EndpointConfiguration.Builder urlRewriteConfiguration(UrlRewriteConfiguration urlRewriteConfig)

setUrlRewriteConfiguration

public EndpointConfiguration.Builder setUrlRewriteConfiguration(UrlRewriteConfiguration urlRewriteConfig)

build

public EndpointConfiguration build()

buildEndpoint

public SecureEndpointsConfiguration.Builder buildEndpoint()

Call this to add this EndpointConfiguration to the parent SecureEndpointsConfiguration and return to building the SecureEndpointsConfiguration, which can include more endpoints.

Returns:

The parent SecureEndpointsConfiguration's builder, after adding this endpoint to the parent

See Also:

SecureEndpointsConfiguration.Builder.addEndpoint()