UriSpec (Curator Service Discovery 4.0.1 API)

java.lang.Object
- org.apache.curator.x.discovery.UriSpec

All Implemented Interfaces:

java.lang.Iterable<UriSpec.Part>
```
public class UriSpec
extends java.lang.Object
implements java.lang.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

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 java.lang.String`	`FIELD_ADDRESS`	If a `ServiceInstance` is passed when building, the replacement is `ServiceInstance.getAddress()`
`static java.lang.String`	`FIELD_CLOSE_BRACE`	Always replaced with '}' - i.e.
`static java.lang.String`	`FIELD_ID`	If a `ServiceInstance` is passed when building, the replacement is `ServiceInstance.getId()`
`static java.lang.String`	`FIELD_NAME`	If a `ServiceInstance` is passed when building, the replacement is `ServiceInstance.getName()`
`static java.lang.String`	`FIELD_OPEN_BRACE`	Always replaced with '{' - i.e.
`static java.lang.String`	`FIELD_PORT`	If a `ServiceInstance` is passed when building, the replacement is `ServiceInstance.getPort()`
`static java.lang.String`	`FIELD_REGISTRATION_TIME_UTC`	If a `ServiceInstance` is passed when building, the replacement is `ServiceInstance.getRegistrationTimeUTC()`
`static java.lang.String`	`FIELD_SCHEME`	This defaults to "http".
`static java.lang.String`	`FIELD_SERVICE_TYPE`	If a `ServiceInstance` is passed when building, the replacement is `ServiceInstance.getServiceType()`
`static java.lang.String`	`FIELD_SSL_PORT`	If a `ServiceInstance` is passed when building, the replacement is `ServiceInstance.getSslPort()`

Constructor Summary

Constructors
Constructor Description

UriSpec()

UriSpec(java.lang.String rawSpec)

Constructors
Constructor	Description
`UriSpec()`
`UriSpec(java.lang.String rawSpec)`

Method Summary

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FIELD_SCHEME
```
public static final java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String FIELD_CLOSE_BRACE
```
    Always replaced with '}' - i.e. this is how to insert a literal '}'
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UriSpec
```
public UriSpec()
```
  - UriSpec
```
public UriSpec(java.lang.String rawSpec)
```
    Parameters:
    
    rawSpec - the spec to parse
- Method Detail
  - build
```
public java.lang.String build()
```
    Build into a UriSpec string
    
    Returns:
    
    UriSpec string
  - build
```
public java.lang.String build(ServiceInstance<?> serviceInstance)
```
    Build into a UriSpec string
    
    Parameters:
    
    serviceInstance - instance to use for pre-defined replacement fields
    
    Returns:
    
    UriSpec string
  - build
```
public java.lang.String build(java.util.Map<java.lang.String,java.lang.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 java.lang.String build(ServiceInstance<?> serviceInstance,
                              java.util.Map<java.lang.String,java.lang.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 java.util.Iterator<UriSpec.Part> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<UriSpec.Part>
  - getParts
```
public java.util.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(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class UriSpec

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from interface java.lang.Iterable

Methods inherited from class java.lang.Object

Field Detail

FIELD_SCHEME

FIELD_NAME

FIELD_ID

FIELD_ADDRESS

FIELD_PORT

FIELD_SSL_PORT

FIELD_REGISTRATION_TIME_UTC

FIELD_SERVICE_TYPE

FIELD_OPEN_BRACE

FIELD_CLOSE_BRACE

Constructor Detail

UriSpec

UriSpec

Method Detail

build

build

build

build

iterator

getParts

add

remove

equals

hashCode