org.apache.ambari.server.controller.internal

Class ArtifactResourceProvider

java.lang.Object

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

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

org.apache.ambari.server.controller.internal.ArtifactResourceProvider

All Implemented Interfaces:

ObservableResourceProvider, ResourceProvider

public class ArtifactResourceProvider
extends AbstractResourceProvider

Provider for cluster artifacts. Artifacts contain an artifact name as the PK and artifact data in the form of a map which is the content of the artifact.

An example of an artifact is a kerberos descriptor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ArtifactResourceProvider.TypeRegistration Used to register a dynamic sub-resource with an existing resource type.

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	ARTIFACT_DATA_PROPERTY
static String	ARTIFACT_NAME
static String	ARTIFACT_NAME_PROPERTY
static String	CLUSTER_NAME
static String	CLUSTER_NAME_PROPERTY
static String	KERBEROS_DESCRIPTOR
static String	RESPONSE_KEY
static String	SERVICE_NAME
static String	SERVICE_NAME_PROPERTY

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

PROPERTIES_ATTRIBUTES_REGEX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ArtifactResourceProvider(AmbariManagementController controller) Constructor.

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.
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.
static String	toArtifactDataJson(Map<?,?> properties)
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, 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

ARTIFACT_NAME

public static final String ARTIFACT_NAME

See Also:

Constant Field Values

CLUSTER_NAME

public static final String CLUSTER_NAME

See Also:

Constant Field Values

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

Constant Field Values

ARTIFACT_DATA_PROPERTY

public static final String ARTIFACT_DATA_PROPERTY

See Also:

Constant Field Values

ARTIFACT_NAME_PROPERTY

public static final String ARTIFACT_NAME_PROPERTY

See Also:

Constant Field Values

CLUSTER_NAME_PROPERTY

public static final String CLUSTER_NAME_PROPERTY

See Also:

Constant Field Values

SERVICE_NAME_PROPERTY

public static final String SERVICE_NAME_PROPERTY

See Also:

Constant Field Values

KERBEROS_DESCRIPTOR

public static final String KERBEROS_DESCRIPTOR

See Also:

Constant Field Values

Constructor Detail

ArtifactResourceProvider

@Inject
protected ArtifactResourceProvider(AmbariManagementController controller)

Constructor.

Parameters:

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

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

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

toArtifactDataJson

public static String toArtifactDataJson(Map<?,?> properties)