org.apache.ambari.server.controller.internal

Class ConfigurationResourceProvider

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.ConfigurationResourceProvider

All Implemented Interfaces:

ObservableResourceProvider, ResourceProvider

public class ConfigurationResourceProvider
extends AbstractControllerResourceProvider

Resource provider for configuration resources.

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	CLUSTER_NAME
static String	CLUSTER_NAME_PROPERTY_ID
static String	CONFIG
static String	PROPERTIES_ATTRIBUTES_PROPERTY_ID
static String	PROPERTIES_PROPERTY_ID
static String	STACK_ID
static String	STACK_ID_PROPERTY_ID
static String	TAG
static String	TAG_PROPERTY_ID
static String	TYPE
static String	TYPE_PROPERTY_ID
static String	VERSION
static String	VERSION_PROPERTY_ID

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

keyPropertyIds, LOG, PROPERTIES_ATTRIBUTES_REGEX

Method Summary

Modifier and Type	Method and Description
Set<String>	checkPropertyIds(Set<String> propertyIds) Check whether the set of given property ids is supported by this resource provider.
RequestStatus	createResources(Request request) Create the resources defined by the properties in the given request object.
RequestStatus	deleteResources(Request request, Predicate predicate) Throws an exception, as Configurations cannot be deleted.
protected Set<String>	getPKPropertyIds() Get the set of property ids that uniquely identify the resources of this provider.
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.
RequestStatus	updateResources(Request request, Predicate predicate) Throws an exception, as Configurations cannot be updated.

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

createResourcesAuthorized, deleteResourcesAuthorized, getRequiredCreateAuthorizations, getRequiredDeleteAuthorizations, getRequiredGetAuthorizations, getRequiredUpdateAuthorizations, getResourceId, getResources, getResourceType, isAuthorizedToCreateResources, isAuthorizedToDeleteResources, isAuthorizedToGetResources, isAuthorizedToUpdateResources, setRequiredCreateAuthorizations, setRequiredDeleteAuthorizations, setRequiredGetAuthorizations, setRequiredUpdateAuthorizations, updateResourcesAuthorized

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, 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

Field Detail

CONFIG

public static final String CONFIG

See Also:

Constant Field Values

CLUSTER_NAME_PROPERTY_ID

public static final String CLUSTER_NAME_PROPERTY_ID

See Also:

Constant Field Values

STACK_ID_PROPERTY_ID

public static final String STACK_ID_PROPERTY_ID

See Also:

Constant Field Values

TYPE_PROPERTY_ID

public static final String TYPE_PROPERTY_ID

See Also:

Constant Field Values

TAG_PROPERTY_ID

public static final String TAG_PROPERTY_ID

See Also:

Constant Field Values

VERSION_PROPERTY_ID

public static final String VERSION_PROPERTY_ID

See Also:

Constant Field Values

PROPERTIES_PROPERTY_ID

public static final String PROPERTIES_PROPERTY_ID

See Also:

Constant Field Values

PROPERTIES_ATTRIBUTES_PROPERTY_ID

public static final String PROPERTIES_ATTRIBUTES_PROPERTY_ID

See Also:

Constant Field Values

CLUSTER_NAME

public static final String CLUSTER_NAME

See Also:

Constant Field Values

STACK_ID

public static final String STACK_ID

See Also:

Constant Field Values

TYPE

public static final String TYPE

TAG

public static final String TAG

VERSION

public static final String VERSION

Method Detail

createResources

public RequestStatus createResources(Request request)
                              throws SystemException,
                                     UnsupportedPropertyException,
                                     ResourceAlreadyExistsException,
                                     NoSuchParentResourceException

Description copied from class: AbstractAuthorizedResourceProvider

Create the resources defined by the properties in the given request object.

This implementation attempts to authorize the authenticated user before performing the requested operation. If authorization fails, an AuthorizationException will be thrown.

This method may be overwritten by implementing classes to avoid performing authorization checks to create resources.

Specified by:

createResources in interface ResourceProvider

Overrides:

createResources 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

getResourcesAuthorized

public 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)

updateResources

public RequestStatus updateResources(Request request,
                                     Predicate predicate)
                              throws SystemException,
                                     UnsupportedPropertyException,
                                     NoSuchResourceException,
                                     NoSuchParentResourceException

Throws an exception, as Configurations cannot be updated.

Specified by:

updateResources in interface ResourceProvider

Overrides:

updateResources 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

deleteResources

public RequestStatus deleteResources(Request request,
                                     Predicate predicate)
                              throws SystemException,
                                     UnsupportedPropertyException,
                                     NoSuchResourceException,
                                     NoSuchParentResourceException

Throws an exception, as Configurations cannot be deleted.

Specified by:

deleteResources in interface ResourceProvider

Overrides:

deleteResources 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 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

checkPropertyIds

public Set<String> checkPropertyIds(Set<String> propertyIds)

Description copied from interface: ResourceProvider

Check whether the set of given property ids is supported by this resource provider.

Specified by:

checkPropertyIds in interface ResourceProvider

Overrides:

checkPropertyIds in class BaseProvider

Returns:

a subset of the given property id set containing any property ids not supported by this resource provider. An empty return set indicates that all of the given property ids are supported.

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