io.cdap.cdap.api.security.store

Interface SecureStoreManager

All Known Subinterfaces:

Admin

@Beta
public interface SecureStoreManager

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

Method Summary

Modifier and Type	Method and Description
void	delete(String namespace, String name) Deletes the element with the given name.
void	put(String namespace, String name, String data, String description, Map<String,String> properties) Stores an element in the secure store.

Method Detail

put

void put(String namespace,
         String name,
         String data,
         @Nullable
         String description,
         Map<String,String> properties)
  throws Exception

Stores an element in the secure store.

Parameters:

namespace - The namespace that this key belongs to

name - This is the identifier that will be used to retrieve this element

data - The sensitive data that has to be securely stored

description - User provided description of the entry

properties - associated with this element

Throws:

IOException - If the attempt to store the element failed

Exception - If the specified namespace does not exist

delete

void delete(String namespace,
            String name)
     throws Exception

Deletes the element with the given name.

Parameters:

namespace - The namespace that this key belongs to

name - of the element to delete

Throws:

IOException - If the store is not initialized or if the key could not be removed

Exception - If the specified namespace or name does not exist