org.apache.ambari.server.controller.internal

Class CredentialResourceProvider

java.lang.Object

org.apache.ambari.server.controller.internal.BaseProvider

org.apache.ambari.server.controller.internal.AbstractResourceProvider

org.apache.ambari.server.controller.internal.AbstractAuthorizedResourceProvider

org.apache.ambari.server.controller.internal.AbstractControllerResourceProvider

org.apache.ambari.server.controller.internal.CredentialResourceProvider

All Implemented Interfaces:

ObservableResourceProvider, ResourceProvider

public class CredentialResourceProvider
extends AbstractControllerResourceProvider

A write-only resource provider for securely stored credentials

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.ambari.server.controller.internal.AbstractResourceProvider

AbstractResourceProvider.Command<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREDENTIAL_ALIAS_PROPERTY_ID
static String	CREDENTIAL_CLUSTER_NAME_PROPERTY_ID
static String	CREDENTIAL_KEY_PROPERTY_ID
static String	CREDENTIAL_PRINCIPAL_PROPERTY_ID
static String	CREDENTIAL_TYPE_PROPERTY_ID

Fields inherited from class org.apache.ambari.server.controller.internal.AbstractResourceProvider

keyPropertyIds, PROPERTIES_ATTRIBUTES_REGEX

Constructor Summary

Constructors

Constructor and Description
CredentialResourceProvider(AmbariManagementController managementController) Create a new resource provider.

Method Summary

Modifier and Type	Method and Description
protected RequestStatus	createResourcesAuthorized(Request request) Create the resources defined by the properties in the given request object if authorization was granted to the authenticated user.
protected RequestStatus	deleteResourcesAuthorized(Request request, Predicate predicate) Delete the resources selected by the given predicate if the authenticated user is authorized to do so.
protected Set<String>	getPKPropertyIds() Get the set of property ids that uniquely identify the resources of this provider.
protected Set<Resource>	getResourcesAuthorized(Request request, Predicate predicate) Get a set of resources based on the given request and predicate information if the authenticated user is authorized to do so.
protected RequestStatus	updateResourcesAuthorized(Request request, Predicate predicate) Update the resources selected by the given predicate with the properties from the given request object if the authenticated user is authorized to do so.

Methods inherited from class org.apache.ambari.server.controller.internal.AbstractControllerResourceProvider

getClusterId, getClusterResourceId, getClusterResourceId, getManagementController, getResourceProvider, getResourceProvider, init

Methods inherited from class org.apache.ambari.server.controller.internal.AbstractAuthorizedResourceProvider

createResources, deleteResources, getRequiredCreateAuthorizations, getRequiredDeleteAuthorizations, getRequiredGetAuthorizations, getRequiredUpdateAuthorizations, getResourceId, getResources, getResourceType, isAuthorizedToCreateResources, isAuthorizedToDeleteResources, isAuthorizedToGetResources, isAuthorizedToUpdateResources, setRequiredCreateAuthorizations, setRequiredDeleteAuthorizations, setRequiredGetAuthorizations, setRequiredUpdateAuthorizations, updateResources

Methods inherited from class org.apache.ambari.server.controller.internal.AbstractResourceProvider

addObserver, createResources, getConfigurationRequests, getKeyPropertyIds, getPropertyMaps, getPropertyMaps, getQueryParameterValue, getRequestStatus, getRequestStatus, getRequestStatus, getResources, modifyResources, notifyCreate, notifyDelete, notifyUpdate, parseProperties, updateObservers

Methods inherited from class org.apache.ambari.server.controller.internal.BaseProvider

checkCategory, checkConfigPropertyIds, checkPropertyIds, containsArguments, getCategoryIds, getPropertyIds, getRegexEntry, getRegexGroups, getRequestPropertyIds, isPatternKey, isPropertyCategoryRequested, isPropertyEntryRequested, isPropertyRequested, setResourceProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ambari.server.controller.spi.ResourceProvider

checkPropertyIds

Field Detail

CREDENTIAL_CLUSTER_NAME_PROPERTY_ID

public static final String CREDENTIAL_CLUSTER_NAME_PROPERTY_ID

CREDENTIAL_ALIAS_PROPERTY_ID

public static final String CREDENTIAL_ALIAS_PROPERTY_ID

CREDENTIAL_PRINCIPAL_PROPERTY_ID

public static final String CREDENTIAL_PRINCIPAL_PROPERTY_ID

CREDENTIAL_KEY_PROPERTY_ID

public static final String CREDENTIAL_KEY_PROPERTY_ID

CREDENTIAL_TYPE_PROPERTY_ID

public static final String CREDENTIAL_TYPE_PROPERTY_ID

Constructor Detail

CredentialResourceProvider

public CredentialResourceProvider(AmbariManagementController managementController)

Create a new resource provider.

Method Detail

createResourcesAuthorized

protected RequestStatus createResourcesAuthorized(Request request)
                                           throws SystemException,
                                                  UnsupportedPropertyException,
                                                  ResourceAlreadyExistsException,
                                                  NoSuchParentResourceException

Description copied from class: AbstractAuthorizedResourceProvider

Create the resources defined by the properties in the given request object if authorization was granted to the authenticated user.

This method must be overwritten if AbstractAuthorizedResourceProvider.createResources(Request) is not overwritten.

Overrides:

createResourcesAuthorized in class AbstractAuthorizedResourceProvider

Parameters:

request - the request object which defines the set of properties for the resources to be created

Returns:

the request status

Throws:

SystemException - an internal system exception occurred

AuthorizationException - if the authenticated user is not authorized to perform this operation

UnsupportedPropertyException - the request contains unsupported property ids

ResourceAlreadyExistsException - attempted to create a resource which already exists

NoSuchParentResourceException - a parent resource of the resource to create doesn't exist

See Also:

AbstractAuthorizedResourceProvider.createResources(Request)

getResourcesAuthorized

protected Set<Resource> getResourcesAuthorized(Request request,
                                               Predicate predicate)
                                        throws SystemException,
                                               UnsupportedPropertyException,
                                               NoSuchResourceException,
                                               NoSuchParentResourceException

Description copied from class: AbstractAuthorizedResourceProvider

Get a set of resources based on the given request and predicate information if the authenticated user is authorized to do so.

This method must be overwritten if AbstractAuthorizedResourceProvider.getResources(Request, Predicate) is not overwritten.

Overrides:

getResourcesAuthorized in class AbstractAuthorizedResourceProvider

Parameters:

request - the request object which defines the desired set of properties

predicate - the predicate object which can be used to filter which resources are returned

Returns:

a set of resources based on the given request and predicate information

Throws:

SystemException - an internal system exception occurred

AuthorizationException - if the authenticated user is not authorized to perform this operation

UnsupportedPropertyException - the request contains unsupported property ids

NoSuchResourceException - the requested resource instance doesn't exist

NoSuchParentResourceException - a parent resource of the requested resource doesn't exist

See Also:

AbstractAuthorizedResourceProvider.getResources(Request, Predicate)

updateResourcesAuthorized

protected RequestStatus updateResourcesAuthorized(Request request,
                                                  Predicate predicate)
                                           throws SystemException,
                                                  UnsupportedPropertyException,
                                                  NoSuchResourceException,
                                                  NoSuchParentResourceException

Description copied from class: AbstractAuthorizedResourceProvider

Update the resources selected by the given predicate with the properties from the given request object if the authenticated user is authorized to do so.

This method must be overwritten if AbstractAuthorizedResourceProvider.updateResources(Request, Predicate) is not overwritten.

Overrides:

updateResourcesAuthorized in class AbstractAuthorizedResourceProvider

Parameters:

request - the request object which defines the set of properties for the resources to be updated

predicate - the predicate object which can be used to filter which resources are updated

Returns:

the request status

Throws:

SystemException - an internal system exception occurred

AuthorizationException - if the authenticated user is not authorized to perform this operation

UnsupportedPropertyException - the request contains unsupported property ids

NoSuchResourceException - the resource instance to be updated doesn't exist

NoSuchParentResourceException - a parent resource of the resource doesn't exist

See Also:

AbstractAuthorizedResourceProvider.updateResources(Request, Predicate)

deleteResourcesAuthorized

protected RequestStatus deleteResourcesAuthorized(Request request,
                                                  Predicate predicate)
                                           throws SystemException,
                                                  UnsupportedPropertyException,
                                                  NoSuchResourceException,
                                                  NoSuchParentResourceException

Description copied from class: AbstractAuthorizedResourceProvider

Delete the resources selected by the given predicate if the authenticated user is authorized to do so.

This method must be overwritten if ResourceProvider.deleteResources(Request, Predicate) is not overwritten.

Overrides:

deleteResourcesAuthorized in class AbstractAuthorizedResourceProvider

predicate - the predicate object which can be used to filter which resources are deleted

Returns:

the request status

Throws:

SystemException - an internal system exception occurred

AuthorizationException - if the authenticated user is not authorized to perform this operation

UnsupportedPropertyException - the request contains unsupported property ids

NoSuchResourceException - the resource instance to be deleted doesn't exist

NoSuchParentResourceException - a parent resource of the resource doesn't exist

See Also:

ResourceProvider.deleteResources(Request, Predicate)

getPKPropertyIds

protected Set<String> getPKPropertyIds()

Description copied from class: AbstractResourceProvider

Get the set of property ids that uniquely identify the resources of this provider.

Specified by:

getPKPropertyIds in class AbstractResourceProvider

Returns:

the set of primary key properties