Package de.stklcode.jvault.connector.model.response

Class SecretResponse

java.lang.Object

de.stklcode.jvault.connector.model.response.VaultDataResponse

de.stklcode.jvault.connector.model.response.SecretResponse

All Implemented Interfaces:

VaultResponse

Direct Known Subclasses:

CredentialsResponse

public class SecretResponse
extends VaultDataResponse

Vault response for secret request.

Since:

0.1

Author:

Stefan Kalscheuer

Constructor Summary

Constructors

Constructor	Description
SecretResponse()

Method Summary

Modifier and Type	Method	Description
Object	get(String key)	Get a single value for given key.
<T> T	get(String key, Class<T> type)	Get response parsed as JSON.
Map<String,Object>	getData()	Get complete data object.
VersionMetadata	getMetadata()	Get secret metadata.
String	getValue()	Deprecated. Deprecated artifact, will be removed at latest at v1.0.0
<T> T	getValue(Class<T> type)	Deprecated. Deprecated artifact, will be removed at latest at v1.0.0
void	setData(Map<String,Object> data)	Set data.

Methods inherited from class de.stklcode.jvault.connector.model.response.VaultDataResponse

getLeaseDuration, getLeaseId, getWarnings, isRenewable

Methods inherited from class java.lang.Object

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

Constructor Detail

SecretResponse

public SecretResponse()

Method Detail

setData

public final void setData(Map<String,Object> data)
                   throws InvalidResponseException

Description copied from class: VaultDataResponse

Set data. To be implemented in the specific subclasses, as data can be of arbitrary structure.

Specified by:

setData in class VaultDataResponse

Parameters:

data - Raw response data

Throws:

InvalidResponseException - on parsing errors

getData

public final Map<String,Object> getData()

Get complete data object.

Returns:

data map

Since:

0.4.0

getMetadata

public final VersionMetadata getMetadata()

Get secret metadata. This is only available for KV v2 secrets.

Returns:

Metadata of the secret.

Since:

0.8

get

public final Object get(String key)

Get a single value for given key.

Parameters:

key - the key

Returns:

the value or null if absent

Since:

0.4.0

getValue

@Deprecated
public final String getValue()

Deprecated.

Deprecated artifact, will be removed at latest at v1.0.0

Get data element for key "value". Method for backwards compatibility in case of simple secrets.

Returns:

the value

getValue

@Deprecated
public final <T> T getValue(Class<T> type)
                     throws InvalidResponseException

Deprecated.

Deprecated artifact, will be removed at latest at v1.0.0

Get response parsed as JSON.

Type Parameters:

T - Class to parse response

Parameters:

type - Class to parse response

Returns:

Parsed object

Throws:

InvalidResponseException - on parsing error

Since:

0.3

get

public final <T> T get(String key,
                       Class<T> type)
                throws InvalidResponseException

Get response parsed as JSON.

Type Parameters:

T - Class to parse response

Parameters:

key - the key

type - Class to parse response

Returns:

Parsed object or null if absent

Throws:

InvalidResponseException - on parsing error

Since:

0.4.0