org.apache.ambari.server.controller.internal

Class JobResourceProvider

java.lang.Object

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

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

org.apache.ambari.server.controller.internal.AbstractJDBCResourceProvider<org.apache.ambari.server.controller.internal.JobResourceProvider.JobFields>

org.apache.ambari.server.controller.internal.JobResourceProvider

All Implemented Interfaces:

ObservableResourceProvider, ResourceProvider

public class JobResourceProvider
extends AbstractJDBCResourceProvider<org.apache.ambari.server.controller.internal.JobResourceProvider.JobFields>

Resource provider for job resources.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JobResourceProvider.JobFetcher Simple interface for fetching jobs from db.
protected class	JobResourceProvider.PostgresJobFetcher A job fetcher that queries a postgres job table.

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
protected static String	JOB_CLUSTER_NAME_PROPERTY_ID
protected static String	JOB_CONF_PATH_PROPERTY_ID
protected static String	JOB_ELAPSED_TIME_PROPERTY_ID
protected static String	JOB_ID_PROPERTY_ID
protected static String	JOB_INPUT_BYTES_PROPERTY_ID
protected static String	JOB_MAPS_PROPERTY_ID
protected static String	JOB_NAME_PROPERTY_ID
protected static String	JOB_OUTPUT_BYTES_PROPERTY_ID
protected static String	JOB_REDUCES_PROPERTY_ID
protected static String	JOB_STATUS_PROPERTY_ID
protected static String	JOB_SUBMIT_TIME_PROPERTY_ID
protected static String	JOB_USER_NAME_PROPERTY_ID
protected static String	JOB_WORKFLOW_ENTITY_NAME_PROPERTY_ID
protected static String	JOB_WORKFLOW_ID_PROPERTY_ID
protected JobResourceProvider.JobFetcher	jobFetcher
protected static Map<Resource.Type,String>	keyPropertyIds The key property ids for a Job resource.
protected static Set<String>	propertyIds The property ids for a Job resource.

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

PROPERTIES_ATTRIBUTES_REGEX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JobResourceProvider() Create a new job resource provider.
protected	JobResourceProvider(JobResourceProvider.JobFetcher jobFetcher) Create a new job 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.
protected Map<String,org.apache.ambari.server.controller.internal.JobResourceProvider.JobFields>	getDBFieldMap() Gets a map from property ids to db fields.
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.
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.AbstractJDBCResourceProvider

getDBField, getDBFieldString, setInt, setLong, setString

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

JOB_CLUSTER_NAME_PROPERTY_ID

protected static final String JOB_CLUSTER_NAME_PROPERTY_ID

JOB_WORKFLOW_ID_PROPERTY_ID

protected static final String JOB_WORKFLOW_ID_PROPERTY_ID

JOB_ID_PROPERTY_ID

protected static final String JOB_ID_PROPERTY_ID

JOB_NAME_PROPERTY_ID

protected static final String JOB_NAME_PROPERTY_ID

JOB_STATUS_PROPERTY_ID

protected static final String JOB_STATUS_PROPERTY_ID

JOB_USER_NAME_PROPERTY_ID

protected static final String JOB_USER_NAME_PROPERTY_ID

JOB_SUBMIT_TIME_PROPERTY_ID

protected static final String JOB_SUBMIT_TIME_PROPERTY_ID

JOB_ELAPSED_TIME_PROPERTY_ID

protected static final String JOB_ELAPSED_TIME_PROPERTY_ID

JOB_MAPS_PROPERTY_ID

protected static final String JOB_MAPS_PROPERTY_ID

JOB_REDUCES_PROPERTY_ID

protected static final String JOB_REDUCES_PROPERTY_ID

JOB_INPUT_BYTES_PROPERTY_ID

protected static final String JOB_INPUT_BYTES_PROPERTY_ID

JOB_OUTPUT_BYTES_PROPERTY_ID

protected static final String JOB_OUTPUT_BYTES_PROPERTY_ID

JOB_CONF_PATH_PROPERTY_ID

protected static final String JOB_CONF_PATH_PROPERTY_ID

JOB_WORKFLOW_ENTITY_NAME_PROPERTY_ID

protected static final String JOB_WORKFLOW_ENTITY_NAME_PROPERTY_ID

jobFetcher

protected JobResourceProvider.JobFetcher jobFetcher

keyPropertyIds

protected static final Map<Resource.Type,String> keyPropertyIds

The key property ids for a Job resource.

propertyIds

protected static final Set<String> propertyIds

The property ids for a Job resource.

Constructor Detail

JobResourceProvider

protected JobResourceProvider()

Create a new job resource provider.

JobResourceProvider

protected JobResourceProvider(JobResourceProvider.JobFetcher jobFetcher)

Create a new job resource provider.

Parameters:

jobFetcher - job fetcher

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

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

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

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

getDBFieldMap

protected Map<String,org.apache.ambari.server.controller.internal.JobResourceProvider.JobFields> getDBFieldMap()

Description copied from class: AbstractJDBCResourceProvider

Gets a map from property ids to db fields.

Specified by:

getDBFieldMap in class AbstractJDBCResourceProvider<org.apache.ambari.server.controller.internal.JobResourceProvider.JobFields>

Returns:

the map from property ids to db fields.