co.cask.cdap.security.store

Class DefaultSecureStoreService

java.lang.Object

co.cask.cdap.security.store.DefaultSecureStoreService

All Implemented Interfaces:

co.cask.cdap.api.security.store.SecureStore, co.cask.cdap.api.security.store.SecureStoreManager

public class DefaultSecureStoreService
extends Object
implements co.cask.cdap.api.security.store.SecureStore, co.cask.cdap.api.security.store.SecureStoreManager

Default implementation of the service that manages access to the Secure Store,

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteSecureData(String namespace, String name) Deletes the key if the user has ADMIN privileges to the key.
co.cask.cdap.api.security.store.SecureStoreData	getSecureData(String namespace, String name) Checks if the user has access to read the secure key and returns the SecureStoreData associated with the key if they do.
Map<String,String>	listSecureData(String namespace) Lists all the secure keys in the given namespace that the user has access to.
void	putSecureData(String namespace, String name, String value, String description, Map<String,String> properties) Puts the user provided data in the secure store, if the user has write access to the namespace.

Methods inherited from class java.lang.Object

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

Method Detail

listSecureData

public final Map<String,String> listSecureData(String namespace)
                                        throws Exception

Lists all the secure keys in the given namespace that the user has access to. Returns an empty list if the user does not have access to the namespace or any of the keys in the namespace.

Specified by:

listSecureData in interface co.cask.cdap.api.security.store.SecureStore

Returns:

A map of key names accessible by the user and their descriptions.

Throws:

NamespaceNotFoundException - If the specified namespace does not exist.

IOException - If there was a problem reading from the store.

Exception

getSecureData

public final co.cask.cdap.api.security.store.SecureStoreData getSecureData(String namespace,
                                                            String name)
                                                                    throws Exception

Checks if the user has access to read the secure key and returns the SecureStoreData associated with the key if they do.

Specified by:

getSecureData in interface co.cask.cdap.api.security.store.SecureStore

Returns:

Data associated with the key if the user has read access.

Throws:

NamespaceNotFoundException - If the specified namespace does not exist.

NotFoundException - If the key is not found in the store.

IOException - If there was a problem reading from the store.

UnauthorizedException - If the user does not have READ permissions on the secure key.

Exception

putSecureData

public final void putSecureData(String namespace,
                 String name,
                 String value,
                 String description,
                 Map<String,String> properties)
                         throws Exception

Puts the user provided data in the secure store, if the user has write access to the namespace. Grants the user all access to the newly created entity.

Specified by:

putSecureData in interface co.cask.cdap.api.security.store.SecureStoreManager

Throws:

BadRequestException - If the request does not contain the value to be stored.

UnauthorizedException - If the user does not have write permissions on the namespace.

NamespaceNotFoundException - If the specified namespace does not exist.

AlreadyExistsException - If the key already exists in the namespace. Updating is not supported.

IOException - If there was a problem storing the key to underlying provider.

Exception

deleteSecureData

public final void deleteSecureData(String namespace,
                    String name)
                            throws Exception

Deletes the key if the user has ADMIN privileges to the key. Clears all the privileges associated with the key.

Specified by:

deleteSecureData in interface co.cask.cdap.api.security.store.SecureStoreManager

Throws:

UnauthorizedException - If the user does not have admin privileges required to delete the secure key.

NamespaceNotFoundException - If the specified namespace does not exist.

NotFoundException - If the key to be deleted is not found.

IOException - If there was a problem deleting it from the underlying provider.

Exception