org.apache.ambari.server.controller.internal

Class AlertResourceProvider

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

All Implemented Interfaces:

ObservableResourceProvider, ExtendedResourceProvider, ResourceProvider

public class AlertResourceProvider
extends ReadOnlyResourceProvider
implements ExtendedResourceProvider

ResourceProvider for Alert instances

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_CLUSTER_NAME
static String	ALERT_COMPONENT
static String	ALERT_DEFINITION_ID
static String	ALERT_DEFINITION_NAME
protected static String	ALERT_FIRMNESS
static String	ALERT_HOST
static String	ALERT_ID
protected static String	ALERT_INSTANCE
protected static String	ALERT_LABEL
static String	ALERT_LATEST_TIMESTAMP
static String	ALERT_MAINTENANCE_STATE
protected static String	ALERT_OCCURRENCES
static String	ALERT_ORIGINAL_TIMESTAMP
protected static String	ALERT_REPEAT_TOLERANCE
protected static String	ALERT_REPEAT_TOLERANCE_REMAINING
protected static String	ALERT_SCOPE
static String	ALERT_SERVICE
static String	ALERT_STATE
static String	ALERT_TEXT

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

keyPropertyIds, PROPERTIES_ATTRIBUTES_REGEX

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class org.apache.ambari.server.controller.internal.ReadOnlyResourceProvider

amendPredicate, createResources, deleteResources, updateResources

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, createResources, deleteResources, getKeyPropertyIds, updateResources

Field Detail

ALERT_ID

public static final String ALERT_ID

See Also:

Constant Field Values

ALERT_STATE

public static final String ALERT_STATE

See Also:

Constant Field Values

ALERT_ORIGINAL_TIMESTAMP

public static final String ALERT_ORIGINAL_TIMESTAMP

See Also:

Constant Field Values

ALERT_LATEST_TIMESTAMP

public static final String ALERT_LATEST_TIMESTAMP

See Also:

Constant Field Values

ALERT_MAINTENANCE_STATE

public static final String ALERT_MAINTENANCE_STATE

See Also:

Constant Field Values

ALERT_DEFINITION_ID

public static final String ALERT_DEFINITION_ID

See Also:

Constant Field Values

ALERT_DEFINITION_NAME

public static final String ALERT_DEFINITION_NAME

See Also:

Constant Field Values

ALERT_TEXT

public static final String ALERT_TEXT

See Also:

Constant Field Values

ALERT_CLUSTER_NAME

public static final String ALERT_CLUSTER_NAME

See Also:

Constant Field Values

ALERT_COMPONENT

public static final String ALERT_COMPONENT

See Also:

Constant Field Values

ALERT_HOST

public static final String ALERT_HOST

See Also:

Constant Field Values

ALERT_SERVICE

public static final String ALERT_SERVICE

See Also:

Constant Field Values

ALERT_INSTANCE

protected static final String ALERT_INSTANCE

See Also:

Constant Field Values

ALERT_LABEL

protected static final String ALERT_LABEL

See Also:

Constant Field Values

ALERT_SCOPE

protected static final String ALERT_SCOPE

See Also:

Constant Field Values

ALERT_REPEAT_TOLERANCE

protected static final String ALERT_REPEAT_TOLERANCE

See Also:

Constant Field Values

ALERT_OCCURRENCES

protected static final String ALERT_OCCURRENCES

See Also:

Constant Field Values

ALERT_REPEAT_TOLERANCE_REMAINING

protected static final String ALERT_REPEAT_TOLERANCE_REMAINING

See Also:

Constant Field Values

ALERT_FIRMNESS

protected static final String ALERT_FIRMNESS

See Also:

Constant Field Values

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

queryForResources

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

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

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