org.apache.ambari.server.controller.internal

Class SettingResourceProvider

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

All Implemented Interfaces:

ObservableResourceProvider, ResourceProvider

public class SettingResourceProvider
extends AbstractAuthorizedResourceProvider

This class deals with managing CRUD operation on SettingEntity.

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	ALL_PROPERTIES
static String	CONTENT
protected static String	ID
static String	NAME
static String	RESPONSE_KEY
protected static String	SETTING
static String	SETTING_CONTENT_PROPERTY_ID
static String	SETTING_NAME_PROPERTY_ID
static String	SETTING_SETTING_TYPE_PROPERTY_ID
static String	SETTING_TYPE
static String	SETTING_UPDATE_TIMESTAMP_PROPERTY_ID
static String	SETTING_UPDATED_BY_PROPERTY_ID
static String	UPDATE_TIMESTAMP
static String	UPDATED_BY

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

LOG, PROPERTIES_ATTRIBUTES_REGEX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SettingResourceProvider()

Method Summary

Modifier and Type	Method and Description
RequestStatus	createResourcesAuthorized(Request request) Create the resources defined by the properties in the given request object if authorization was granted to the authenticated user.
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.
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	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.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

RESPONSE_KEY

public static final String RESPONSE_KEY

See Also:

Constant Field Values

ID

protected static final String ID

See Also:

Constant Field Values

SETTING

protected static final String SETTING

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

SETTING_TYPE

public static final String SETTING_TYPE

See Also:

Constant Field Values

CONTENT

public static final String CONTENT

See Also:

Constant Field Values

UPDATED_BY

public static final String UPDATED_BY

See Also:

Constant Field Values

UPDATE_TIMESTAMP

public static final String UPDATE_TIMESTAMP

See Also:

Constant Field Values

SETTING_NAME_PROPERTY_ID

public static final String SETTING_NAME_PROPERTY_ID

See Also:

Constant Field Values

SETTING_SETTING_TYPE_PROPERTY_ID

public static final String SETTING_SETTING_TYPE_PROPERTY_ID

See Also:

Constant Field Values

SETTING_CONTENT_PROPERTY_ID

public static final String SETTING_CONTENT_PROPERTY_ID

See Also:

Constant Field Values

SETTING_UPDATED_BY_PROPERTY_ID

public static final String SETTING_UPDATED_BY_PROPERTY_ID

See Also:

Constant Field Values

SETTING_UPDATE_TIMESTAMP_PROPERTY_ID

public static final String SETTING_UPDATE_TIMESTAMP_PROPERTY_ID

See Also:

Constant Field Values

ALL_PROPERTIES

public static final String ALL_PROPERTIES

See Also:

Constant Field Values

Constructor Detail

SettingResourceProvider

protected SettingResourceProvider()

Method Detail

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

createResourcesAuthorized

public RequestStatus createResourcesAuthorized(Request request)
                                        throws NoSuchParentResourceException,
                                               ResourceAlreadyExistsException,
                                               SystemException

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:

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

ResourceAlreadyExistsException - attempted to create a resource which already exists

SystemException - an internal system exception occurred

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

See Also:

AbstractAuthorizedResourceProvider.createResources(Request)

getResourcesAuthorized

public Set<Resource> getResourcesAuthorized(Request request,
                                            Predicate predicate)
                                     throws NoSuchResourceException

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:

NoSuchResourceException - the requested resource instance doesn't exist

See Also:

AbstractAuthorizedResourceProvider.getResources(Request, Predicate)

updateResourcesAuthorized

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

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:

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

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

SystemException - an internal system exception occurred

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

See Also:

AbstractAuthorizedResourceProvider.updateResources(Request, Predicate)

deleteResourcesAuthorized

public RequestStatus deleteResourcesAuthorized(Request request,
                                               Predicate predicate)

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

See Also:

ResourceProvider.deleteResources(Request, Predicate)