org.springframework.vault.core.lease.domain

Class RequestedSecret

java.lang.Object

org.springframework.vault.core.lease.domain.RequestedSecret

public class RequestedSecret
extends Object

Represents a requested secret from a specific Vault path associated with a lease RequestedSecret.Mode.

A RequestedSecret can be renewing or rotating.

Author:

Mark Paluch, Pierre-Jean Vardanega

See Also:

RequestedSecret.Mode, Lease.isRenewable()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RequestedSecret.Mode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static RequestedSecret	from(RequestedSecret.Mode mode, String path) Create a RequestedSecret given RequestedSecret.Mode at path.
RequestedSecret.Mode	getMode()
String	getPath()
int	hashCode()
static RequestedSecret	renewable(String path) Create a renewable RequestedSecret at path.
static RequestedSecret	rotating(String path) Create a rotating RequestedSecret at path.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

renewable

public static RequestedSecret renewable(String path)

Create a renewable RequestedSecret at path. A lease associated with this secret will be renewed if the lease is qualified for renewal. The lease is no longer valid after expiry.

Parameters:

path - must not be null or empty, must not start with a slash.

Returns:

the renewable RequestedSecret.

rotating

public static RequestedSecret rotating(String path)

Create a rotating RequestedSecret at path. A lease associated with this secret will be renewed if the lease is qualified for renewal. Once the lease expires, a new secret with a new lease is obtained.

Parameters:

path - must not be null or empty, must not start with a slash.

Returns:

the rotating RequestedSecret.

from

public static RequestedSecret from(RequestedSecret.Mode mode,
                                   String path)

Create a RequestedSecret given RequestedSecret.Mode at path.

Parameters:

mode - must not be null.

path - must not be null or empty, must not start with a slash.

Returns:

the rotating RequestedSecret.

See Also:

rotating(String), renewable(String)

getPath

public String getPath()

Returns:

the Vault path of the requested secret.

getMode

public RequestedSecret.Mode getMode()

Returns:

lease mode.

See Also:

RequestedSecret.Mode

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object