org.apache.ambari.server.controller.internal

Class MpackResourceProvider

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

All Implemented Interfaces:

ObservableResourceProvider, ResourceProvider

public class MpackResourceProvider
extends AbstractControllerResourceProvider

ResourceProvider for Mpack 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	ALL_PROPERTIES
static String	MODULES
static String	MPACK_DESCRIPTION
static String	MPACK_DISPLAY_NAME
static String	MPACK_ID
static String	MPACK_NAME
static String	MPACK_RESOURCE_ID
static String	MPACK_URI
static String	MPACK_VERSION
protected static MpackDAO	mpackDAO
static String	REGISTRY_ID
protected static RepositoryVersionDAO	repositoryVersionDAO
static String	RESPONSE_KEY
static String	STACK_NAME_PROPERTY_ID
static String	STACK_VERSION_PROPERTY_ID
protected static StackDAO	stackDAO

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

keyPropertyIds, LOG, PROPERTIES_ATTRIBUTES_REGEX

Method Summary

Modifier and Type	Method and Description
RequestStatus	createResources(Request request) Create the resources defined by the properties in the given request object.
protected 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.
MpackRequest	getRequest(Request request)
Set<Resource>	getResources(Request request, Predicate predicate) Get a set of resources based on the given request and predicate information.

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, deleteResources, getRequiredCreateAuthorizations, getRequiredDeleteAuthorizations, getRequiredGetAuthorizations, getRequiredUpdateAuthorizations, getResourceId, getResourcesAuthorized, getResourceType, isAuthorizedToCreateResources, isAuthorizedToDeleteResources, isAuthorizedToGetResources, isAuthorizedToUpdateResources, setRequiredCreateAuthorizations, setRequiredDeleteAuthorizations, setRequiredGetAuthorizations, setRequiredUpdateAuthorizations, updateResources, 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, 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

ALL_PROPERTIES

public static final String ALL_PROPERTIES

See Also:

Constant Field Values

MPACK_RESOURCE_ID

public static final String MPACK_RESOURCE_ID

See Also:

Constant Field Values

REGISTRY_ID

public static final String REGISTRY_ID

See Also:

Constant Field Values

MPACK_ID

public static final String MPACK_ID

See Also:

Constant Field Values

MPACK_NAME

public static final String MPACK_NAME

See Also:

Constant Field Values

MPACK_VERSION

public static final String MPACK_VERSION

See Also:

Constant Field Values

MPACK_DESCRIPTION

public static final String MPACK_DESCRIPTION

See Also:

Constant Field Values

MPACK_DISPLAY_NAME

public static final String MPACK_DISPLAY_NAME

See Also:

Constant Field Values

MPACK_URI

public static final String MPACK_URI

See Also:

Constant Field Values

MODULES

public static final String MODULES

See Also:

Constant Field Values

STACK_NAME_PROPERTY_ID

public static final String STACK_NAME_PROPERTY_ID

See Also:

Constant Field Values

STACK_VERSION_PROPERTY_ID

public static final String STACK_VERSION_PROPERTY_ID

See Also:

Constant Field Values

mpackDAO

@Inject
protected static MpackDAO mpackDAO

stackDAO

@Inject
protected static StackDAO stackDAO

repositoryVersionDAO

@Inject
protected static RepositoryVersionDAO repositoryVersionDAO

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

createResources

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

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

IllegalArgumentException

getRequest

public MpackRequest getRequest(Request request)
                        throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

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

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)