org.apache.ambari.server.controller.internal

Class VersionDefinitionResourceProvider

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

All Implemented Interfaces:

ObservableResourceProvider, ResourceProvider

public class VersionDefinitionResourceProvider
extends AbstractAuthorizedResourceProvider

The VersionDefinitionResourceProvider class deals with managing Version Definition files.

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	DIRECTIVE_SKIP_URL_CHECK
protected static String	SHOW_AVAILABLE
static String	SUBRESOURCE_OPERATING_SYSTEMS_PROPERTY_ID
static String	VERSION_DEF
static String	VERSION_DEF_AVAILABLE_DEFINITION
protected static String	VERSION_DEF_AVAILABLE_SERVICES
static String	VERSION_DEF_BASE64_PROPERTY
protected static String	VERSION_DEF_DEFINITION_BASE64
protected static String	VERSION_DEF_DEFINITION_URL
protected static String	VERSION_DEF_DISPLAY_NAME
protected static String	VERSION_DEF_FULL_VERSION
static String	VERSION_DEF_ID
protected static String	VERSION_DEF_MAX_JDK
protected static String	VERSION_DEF_MIN_JDK
protected static String	VERSION_DEF_RELEASE_BUILD
protected static String	VERSION_DEF_RELEASE_COMPATIBLE_WITH
protected static String	VERSION_DEF_RELEASE_NOTES
protected static String	VERSION_DEF_RELEASE_VERSION
protected static String	VERSION_DEF_STACK_DEFAULT
static String	VERSION_DEF_STACK_NAME
protected static String	VERSION_DEF_STACK_REPO_UPDATE_LINK_EXISTS
protected static String	VERSION_DEF_STACK_SERVICES
static String	VERSION_DEF_STACK_VERSION
protected static String	VERSION_DEF_TYPE_PROPERTY_ID
protected static String	VERSION_DEF_VALIDATION

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

keyPropertyIds, PROPERTIES_ATTRIBUTES_REGEX

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.
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 ResourceType	getResourceType(Request request, Predicate predicate) Gets the ResourceType that is effected by the relevant request and predicate.
protected void	toRepositoryVersionEntity(org.apache.ambari.server.controller.internal.VersionDefinitionResourceProvider.XmlHolder holder) Transforms a XML version defintion to an entity
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, 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

VERSION_DEF

public static final String VERSION_DEF

See Also:

Constant Field Values

VERSION_DEF_BASE64_PROPERTY

public static final String VERSION_DEF_BASE64_PROPERTY

See Also:

Constant Field Values

VERSION_DEF_STACK_NAME

public static final String VERSION_DEF_STACK_NAME

See Also:

Constant Field Values

VERSION_DEF_STACK_VERSION

public static final String VERSION_DEF_STACK_VERSION

See Also:

Constant Field Values

VERSION_DEF_ID

public static final String VERSION_DEF_ID

See Also:

Constant Field Values

VERSION_DEF_TYPE_PROPERTY_ID

protected static final String VERSION_DEF_TYPE_PROPERTY_ID

See Also:

Constant Field Values

VERSION_DEF_DEFINITION_URL

protected static final String VERSION_DEF_DEFINITION_URL

See Also:

Constant Field Values

VERSION_DEF_AVAILABLE_DEFINITION

public static final String VERSION_DEF_AVAILABLE_DEFINITION

See Also:

Constant Field Values

VERSION_DEF_DEFINITION_BASE64

protected static final String VERSION_DEF_DEFINITION_BASE64

VERSION_DEF_FULL_VERSION

protected static final String VERSION_DEF_FULL_VERSION

See Also:

Constant Field Values

VERSION_DEF_RELEASE_VERSION

protected static final String VERSION_DEF_RELEASE_VERSION

See Also:

Constant Field Values

VERSION_DEF_RELEASE_BUILD

protected static final String VERSION_DEF_RELEASE_BUILD

See Also:

Constant Field Values

VERSION_DEF_RELEASE_NOTES

protected static final String VERSION_DEF_RELEASE_NOTES

See Also:

Constant Field Values

VERSION_DEF_RELEASE_COMPATIBLE_WITH

protected static final String VERSION_DEF_RELEASE_COMPATIBLE_WITH

See Also:

Constant Field Values

VERSION_DEF_AVAILABLE_SERVICES

protected static final String VERSION_DEF_AVAILABLE_SERVICES

See Also:

Constant Field Values

VERSION_DEF_STACK_SERVICES

protected static final String VERSION_DEF_STACK_SERVICES

See Also:

Constant Field Values

VERSION_DEF_STACK_DEFAULT

protected static final String VERSION_DEF_STACK_DEFAULT

See Also:

Constant Field Values

VERSION_DEF_STACK_REPO_UPDATE_LINK_EXISTS

protected static final String VERSION_DEF_STACK_REPO_UPDATE_LINK_EXISTS

See Also:

Constant Field Values

VERSION_DEF_DISPLAY_NAME

protected static final String VERSION_DEF_DISPLAY_NAME

See Also:

Constant Field Values

VERSION_DEF_VALIDATION

protected static final String VERSION_DEF_VALIDATION

See Also:

Constant Field Values

SHOW_AVAILABLE

protected static final String SHOW_AVAILABLE

See Also:

Constant Field Values

VERSION_DEF_MIN_JDK

protected static final String VERSION_DEF_MIN_JDK

See Also:

Constant Field Values

VERSION_DEF_MAX_JDK

protected static final String VERSION_DEF_MAX_JDK

See Also:

Constant Field Values

DIRECTIVE_SKIP_URL_CHECK

public static final String DIRECTIVE_SKIP_URL_CHECK

See Also:

Constant Field Values

SUBRESOURCE_OPERATING_SYSTEMS_PROPERTY_ID

public static final String SUBRESOURCE_OPERATING_SYSTEMS_PROPERTY_ID

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)

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

getResourceType

protected ResourceType getResourceType(Request request,
                                       Predicate predicate)

Description copied from class: AbstractAuthorizedResourceProvider

Gets the ResourceType that is effected by the relevant request and predicate.

Implementations should override this method return the proper ResourceType.

Overrides:

getResourceType in class AbstractAuthorizedResourceProvider

Parameters:

request - the request object which defines the desired set of properties

predicate - the predicate object which can be used to indicate the filter

Returns:

a ResourceType

toRepositoryVersionEntity

protected void toRepositoryVersionEntity(org.apache.ambari.server.controller.internal.VersionDefinitionResourceProvider.XmlHolder holder)
                                  throws org.apache.ambari.server.AmbariException

Transforms a XML version defintion to an entity

Throws:

org.apache.ambari.server.AmbariException - if some properties are missing or json has incorrect structure