org.apache.ambari.server.controller.internal

Class RequestScheduleResourceProvider

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

All Implemented Interfaces:

ObservableResourceProvider, ResourceProvider

public class RequestScheduleResourceProvider
extends AbstractControllerResourceProvider

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	AUTHENTICATED_USER
static String	AUTHENTICATED_USER_PROPERTY_ID
static String	BATCH
static String	BATCH_PROPERTY_ID
static String	BATCH_REQUESTS
static String	BATCH_SEPARATION_IN_SECONDS
static String	BATCH_SEPARATION_IN_SECONDS_PROPERTY_ID
static String	BATCH_SETTINGS
static String	BODY
static String	CLUSTER_NAME
static String	CLUSTER_NAME_PROPERTY_ID
static String	CREATE_TIME
static String	CREATE_TIME_PROPERTY_ID
static String	CREATE_USER
static String	CREATE_USER_PROPERTY_ID
static String	DAY_OF_WEEK
static String	DAY_OF_WEEK_PROPERTY_ID
static String	DAYS_OF_MONTH
static String	DAYS_OF_MONTH_PROPERTY_ID
static String	DESCRIPTION
static String	DESCRIPTION_PROPERTY_ID
static String	END_TIME
static String	END_TIME_PROPERTY_ID
static String	END_TIME_SNAKE_CASE_PROPERTY_ID
static String	HOURS
static String	HOURS_PROPERTY_ID
static String	ID
static String	ID_PROPERTY_ID
static String	LAST_EXECUTION_STATUS
static String	LAST_EXECUTION_STATUS_PROPERTY_ID
static String	MINUTES
static String	MINUTES_PROPERTY_ID
static String	MONTH
static String	MONTH_PROPERTY_ID
static String	ORDER_ID
static String	ORDER_ID_PROPERTY_ID
static String	PAUSE_AFTER_FIRST_BATCH
static String	PAUSE_AFTER_FIRST_BATCH_PROPERTY_ID
static String	REQUEST_BODY_PROPERTY_ID
static String	REQUEST_SCHEDULE
static String	REQUEST_STATUS_PROPERTY_ID
static String	REQUEST_TYPE_PROPERTY_ID
static String	REQUEST_URI_PROPERTY_ID
static String	REQUESTS
static String	REQUESTS_PROPERTY_ID
static String	RESPONSE_MESSAGE_PROPERTY_ID
static String	RETURN_CODE_PROPERTY_ID
static String	SCHEDULE
static String	SCHEDULE_PROPERTY_ID
static String	START_TIME
static String	START_TIME_PROPERTY_ID
static String	START_TIME_SNAKE_CASE_PROPERTY_ID
static String	STATUS
static String	STATUS_PROPERTY_ID
static String	TASK_FAILURE_TOLERANCE
static String	TASK_FAILURE_TOLERANCE_LIMIT_PROPERTY_ID
static String	TASK_FAILURE_TOLERANCE_PER_BATCH
static String	TASK_FAILURE_TOLERANCE_PER_BATCH_PROPERTY_ID
static String	TASK_FAILURE_TOLERANCE_PROPERTY_ID
static String	TYPE
static String	TYPE_PROPERTY_ID
static String	UPDATE_TIME
static String	UPDATE_TIME_PROPERTY_ID
static String	UPDATE_USER
static String	UPDATE_USER_PROPERTY_ID
static String	URI
static String	URI_PROPERTY_ID
static String	YEAR
static String	YEAR_PROPERTY_ID

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

PROPERTIES_ATTRIBUTES_REGEX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RequestScheduleResourceProvider(AmbariManagementController managementController) Create a new resource provider for the given management controller.

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.
RequestStatus	updateResources(Request request, Predicate predicate) Currently unsupported operation.

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

REQUEST_SCHEDULE

public static final String REQUEST_SCHEDULE

See Also:

Constant Field Values

BATCH_SETTINGS

public static final String BATCH_SETTINGS

See Also:

Constant Field Values

BATCH_REQUESTS

public static final String BATCH_REQUESTS

See Also:

Constant Field Values

ID_PROPERTY_ID

public static final String ID_PROPERTY_ID

See Also:

Constant Field Values

CLUSTER_NAME_PROPERTY_ID

public static final String CLUSTER_NAME_PROPERTY_ID

See Also:

Constant Field Values

DESCRIPTION_PROPERTY_ID

public static final String DESCRIPTION_PROPERTY_ID

See Also:

Constant Field Values

STATUS_PROPERTY_ID

public static final String STATUS_PROPERTY_ID

See Also:

Constant Field Values

LAST_EXECUTION_STATUS_PROPERTY_ID

public static final String LAST_EXECUTION_STATUS_PROPERTY_ID

See Also:

Constant Field Values

BATCH_PROPERTY_ID

public static final String BATCH_PROPERTY_ID

See Also:

Constant Field Values

SCHEDULE_PROPERTY_ID

public static final String SCHEDULE_PROPERTY_ID

See Also:

Constant Field Values

CREATE_USER_PROPERTY_ID

public static final String CREATE_USER_PROPERTY_ID

See Also:

Constant Field Values

AUTHENTICATED_USER_PROPERTY_ID

public static final String AUTHENTICATED_USER_PROPERTY_ID

See Also:

Constant Field Values

UPDATE_USER_PROPERTY_ID

public static final String UPDATE_USER_PROPERTY_ID

See Also:

Constant Field Values

CREATE_TIME_PROPERTY_ID

public static final String CREATE_TIME_PROPERTY_ID

See Also:

Constant Field Values

UPDATE_TIME_PROPERTY_ID

public static final String UPDATE_TIME_PROPERTY_ID

See Also:

Constant Field Values

BATCH_SEPARATION_IN_SECONDS_PROPERTY_ID

public static final String BATCH_SEPARATION_IN_SECONDS_PROPERTY_ID

See Also:

Constant Field Values

TASK_FAILURE_TOLERANCE_PROPERTY_ID

public static final String TASK_FAILURE_TOLERANCE_PROPERTY_ID

See Also:

Constant Field Values

TASK_FAILURE_TOLERANCE_PER_BATCH_PROPERTY_ID

public static final String TASK_FAILURE_TOLERANCE_PER_BATCH_PROPERTY_ID

See Also:

Constant Field Values

TASK_FAILURE_TOLERANCE_LIMIT_PROPERTY_ID

public static final String TASK_FAILURE_TOLERANCE_LIMIT_PROPERTY_ID

See Also:

Constant Field Values

REQUESTS_PROPERTY_ID

public static final String REQUESTS_PROPERTY_ID

See Also:

Constant Field Values

PAUSE_AFTER_FIRST_BATCH_PROPERTY_ID

public static final String PAUSE_AFTER_FIRST_BATCH_PROPERTY_ID

See Also:

Constant Field Values

TYPE_PROPERTY_ID

public static final String TYPE_PROPERTY_ID

See Also:

Constant Field Values

URI_PROPERTY_ID

public static final String URI_PROPERTY_ID

See Also:

Constant Field Values

ORDER_ID_PROPERTY_ID

public static final String ORDER_ID_PROPERTY_ID

See Also:

Constant Field Values

REQUEST_TYPE_PROPERTY_ID

public static final String REQUEST_TYPE_PROPERTY_ID

See Also:

Constant Field Values

REQUEST_URI_PROPERTY_ID

public static final String REQUEST_URI_PROPERTY_ID

See Also:

Constant Field Values

REQUEST_BODY_PROPERTY_ID

public static final String REQUEST_BODY_PROPERTY_ID

See Also:

Constant Field Values

REQUEST_STATUS_PROPERTY_ID

public static final String REQUEST_STATUS_PROPERTY_ID

See Also:

Constant Field Values

RETURN_CODE_PROPERTY_ID

public static final String RETURN_CODE_PROPERTY_ID

See Also:

Constant Field Values

RESPONSE_MESSAGE_PROPERTY_ID

public static final String RESPONSE_MESSAGE_PROPERTY_ID

See Also:

Constant Field Values

DAYS_OF_MONTH_PROPERTY_ID

public static final String DAYS_OF_MONTH_PROPERTY_ID

See Also:

Constant Field Values

MINUTES_PROPERTY_ID

public static final String MINUTES_PROPERTY_ID

See Also:

Constant Field Values

HOURS_PROPERTY_ID

public static final String HOURS_PROPERTY_ID

See Also:

Constant Field Values

YEAR_PROPERTY_ID

public static final String YEAR_PROPERTY_ID

See Also:

Constant Field Values

DAY_OF_WEEK_PROPERTY_ID

public static final String DAY_OF_WEEK_PROPERTY_ID

See Also:

Constant Field Values

MONTH_PROPERTY_ID

public static final String MONTH_PROPERTY_ID

See Also:

Constant Field Values

START_TIME_PROPERTY_ID

public static final String START_TIME_PROPERTY_ID

See Also:

Constant Field Values

START_TIME_SNAKE_CASE_PROPERTY_ID

public static final String START_TIME_SNAKE_CASE_PROPERTY_ID

See Also:

Constant Field Values

END_TIME_PROPERTY_ID

public static final String END_TIME_PROPERTY_ID

See Also:

Constant Field Values

END_TIME_SNAKE_CASE_PROPERTY_ID

public static final String END_TIME_SNAKE_CASE_PROPERTY_ID

See Also:

Constant Field Values

ID

public static final String ID

CLUSTER_NAME

public static final String CLUSTER_NAME

DESCRIPTION

public static final String DESCRIPTION

STATUS

public static final String STATUS

LAST_EXECUTION_STATUS

public static final String LAST_EXECUTION_STATUS

BATCH

public static final String BATCH

SCHEDULE

public static final String SCHEDULE

CREATE_USER

public static final String CREATE_USER

AUTHENTICATED_USER

public static final String AUTHENTICATED_USER

UPDATE_USER

public static final String UPDATE_USER

CREATE_TIME

public static final String CREATE_TIME

UPDATE_TIME

public static final String UPDATE_TIME

BATCH_SEPARATION_IN_SECONDS

public static final String BATCH_SEPARATION_IN_SECONDS

TASK_FAILURE_TOLERANCE

public static final String TASK_FAILURE_TOLERANCE

TASK_FAILURE_TOLERANCE_PER_BATCH

public static final String TASK_FAILURE_TOLERANCE_PER_BATCH

REQUESTS

public static final String REQUESTS

PAUSE_AFTER_FIRST_BATCH

public static final String PAUSE_AFTER_FIRST_BATCH

TYPE

public static final String TYPE

URI

public static final String URI

ORDER_ID

public static final String ORDER_ID

BODY

public static final String BODY

DAYS_OF_MONTH

public static final String DAYS_OF_MONTH

MINUTES

public static final String MINUTES

HOURS

public static final String HOURS

YEAR

public static final String YEAR

DAY_OF_WEEK

public static final String DAY_OF_WEEK

MONTH

public static final String MONTH

START_TIME

public static final String START_TIME

END_TIME

public static final String END_TIME

Constructor Detail

RequestScheduleResourceProvider

protected RequestScheduleResourceProvider(AmbariManagementController managementController)

Create a new resource provider for the given management controller.

Parameters:

managementController - the 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 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

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

updateResources

public RequestStatus updateResources(Request request,
                                     Predicate predicate)
                              throws SystemException,
                                     UnsupportedPropertyException,
                                     NoSuchResourceException,
                                     NoSuchParentResourceException

Currently unsupported operation. Since strong guarantees are required that no jobs are currently running.

Specified by:

updateResources in interface ResourceProvider

Overrides:

updateResources 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:

Throws:

SystemException

UnsupportedPropertyException

NoSuchResourceException

NoSuchParentResourceException

AuthorizationException - if the authenticated user is not authorized to perform this operation

deleteResources

public RequestStatus deleteResources(Request request,
                                     Predicate predicate)
                              throws SystemException,
                                     UnsupportedPropertyException,
                                     NoSuchResourceException,
                                     NoSuchParentResourceException

Description copied from class: AbstractAuthorizedResourceProvider

Delete the resources selected by the given 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 delete resources.

Specified by:

deleteResources in interface ResourceProvider

Overrides:

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