org.apache.ambari.server.controller.internal

Class AlertHistoryResourceProvider

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

org.apache.ambari.server.controller.internal.AlertHistoryResourceProvider

All Implemented Interfaces:

ObservableResourceProvider, ExtendedResourceProvider, ResourceProvider

public class AlertHistoryResourceProvider
extends ReadOnlyResourceProvider
implements ExtendedResourceProvider

ResourceProvider for Alert History

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	ALERT_HISTORY_CLUSTER_NAME
static String	ALERT_HISTORY_COMPONENT_NAME
static String	ALERT_HISTORY_DEFINITION_ID
static String	ALERT_HISTORY_DEFINITION_NAME
static String	ALERT_HISTORY_HOSTNAME
static String	ALERT_HISTORY_ID
static String	ALERT_HISTORY_INSTANCE
static String	ALERT_HISTORY_LABEL
static String	ALERT_HISTORY_SERVICE_NAME
static String	ALERT_HISTORY_STATE
static String	ALERT_HISTORY_TEXT
static String	ALERT_HISTORY_TIMESTAMP

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.
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.
QueryResponse	queryForResources(Request request, Predicate predicate) Query for resources that match the given predicate.
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.ReadOnlyResourceProvider

amendPredicate

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, getKeyPropertyIds

Field Detail

ALERT_HISTORY_DEFINITION_ID

public static final String ALERT_HISTORY_DEFINITION_ID

See Also:

Constant Field Values

ALERT_HISTORY_DEFINITION_NAME

public static final String ALERT_HISTORY_DEFINITION_NAME

See Also:

Constant Field Values

ALERT_HISTORY_ID

public static final String ALERT_HISTORY_ID

See Also:

Constant Field Values

ALERT_HISTORY_CLUSTER_NAME

public static final String ALERT_HISTORY_CLUSTER_NAME

See Also:

Constant Field Values

ALERT_HISTORY_SERVICE_NAME

public static final String ALERT_HISTORY_SERVICE_NAME

See Also:

Constant Field Values

ALERT_HISTORY_COMPONENT_NAME

public static final String ALERT_HISTORY_COMPONENT_NAME

See Also:

Constant Field Values

ALERT_HISTORY_HOSTNAME

public static final String ALERT_HISTORY_HOSTNAME

See Also:

Constant Field Values

ALERT_HISTORY_LABEL

public static final String ALERT_HISTORY_LABEL

See Also:

Constant Field Values

ALERT_HISTORY_STATE

public static final String ALERT_HISTORY_STATE

See Also:

Constant Field Values

ALERT_HISTORY_TEXT

public static final String ALERT_HISTORY_TEXT

See Also:

Constant Field Values

ALERT_HISTORY_TIMESTAMP

public static final String ALERT_HISTORY_TIMESTAMP

See Also:

Constant Field Values

ALERT_HISTORY_INSTANCE

public static final String ALERT_HISTORY_INSTANCE

See Also:

Constant Field Values

Method Detail

getPKPropertyIds

protected Set<String> getPKPropertyIds()

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

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 ReadOnlyResourceProvider

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

updateResources

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

Update the resources selected by the given predicate with the properties from 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 update resources.

Specified by:

updateResources in interface ResourceProvider

Overrides:

updateResources in class ReadOnlyResourceProvider

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

deleteResources

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

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 ReadOnlyResourceProvider

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

getResources

public Set<Resource> getResources(Request request,
                                  Predicate predicate)
                           throws SystemException,
                                  UnsupportedPropertyException,
                                  NoSuchResourceException,
                                  NoSuchParentResourceException

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 ReadOnlyResourceProvider

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

queryForResources

public QueryResponse queryForResources(Request request,
                                       Predicate predicate)
                                throws SystemException,
                                       UnsupportedPropertyException,
                                       NoSuchResourceException,
                                       NoSuchParentResourceException

Description copied from interface: ExtendedResourceProvider

Query for resources that match the given predicate.

Specified by:

queryForResources in interface ExtendedResourceProvider

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:

the response from the resource query

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