org.apache.ambari.server.controller.internal

Class ViewInstanceResourceProvider

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

All Implemented Interfaces:

ObservableResourceProvider, ResourceProvider

public class ViewInstanceResourceProvider
extends AbstractAuthorizedResourceProvider

Resource provider for view instances.

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_HANDLE
static String	CLUSTER_HANDLE_PROPERTY_ID
static String	CLUSTER_TYPE
static String	CLUSTER_TYPE_PROPERTY_ID
static String	CONTEXT_PATH
static String	CONTEXT_PATH_PROPERTY_ID
static String	DESCRIPTION
static String	DESCRIPTION_PROPERTY_ID
static String	ICON_PATH
static String	ICON_PATH_PROPERTY_ID
static String	ICON64_PATH
static String	ICON64_PATH_PROPERTY_ID
static String	INSTANCE_DATA
static String	INSTANCE_DATA_PROPERTY_ID
static String	INSTANCE_NAME
static String	INSTANCE_NAME_PROPERTY_ID
static String	LABEL
static String	LABEL_PROPERTY_ID
static String	PROPERTIES
static String	PROPERTIES_PROPERTY_ID
static String	PROPERTY_VALIDATION_RESULTS
static String	PROPERTY_VALIDATION_RESULTS_PROPERTY_ID
static String	SHORT_URL
static String	SHORT_URL_NAME
static String	SHORT_URL_NAME_PROPERTY_ID
static String	SHORT_URL_PROPERTY_ID
static String	STATIC
static String	STATIC_PROPERTY_ID
static String	VALIDATION_RESULT
static String	VALIDATION_RESULT_PROPERTY_ID
static String	VERSION
static String	VERSION_PROPERTY_ID
static String	VIEW_INSTANCE_INFO
static String	VIEW_NAME
static String	VIEW_NAME_PROPERTY_ID
static String	VISIBLE
static String	VISIBLE_PROPERTY_ID

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

LOG, PROPERTIES_ATTRIBUTES_REGEX

Constructor Summary

Constructors

Constructor and Description
ViewInstanceResourceProvider() Construct a view instance 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.
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.
protected Resource	toResource(ViewInstanceEntity viewInstanceEntity, Set<String> requestedIds)
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.AbstractAuthorizedResourceProvider

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

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_INSTANCE_INFO

public static final String VIEW_INSTANCE_INFO

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

INSTANCE_NAME_PROPERTY_ID

public static final String INSTANCE_NAME_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

VISIBLE_PROPERTY_ID

public static final String VISIBLE_PROPERTY_ID

See Also:

Constant Field Values

ICON_PATH_PROPERTY_ID

public static final String ICON_PATH_PROPERTY_ID

See Also:

Constant Field Values

ICON64_PATH_PROPERTY_ID

public static final String ICON64_PATH_PROPERTY_ID

See Also:

Constant Field Values

PROPERTIES_PROPERTY_ID

public static final String PROPERTIES_PROPERTY_ID

See Also:

Constant Field Values

INSTANCE_DATA_PROPERTY_ID

public static final String INSTANCE_DATA_PROPERTY_ID

See Also:

Constant Field Values

CONTEXT_PATH_PROPERTY_ID

public static final String CONTEXT_PATH_PROPERTY_ID

See Also:

Constant Field Values

STATIC_PROPERTY_ID

public static final String STATIC_PROPERTY_ID

See Also:

Constant Field Values

CLUSTER_HANDLE_PROPERTY_ID

public static final String CLUSTER_HANDLE_PROPERTY_ID

See Also:

Constant Field Values

CLUSTER_TYPE_PROPERTY_ID

public static final String CLUSTER_TYPE_PROPERTY_ID

See Also:

Constant Field Values

SHORT_URL_PROPERTY_ID

public static final String SHORT_URL_PROPERTY_ID

See Also:

Constant Field Values

SHORT_URL_NAME_PROPERTY_ID

public static final String SHORT_URL_NAME_PROPERTY_ID

See Also:

Constant Field Values

VALIDATION_RESULT_PROPERTY_ID

public static final String VALIDATION_RESULT_PROPERTY_ID

See Also:

Constant Field Values

PROPERTY_VALIDATION_RESULTS_PROPERTY_ID

public static final String PROPERTY_VALIDATION_RESULTS_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

INSTANCE_NAME

public static final String INSTANCE_NAME

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

VISIBLE

public static final String VISIBLE

See Also:

Constant Field Values

ICON_PATH

public static final String ICON_PATH

See Also:

Constant Field Values

ICON64_PATH

public static final String ICON64_PATH

See Also:

Constant Field Values

PROPERTIES

public static final String PROPERTIES

See Also:

Constant Field Values

INSTANCE_DATA

public static final String INSTANCE_DATA

See Also:

Constant Field Values

CONTEXT_PATH

public static final String CONTEXT_PATH

See Also:

Constant Field Values

STATIC

public static final String STATIC

See Also:

Constant Field Values

CLUSTER_HANDLE

public static final String CLUSTER_HANDLE

See Also:

Constant Field Values

CLUSTER_TYPE

public static final String CLUSTER_TYPE

See Also:

Constant Field Values

SHORT_URL

public static final String SHORT_URL

See Also:

Constant Field Values

SHORT_URL_NAME

public static final String SHORT_URL_NAME

See Also:

Constant Field Values

VALIDATION_RESULT

public static final String VALIDATION_RESULT

See Also:

Constant Field Values

PROPERTY_VALIDATION_RESULTS

public static final String PROPERTY_VALIDATION_RESULTS

See Also:

Constant Field Values

Constructor Detail

ViewInstanceResourceProvider

@Inject
public ViewInstanceResourceProvider()

Construct a view instance 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)

getResources

public Set<Resource> getResources(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.

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.

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 get resources.

Specified by:

getResources in interface ResourceProvider

Overrides:

getResources 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

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)

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

toResource

protected Resource toResource(ViewInstanceEntity viewInstanceEntity,
                              Set<String> requestedIds)