com.cyberark.conjur.api.clients

Class ResourceClient

java.lang.Object

com.cyberark.conjur.api.clients.ResourceClient

All Implemented Interfaces:

ResourceProvider, ResourcesProvider

public class ResourceClient
extends Object
implements ResourceProvider, ResourcesProvider

Conjur service client.

Constructor Summary

Constructors

Constructor and Description
ResourceClient(Credentials credentials, Endpoints endpoints)
ResourceClient(Credentials credentials, Endpoints endpoints, SSLContext sslContext)
ResourceClient(Token token, Endpoints endpoints)
ResourceClient(Token token, Endpoints endpoints, SSLContext sslContext)

Method Summary

Modifier and Type	Method and Description
void	addSecret(String variableId, String secret) Creates a secret value within the specified variable
int	countResources(ResourceQuery query) Count resources using the provided query parameters.
List<ConjurResource>	listResources(ResourceQuery query) List resources using the provided query parameters.
Map<String,String>	retrieveBatchSecrets(String... variableIds) Fetch multiple secret values in one invocation using the batch retrieval API.
String	retrieveSecret(String variableId) Fetch the value of a secret in the specified variable

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceClient

public ResourceClient(Credentials credentials,
                      Endpoints endpoints)

ResourceClient

public ResourceClient(Credentials credentials,
                      Endpoints endpoints,
                      SSLContext sslContext)

ResourceClient

public ResourceClient(Token token,
                      Endpoints endpoints)

ResourceClient

public ResourceClient(Token token,
                      Endpoints endpoints,
                      SSLContext sslContext)

Method Detail

retrieveSecret

public String retrieveSecret(String variableId)

Description copied from interface: ResourceProvider

Fetch the value of a secret in the specified variable

Specified by:

retrieveSecret in interface ResourceProvider

Parameters:

variableId - - id of the variable

Returns:

The value of a secret from the specified variable

addSecret

public void addSecret(String variableId,
                      String secret)

Description copied from interface: ResourceProvider

Creates a secret value within the specified variable

Specified by:

addSecret in interface ResourceProvider

Parameters:

variableId - - id of the variable

secret - - Secret value within the specified variable

retrieveBatchSecrets

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

Fetch multiple secret values in one invocation using the batch retrieval API.

Constructs fully-qualified variable IDs ({account}:variable:{id}) and sends them as a comma-delimited list in the variable_ids query parameter.

Specified by:

retrieveBatchSecrets in interface ResourceProvider

Parameters:

variableIds - the variable IDs to retrieve (without account/kind prefix)

Returns:

a map of variable ID (as passed by caller) to secret value

See Also:

Batch Secret Retrieval

listResources

public List<ConjurResource> listResources(ResourceQuery query)

List resources using the provided query parameters.

Specified by:

listResources in interface ResourcesProvider

Parameters:

query - resource query parameters (nullable for no filters)

Returns:

resources matching the query

Throws:

jakarta.ws.rs.WebApplicationException - if the server returns an error response

See Also:

List Resources

countResources

public int countResources(ResourceQuery query)

Count resources using the provided query parameters.

Specified by:

countResources in interface ResourcesProvider

Parameters:

query - resource query parameters (nullable for no filters)

Returns:

the number of matching resources

Throws:

jakarta.ws.rs.WebApplicationException - if the server returns an error response

See Also:

List Resources