org.apache.ambari.server.controller.internal

Class ConfigGroupResourceProvider

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

All Implemented Interfaces:

ObservableResourceProvider, ResourcePredicateEvaluator, ResourceProvider

public class ConfigGroupResourceProvider
extends AbstractControllerResourceProvider
implements ResourcePredicateEvaluator

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_GROUP
static String	DESCRIPTION
static String	DESCRIPTION_PROPERTY_ID
static String	DESIRED_CONFIGS
static String	DESIRED_CONFIGS_PROPERTY_ID
static String	GROUP_NAME
static String	GROUP_NAME_PROPERTY_ID
static String	HOST_NAME
static String	HOST_NAME_PROPERTY_ID
static String	HOSTS
static String	HOSTS_HOST_NAME
static String	HOSTS_HOSTNAME_PROPERTY_ID
static String	HOSTS_PROPERTY_ID
static String	ID
static String	ID_PROPERTY_ID
static String	SERVICE_CONFIG_VERSION_NOTE
static String	SERVICE_CONFIG_VERSION_NOTE_PROPERTY_ID
static String	SERVICE_NAME
static String	SERVICE_NAME_PROPERTY_ID
static String	TAG
static String	TAG_PROPERTY_ID
static String	VERSION_TAGS
static String	VERSION_TAGS_PROPERTY_ID

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

PROPERTIES_ATTRIBUTES_REGEX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigGroupResourceProvider(AmbariManagementController managementController) Create a new resource provider for the given management controller.

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(Set<ConfigGroupRequest> requests) Create configuration group resources based on set of config group requests.
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.
boolean	evaluate(Predicate predicate, Resource resource) Bypassing predicate evaluation for the lack of a matcher for a non-scalar resource
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(Set<ConfigGroupRequest> requests)
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, 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_GROUP

public static final String CONFIG_GROUP

See Also:

Constant Field Values

CLUSTER_NAME_PROPERTY_ID

public static final String CLUSTER_NAME_PROPERTY_ID

See Also:

Constant Field Values

ID_PROPERTY_ID

public static final String ID_PROPERTY_ID

See Also:

Constant Field Values

GROUP_NAME_PROPERTY_ID

public static final String GROUP_NAME_PROPERTY_ID

See Also:

Constant Field Values

TAG_PROPERTY_ID

public static final String TAG_PROPERTY_ID

See Also:

Constant Field Values

SERVICE_NAME_PROPERTY_ID

public static final String SERVICE_NAME_PROPERTY_ID

See Also:

Constant Field Values

DESCRIPTION_PROPERTY_ID

public static final String DESCRIPTION_PROPERTY_ID

See Also:

Constant Field Values

SERVICE_CONFIG_VERSION_NOTE_PROPERTY_ID

public static final String SERVICE_CONFIG_VERSION_NOTE_PROPERTY_ID

See Also:

Constant Field Values

HOST_NAME_PROPERTY_ID

public static final String HOST_NAME_PROPERTY_ID

See Also:

Constant Field Values

HOSTS_HOSTNAME_PROPERTY_ID

public static final String HOSTS_HOSTNAME_PROPERTY_ID

See Also:

Constant Field Values

HOSTS_PROPERTY_ID

public static final String HOSTS_PROPERTY_ID

See Also:

Constant Field Values

DESIRED_CONFIGS_PROPERTY_ID

public static final String DESIRED_CONFIGS_PROPERTY_ID

See Also:

Constant Field Values

VERSION_TAGS_PROPERTY_ID

public static final String VERSION_TAGS_PROPERTY_ID

See Also:

Constant Field Values

CLUSTER_NAME

public static final String CLUSTER_NAME

ID

public static final String ID

GROUP_NAME

public static final String GROUP_NAME

TAG

public static final String TAG

SERVICE_NAME

public static final String SERVICE_NAME

DESCRIPTION

public static final String DESCRIPTION

SERVICE_CONFIG_VERSION_NOTE

public static final String SERVICE_CONFIG_VERSION_NOTE

HOST_NAME

public static final String HOST_NAME

HOSTS_HOST_NAME

public static final String HOSTS_HOST_NAME

HOSTS

public static final String HOSTS

DESIRED_CONFIGS

public static final String DESIRED_CONFIGS

VERSION_TAGS

public static final String VERSION_TAGS

Constructor Detail

ConfigGroupResourceProvider

protected ConfigGroupResourceProvider(AmbariManagementController managementController)

Create a new resource provider for the given management controller.

Parameters:

managementController - the management controller

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

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)

updateResourcesAuthorized

public 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

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

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.

createResources

public RequestStatus createResources(Set<ConfigGroupRequest> requests)
                              throws SystemException,
                                     UnsupportedPropertyException,
                                     ResourceAlreadyExistsException,
                                     NoSuchParentResourceException

Create configuration group resources based on set of config group requests.

Parameters:

requests - set of config group requests

Returns:

a request status

Throws:

SystemException - an internal system exception occurred

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

updateResources

public RequestStatus updateResources(Set<ConfigGroupRequest> requests)
                              throws SystemException,
                                     UnsupportedPropertyException,
                                     NoSuchResourceException,
                                     NoSuchParentResourceException

Throws:

SystemException

UnsupportedPropertyException

NoSuchResourceException

NoSuchParentResourceException

evaluate

public boolean evaluate(Predicate predicate,
                        Resource resource)

Bypassing predicate evaluation for the lack of a matcher for a non-scalar resource

Specified by:

evaluate in interface ResourcePredicateEvaluator

Parameters:

predicate - the predicate

resource - the resource

Returns:

always returns true