org.springframework.vault.client

Class VaultEndpoint

java.lang.Object

org.springframework.vault.client.VaultEndpoint

All Implemented Interfaces:

Serializable

public class VaultEndpoint
extends Object
implements Serializable

Value object that defines Vault connection coordinates.

A VaultEndpoint defines the hostname, TCP port, the protocol scheme (HTTP or HTTPS), and the context path prefix. The path defaults to API_VERSION.

Author:

Mark Paluch

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_VERSION

Constructor Summary

Constructors

Constructor and Description
VaultEndpoint()

Method Summary

Modifier and Type	Method and Description
static VaultEndpoint	create(String host, int port) Create a secure VaultEndpoint given a host and port using https.
URI	createUri(String path) Build the Vault URI based on the given path.
String	createUriString(String path) Build the Vault URI string based on the given path.
static VaultEndpoint	from(URI uri) Create a VaultEndpoint given a URI.
String	getHost()
String	getPath()
int	getPort()
String	getScheme()
void	setHost(String host) Sets the hostname.
void	setPath(String path)
void	setPort(int port)
void	setScheme(String scheme)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

API_VERSION

public static final String API_VERSION

See Also:

Constant Field Values

Constructor Detail

VaultEndpoint

public VaultEndpoint()

Method Detail

create

public static VaultEndpoint create(String host,
                                   int port)

Create a secure VaultEndpoint given a host and port using https.

Parameters:

host - must not be empty or null.

port - must be a valid port in the range of 1-65535

Returns:

a new VaultEndpoint.

from

public static VaultEndpoint from(URI uri)

Create a VaultEndpoint given a URI.

Parameters:

uri - must contain hostname, port and scheme, must not be empty or null.

Returns:

a new VaultEndpoint.

getHost

public String getHost()

Returns:

the hostname.

setHost

public void setHost(String host)

Sets the hostname.

Parameters:

host - must not be empty or null.

getPort

public int getPort()

Returns:

the port.

setPort

public void setPort(int port)

Parameters:

port - must be a valid port in the range of 1-65535

getScheme

public String getScheme()

Returns:

the protocol scheme.

setScheme

public void setScheme(String scheme)

Parameters:

scheme - must be http or https.

getPath

public String getPath()

Returns:

the context path prefix.

Since:

2.1

setPath

public void setPath(String path)

Parameters:

path - context path prefix. Must not be null or empty and must not start with a leading slash.

Since:

2.1

createUri

public URI createUri(String path)

Build the Vault URI based on the given path.

Parameters:

path - must not be empty or null.

Returns:

constructed URI.

createUriString

public String createUriString(String path)

Build the Vault URI string based on the given path.

Parameters:

path - must not be empty or null.

Returns:

constructed URI String.

toString

public String toString()

Overrides:

toString in class Object