org.apache.ambari.server.controller.internal

Class GroupPrivilegeResourceProvider

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

All Implemented Interfaces:

ObservableResourceProvider, ResourceProvider

public class GroupPrivilegeResourceProvider
extends ReadOnlyResourceProvider

Resource provider for group privilege resources.

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
protected static String	CLUSTER_NAME
protected static String	GROUP_NAME
protected static String	GROUP_NAME_PROPERTY_ID
protected static String	INSTANCE_NAME
protected static String	PERMISSION_LABEL
protected static String	PERMISSION_NAME
protected static String	PRINCIPAL_NAME
protected static String	PRINCIPAL_TYPE
protected static String	PRIVILEGE_ID
protected static String	TYPE
protected static String	VIEW_NAME
protected static String	VIEW_VERSION

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

LOG, PROPERTIES_ATTRIBUTES_REGEX

Constructor Summary

Constructors

Constructor and Description
GroupPrivilegeResourceProvider() Constructor.

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.
protected GroupPrivilegeResponse	getResponse(PrivilegeEntity privilegeEntity, String groupName) Returns the response for the group privilege that should be returned for the group privilege REST endpoint
static void	init(ClusterDAO clusterDAO, GroupDAO groupDAO, ViewInstanceDAO viewInstanceDAO, Users users) Static initialization.
protected Resource	toResource(GroupPrivilegeResponse response, Set<String> requestedIds) Translate the Response into a Resource

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

Field Detail

GROUP_NAME_PROPERTY_ID

protected static final String GROUP_NAME_PROPERTY_ID

See Also:

Constant Field Values

PRIVILEGE_ID

protected static final String PRIVILEGE_ID

See Also:

Constant Field Values

PERMISSION_NAME

protected static final String PERMISSION_NAME

See Also:

Constant Field Values

PERMISSION_LABEL

protected static final String PERMISSION_LABEL

See Also:

Constant Field Values

PRINCIPAL_NAME

protected static final String PRINCIPAL_NAME

See Also:

Constant Field Values

PRINCIPAL_TYPE

protected static final String PRINCIPAL_TYPE

See Also:

Constant Field Values

VIEW_NAME

protected static final String VIEW_NAME

See Also:

Constant Field Values

VIEW_VERSION

protected static final String VIEW_VERSION

See Also:

Constant Field Values

INSTANCE_NAME

protected static final String INSTANCE_NAME

See Also:

Constant Field Values

CLUSTER_NAME

protected static final String CLUSTER_NAME

See Also:

Constant Field Values

TYPE

protected static final String TYPE

See Also:

Constant Field Values

GROUP_NAME

protected static final String GROUP_NAME

See Also:

Constant Field Values

Constructor Detail

GroupPrivilegeResourceProvider

public GroupPrivilegeResourceProvider()

Constructor.

Method Detail

init

public static void init(ClusterDAO clusterDAO,
                        GroupDAO groupDAO,
                        ViewInstanceDAO viewInstanceDAO,
                        Users users)

Static initialization.

Parameters:

clusterDAO - the cluster data access object

groupDAO - the group data access object

viewInstanceDAO - the view instance data access object

users - the users helper instance

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

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

getResponse

protected GroupPrivilegeResponse getResponse(PrivilegeEntity privilegeEntity,
                                             String groupName)

Returns the response for the group privilege that should be returned for the group privilege REST endpoint

Parameters:

privilegeEntity - the privilege data

groupName - the group name

Returns:

group privilege response

toResource

protected Resource toResource(GroupPrivilegeResponse response,
                              Set<String> requestedIds)

Translate the Response into a Resource

Parameters:

response - PrivilegeResponse

requestedIds - the relevant request ids

Returns:

a resource