com.cyberark.conjur.api

Class Variables

java.lang.Object

com.cyberark.conjur.api.Variables

public class Variables
extends Object

Facade for Conjur variable secret operations.

This class provides APIs to retrieve and set individual variable secrets, as well as fetch multiple secrets in a single batch request. Instances are typically obtained via Conjur.variables().

Constructor Summary

Constructors

Constructor and Description
Variables(Credentials credentials) Deprecated. Prefer Conjur.variables() so variables and resources can share a single underlying client.
Variables(Credentials credentials, SSLContext sslContext) Deprecated. Prefer Conjur.variables() so variables and resources can share a single underlying client.
Variables(Token token) Deprecated. Prefer Conjur.variables() so variables and resources can share a single underlying client.
Variables(Token token, SSLContext sslContext) Deprecated. Prefer Conjur.variables() so variables and resources can share a single underlying client.

Method Summary

Modifier and Type	Method and Description
void	addSecret(String variableId, String secret) Set the secret value for a Conjur variable.
Map<String,String>	retrieveBatchSecrets(String... variableIds) Fetch multiple secret values in one invocation.
String	retrieveSecret(String variableId) Retrieve the secret value for a Conjur variable.

Methods inherited from class java.lang.Object

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

Constructor Detail

Variables

@Deprecated
public Variables(Credentials credentials)

Deprecated. Prefer Conjur.variables() so variables and resources can share a single underlying client.

Create a Variables instance using explicit credentials.

Parameters:

credentials - credentials used to authenticate requests

Variables

@Deprecated
public Variables(Credentials credentials,
                             SSLContext sslContext)

Deprecated. Prefer Conjur.variables() so variables and resources can share a single underlying client.

Create a Variables instance using explicit credentials and SSL context.

Parameters:

credentials - credentials used to authenticate requests

sslContext - the SSLContext to use for HTTPS connections

Variables

@Deprecated
public Variables(Token token)

Deprecated. Prefer Conjur.variables() so variables and resources can share a single underlying client.

Create a Variables instance using a pre-existing Conjur token.

Parameters:

token - authorization token used for requests

Variables

@Deprecated
public Variables(Token token,
                             SSLContext sslContext)

Deprecated. Prefer Conjur.variables() so variables and resources can share a single underlying client.

Create a Variables instance using a pre-existing Conjur token and SSL context.

Parameters:

token - authorization token used for requests

sslContext - the SSLContext to use for HTTPS connections

Method Detail

retrieveSecret

public String retrieveSecret(String variableId)

Retrieve the secret value for a Conjur variable.

Parameters:

variableId - variable identifier (without account/kind prefix)

Returns:

secret value stored in the specified variable

addSecret

public void addSecret(String variableId,
                      String secret)

Set the secret value for a Conjur variable.

Parameters:

variableId - variable identifier (without account/kind prefix)

secret - secret value to store

retrieveBatchSecrets

public Map<String,String> retrieveBatchSecrets(String... variableIds)

Fetch multiple secret values in one invocation.

Parameters:

variableIds - the variable IDs to retrieve

Returns:

a map of variable ID to secret value