org.apache.ambari.server.controller.internal

Class ViewVersionResourceProvider

java.lang.Object

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

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

org.apache.ambari.server.controller.internal.ViewVersionResourceProvider

All Implemented Interfaces:

ObservableResourceProvider, ResourceProvider

public class ViewVersionResourceProvider
extends AbstractResourceProvider

Resource provider for view versions.

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	ARCHIVE
static String	ARCHIVE_PROPERTY_ID
static String	BUILD_NUMBER
static String	BUILD_NUMBER_PROPERTY_ID
static String	CLUSTER_CONFIGURABLE
static String	CLUSTER_CONFIGURABLE_PROPERTY_ID
static String	DESCRIPTION
static String	DESCRIPTION_PROPERTY_ID
static String	LABEL
static String	LABEL_PROPERTY_ID
static String	MASKER_CLASS
static String	MASKER_CLASS_PROPERTY_ID
static String	MAX_AMBARI_VERSION
static String	MAX_AMBARI_VERSION_PROPERTY_ID
static String	MIN_AMBARI_VERSION
static String	MIN_AMBARI_VERSION_PROPERTY_ID
static String	PARAMETERS
static String	PARAMETERS_PROPERTY_ID
static String	STATUS
static String	STATUS_DETAIL
static String	STATUS_DETAIL_PROPERTY_ID
static String	STATUS_PROPERTY_ID
static String	SYSTEM
static String	SYSTEM_PROPERTY_ID
static String	VERSION
static String	VERSION_PROPERTY_ID
static String	VIEW_NAME
static String	VIEW_NAME_PROPERTY_ID
static String	VIEW_VERSION_INFO View property id constants.

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

LOG, PROPERTIES_ATTRIBUTES_REGEX

Constructor Summary

Constructors

Constructor and Description
ViewVersionResourceProvider() Construct a view resource provider.

Method Summary

Modifier and Type	Method and Description
RequestStatus	createResources(Request request) Create the resources defined by the properties in the given request object.
RequestStatus	deleteResources(Request request, Predicate predicate) Delete the resources selected by the given predicate.
Map<Resource.Type,String>	getKeyPropertyIds() Get the key property ids for the resource type associated with this resource provider.
protected Set<String>	getPKPropertyIds() Get the set of property ids that uniquely identify the resources of this provider.
Set<Resource>	getResources(Request request, Predicate predicate) Get a set of resources based on the given request and predicate information.
ViewVersionResponse	getResponse(ViewEntity viewDefinition) Returns response schema instance for view version REST endpoint: /views/{viewName}/versions
RequestStatus	updateResources(Request request, Predicate predicate) Update the resources selected by the given predicate with the properties from the given request object.

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

addObserver, createResources, getConfigurationRequests, 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

VIEW_VERSION_INFO

public static final String VIEW_VERSION_INFO

View property id constants.

See Also:

Constant Field Values

VIEW_NAME_PROPERTY_ID

public static final String VIEW_NAME_PROPERTY_ID

See Also:

Constant Field Values

VERSION_PROPERTY_ID

public static final String VERSION_PROPERTY_ID

See Also:

Constant Field Values

BUILD_NUMBER_PROPERTY_ID

public static final String BUILD_NUMBER_PROPERTY_ID

See Also:

Constant Field Values

LABEL_PROPERTY_ID

public static final String LABEL_PROPERTY_ID

See Also:

Constant Field Values

DESCRIPTION_PROPERTY_ID

public static final String DESCRIPTION_PROPERTY_ID

See Also:

Constant Field Values

MIN_AMBARI_VERSION_PROPERTY_ID

public static final String MIN_AMBARI_VERSION_PROPERTY_ID

See Also:

Constant Field Values

MAX_AMBARI_VERSION_PROPERTY_ID

public static final String MAX_AMBARI_VERSION_PROPERTY_ID

See Also:

Constant Field Values

PARAMETERS_PROPERTY_ID

public static final String PARAMETERS_PROPERTY_ID

See Also:

Constant Field Values

ARCHIVE_PROPERTY_ID

public static final String ARCHIVE_PROPERTY_ID

See Also:

Constant Field Values

MASKER_CLASS_PROPERTY_ID

public static final String MASKER_CLASS_PROPERTY_ID

See Also:

Constant Field Values

STATUS_PROPERTY_ID

public static final String STATUS_PROPERTY_ID

See Also:

Constant Field Values

STATUS_DETAIL_PROPERTY_ID

public static final String STATUS_DETAIL_PROPERTY_ID

See Also:

Constant Field Values

CLUSTER_CONFIGURABLE_PROPERTY_ID

public static final String CLUSTER_CONFIGURABLE_PROPERTY_ID

See Also:

Constant Field Values

SYSTEM_PROPERTY_ID

public static final String SYSTEM_PROPERTY_ID

See Also:

Constant Field Values

VIEW_NAME

public static final String VIEW_NAME

See Also:

Constant Field Values

VERSION

public static final String VERSION

See Also:

Constant Field Values

BUILD_NUMBER

public static final String BUILD_NUMBER

See Also:

Constant Field Values

LABEL

public static final String LABEL

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

MIN_AMBARI_VERSION

public static final String MIN_AMBARI_VERSION

See Also:

Constant Field Values

MAX_AMBARI_VERSION

public static final String MAX_AMBARI_VERSION

See Also:

Constant Field Values

PARAMETERS

public static final String PARAMETERS

See Also:

Constant Field Values

ARCHIVE

public static final String ARCHIVE

See Also:

Constant Field Values

MASKER_CLASS

public static final String MASKER_CLASS

See Also:

Constant Field Values

STATUS

public static final String STATUS

See Also:

Constant Field Values

STATUS_DETAIL

public static final String STATUS_DETAIL

See Also:

Constant Field Values

CLUSTER_CONFIGURABLE

public static final String CLUSTER_CONFIGURABLE

See Also:

Constant Field Values

SYSTEM

public static final String SYSTEM

See Also:

Constant Field Values

Constructor Detail

ViewVersionResourceProvider

public ViewVersionResourceProvider()

Construct a view resource provider.

Method Detail

createResources

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

Description copied from interface: ResourceProvider

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

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

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

getResources

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

Description copied from interface: ResourceProvider

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

Note that it is not required for this resource provider to completely filter the set of resources based on the given predicate. It may not be possible since some of the properties involved may be provided by another provider. This partial filtering is allowed because the predicate will always be applied by the calling cluster controller. The predicate is made available at this level so that some pre-filtering can be done as an optimization.

A simple implementation of a resource provider may choose to just return all of the resources of a given type and allow the calling cluster controller to filter based on the predicate.

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

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

getResponse

public ViewVersionResponse getResponse(ViewEntity viewDefinition)

Returns response schema instance for view version REST endpoint: /views/{viewName}/versions

Parameters:

viewDefinition - view entity ViewEntity

Returns:

ViewVersionResponse

updateResources

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

Description copied from interface: ResourceProvider

Update the resources selected by the given predicate with the properties from the given request object.

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

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

Description copied from interface: ResourceProvider

Delete the resources selected by the given predicate.

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

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

getKeyPropertyIds

public Map<Resource.Type,String> getKeyPropertyIds()

Description copied from interface: ResourceProvider

Get the key property ids for the resource type associated with this resource provider. The key properties are those that uniquely identify the resource.

For example, the resource 'HostComponent' is uniquely identified by its associated 'Cluster', 'Host' and 'Component' resources. The key property ids for a 'HostComponent' resource includes the property ids of the foreign key references from the 'HostComponent' to 'Cluster', 'Host' and 'Component' resources.

Specified by:

getKeyPropertyIds in interface ResourceProvider

Overrides:

getKeyPropertyIds in class AbstractResourceProvider

Returns:

a map of key property ids

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