io.cdap.cdap.api.security.store

Interface SecureStore

All Known Subinterfaces:

CustomActionContext, HttpServiceContext, MapReduceContext, MapReduceTaskContext<KEYOUT,VALUEOUT>, ServiceContext, SparkClientContext, WorkerContext, WorkflowContext

@Beta
public interface SecureStore

Provides read access to the secure store. For write access use SecureStoreManager.

Method Summary

Modifier and Type	Method and Description
SecureStoreData	get(String namespace, String name) Returns the secret and its metadata for the given namespace and name.
default byte[]	getData(String namespace, String name) Returns the secret data.
default SecureStoreMetadata	getMetadata(String namespace, String name) Returns the metadata for the secret.
List<SecureStoreMetadata>	list(String namespace) List of metadata stored in the secure store.

Method Detail

list

List<SecureStoreMetadata> list(String namespace)
                        throws Exception

List of metadata stored in the secure store.

Parameters:

namespace - The namespace that this key belongs to

Returns:

A list of SecureStoreMetadata objects representing the data stored in the store

Throws:

IOException - If there was a problem reading from the keystore

Exception - If the specified namespace does not exist

get

SecureStoreData get(String namespace,
                    String name)
             throws Exception

Returns the secret and its metadata for the given namespace and name. Use getData(String, String) if the metadata is not required.

Parameters:

namespace - The namespace that this key belongs to

name - Name of the data element

Returns:

An object representing the securely stored data associated with the name

Throws:

IOException - If there was a problem reading from the store

Exception - if the specified namespace or name does not exist

getMetadata

default SecureStoreMetadata getMetadata(String namespace,
                                        String name)
                                 throws Exception

Returns the metadata for the secret.

Parameters:

namespace - The namespace that this key belongs to

name - Name of the data element

Returns:

Metadata for the securely stored data associated with the name

Throws:

IOException - If there was a problem reading from the store

Exception - if the specified namespace or name does not exist

getData

default byte[] getData(String namespace,
                       String name)
                throws Exception

Returns the secret data.

Parameters:

namespace - The namespace that this key belongs to

name - Name of the data element

Returns:

The securely stored data associated with the name

Throws:

IOException - If there was a problem reading from the store

Exception - if the specified namespace or name does not exist