Package org.apache.curator.x.discovery

Class UriSpec

java.lang.Object

org.apache.curator.x.discovery.UriSpec

All Implemented Interfaces:

Iterable<UriSpec.Part>

public class UriSpec
extends Object
implements Iterable<UriSpec.Part>

An abstraction for specifying a URI for an instance allowing for variable substitutions.

A Uri spec is a string with optional replacement fields. A replacement field begins with an open brace and ends with a close brace. The value between the braces is the name of the field. e.g. "{scheme}://foo.com:{port}" has two replacement fields named "scheme" and "port". Several pre-defined fields are listed as constants in this class (e.g. FIELD_SCHEME).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UriSpec.Part	Represents one token in the Uri spec

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FIELD_ADDRESS	If a ServiceInstance is passed when building, the replacement is ServiceInstance.getAddress()
static final String	FIELD_CLOSE_BRACE	Always replaced with '}' - i.e.
static final String	FIELD_ID	If a ServiceInstance is passed when building, the replacement is ServiceInstance.getId()
static final String	FIELD_NAME	If a ServiceInstance is passed when building, the replacement is ServiceInstance.getName()
static final String	FIELD_OPEN_BRACE	Always replaced with '{' - i.e.
static final String	FIELD_PORT	If a ServiceInstance is passed when building, the replacement is ServiceInstance.getPort()
static final String	FIELD_REGISTRATION_TIME_UTC	If a ServiceInstance is passed when building, the replacement is ServiceInstance.getRegistrationTimeUTC()
static final String	FIELD_SCHEME	This defaults to "http".
static final String	FIELD_SERVICE_TYPE	If a ServiceInstance is passed when building, the replacement is ServiceInstance.getServiceType()
static final String	FIELD_SSL_PORT	If a ServiceInstance is passed when building, the replacement is ServiceInstance.getSslPort()

Constructor Summary

Constructors

Constructor	Description
UriSpec()
UriSpec(String rawSpec)

Method Summary

Modifier and Type	Method	Description
void	add(UriSpec.Part part)	Add a part to the end of the list
String	build()	Build into a UriSpec string
String	build(Map<String,Object> variables)	Build into a UriSpec string
String	build(ServiceInstance<?> serviceInstance)	Build into a UriSpec string
String	build(ServiceInstance<?> serviceInstance, Map<String,Object> variables)	Build into a UriSpec string
boolean	equals(Object o)
List<UriSpec.Part>	getParts()
int	hashCode()
Iterator<UriSpec.Part>	iterator()
void	remove(UriSpec.Part part)	Remove the given part

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

FIELD_SCHEME

public static final String FIELD_SCHEME

This defaults to "http". If a ServiceInstance is passed when building and an sslPort is specified in the instance, the replacement is "https".

See Also:

• Constant Field Values

FIELD_NAME

public static final String FIELD_NAME

If a ServiceInstance is passed when building, the replacement is ServiceInstance.getName()

See Also:

• Constant Field Values

FIELD_ID

public static final String FIELD_ID

If a ServiceInstance is passed when building, the replacement is ServiceInstance.getId()

See Also:

• Constant Field Values

FIELD_ADDRESS

public static final String FIELD_ADDRESS

If a ServiceInstance is passed when building, the replacement is ServiceInstance.getAddress()

See Also:

• Constant Field Values

FIELD_PORT

public static final String FIELD_PORT

If a ServiceInstance is passed when building, the replacement is ServiceInstance.getPort()

See Also:

• Constant Field Values

FIELD_SSL_PORT

public static final String FIELD_SSL_PORT

If a ServiceInstance is passed when building, the replacement is ServiceInstance.getSslPort()

See Also:

• Constant Field Values

FIELD_REGISTRATION_TIME_UTC

public static final String FIELD_REGISTRATION_TIME_UTC

If a ServiceInstance is passed when building, the replacement is ServiceInstance.getRegistrationTimeUTC()

See Also:

• Constant Field Values

FIELD_SERVICE_TYPE

public static final String FIELD_SERVICE_TYPE

If a ServiceInstance is passed when building, the replacement is ServiceInstance.getServiceType()

See Also:

• Constant Field Values

FIELD_OPEN_BRACE

public static final String FIELD_OPEN_BRACE

Always replaced with '{' - i.e. this is how to insert a literal '{'

See Also:

• Constant Field Values

FIELD_CLOSE_BRACE

public static final String FIELD_CLOSE_BRACE

Always replaced with '}' - i.e. this is how to insert a literal '}'

See Also:

• Constant Field Values

Constructor Details

UriSpec

public UriSpec()

UriSpec

public UriSpec(String rawSpec)

Parameters:

rawSpec - the spec to parse

Method Details

build

public String build()

Build into a UriSpec string

Returns:

UriSpec string

build

public String build(ServiceInstance<?> serviceInstance)

Build into a UriSpec string

Parameters:

serviceInstance - instance to use for pre-defined replacement fields

Returns:

UriSpec string

build

public String build(Map<String,Object> variables)

Build into a UriSpec string

Parameters:

variables - a mapping of field replacement names to values. Note: any fields listed in this map override pre-defined fields

Returns:

UriSpec string

build

public String build(ServiceInstance<?> serviceInstance,
 Map<String,Object> variables)

Build into a UriSpec string

Parameters:

serviceInstance - instance to use for pre-defined replacement fields

variables - a mapping of field replacement names to values. Note: any fields listed in this map override pre-defined fields

Returns:

UriSpec string

iterator

public Iterator<UriSpec.Part> iterator()

Specified by:

iterator in interface Iterable<UriSpec.Part>

getParts

public List<UriSpec.Part> getParts()

Returns:

the parts

add

public void add(UriSpec.Part part)

Add a part to the end of the list

Parameters:

part - part to add

remove

public void remove(UriSpec.Part part)

Remove the given part

Parameters:

part - the part

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object