org.apache.ambari.server.controller.internal

Class UserResourceProvider

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

All Implemented Interfaces:

ObservableResourceProvider, ResourcePredicateEvaluator, ResourceProvider

public class UserResourceProvider
extends AbstractControllerResourceProvider
implements ResourcePredicateEvaluator

Resource provider for user 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
static String	ACTIVE_PROPERTY_ID
static String	ADMIN_PROPERTY_ID
static String	CONSECUTIVE_FAILURES_PROPERTY_ID
static String	CREATE_TIME_PROPERTY_ID
static String	DISPLAY_NAME_PROPERTY_ID
static String	GROUPS_PROPERTY_ID
static String	LDAP_USER_PROPERTY_ID Deprecated.
static String	LOCAL_USERNAME_PROPERTY_ID
static String	OLD_PASSWORD_PROPERTY_ID Deprecated.
static String	PASSWORD_PROPERTY_ID Deprecated.
static String	USER_ACTIVE_PROPERTY_ID
static String	USER_ADMIN_PROPERTY_ID
static String	USER_CONSECUTIVE_FAILURES_PROPERTY_ID
static String	USER_CREATE_TIME_PROPERTY_ID
static String	USER_DISPLAY_NAME_PROPERTY_ID
static String	USER_GROUPS_PROPERTY_ID
static String	USER_LDAP_USER_PROPERTY_ID Deprecated.
static String	USER_LOCAL_USERNAME_PROPERTY_ID
static String	USER_OLD_PASSWORD_PROPERTY_ID Deprecated.
static String	USER_PASSWORD_PROPERTY_ID Deprecated.
static String	USER_RESOURCE_CATEGORY
static String	USER_TYPE_PROPERTY_ID Deprecated.
static String	USER_USER_TYPE_PROPERTY_ID Deprecated.
static String	USER_USERNAME_PROPERTY_ID
static String	USERNAME_PROPERTY_ID

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

PROPERTIES_ATTRIBUTES_REGEX

Method Summary

Modifier and Type	Method and Description
RequestStatus	createResourcesAuthorized(Request request) Create the resources defined by the properties in the given request object if authorization was granted to the authenticated user.
RequestStatus	deleteResourcesAuthorized(Request request, Predicate predicate) Delete the resources selected by the given predicate if the authenticated user is authorized to do so.
boolean	evaluate(Predicate predicate, Resource resource) ResourcePredicateEvaluator implementation.
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.AbstractControllerResourceProvider

getClusterId, getClusterResourceId, getClusterResourceId, getManagementController, getResourceProvider, getResourceProvider, init

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

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

USER_RESOURCE_CATEGORY

public static final String USER_RESOURCE_CATEGORY

See Also:

Constant Field Values

USERNAME_PROPERTY_ID

public static final String USERNAME_PROPERTY_ID

See Also:

Constant Field Values

DISPLAY_NAME_PROPERTY_ID

public static final String DISPLAY_NAME_PROPERTY_ID

See Also:

Constant Field Values

LOCAL_USERNAME_PROPERTY_ID

public static final String LOCAL_USERNAME_PROPERTY_ID

See Also:

Constant Field Values

ACTIVE_PROPERTY_ID

public static final String ACTIVE_PROPERTY_ID

See Also:

Constant Field Values

CREATE_TIME_PROPERTY_ID

public static final String CREATE_TIME_PROPERTY_ID

See Also:

Constant Field Values

CONSECUTIVE_FAILURES_PROPERTY_ID

public static final String CONSECUTIVE_FAILURES_PROPERTY_ID

See Also:

Constant Field Values

ADMIN_PROPERTY_ID

public static final String ADMIN_PROPERTY_ID

See Also:

Constant Field Values

GROUPS_PROPERTY_ID

public static final String GROUPS_PROPERTY_ID

See Also:

Constant Field Values

USER_USERNAME_PROPERTY_ID

public static final String USER_USERNAME_PROPERTY_ID

See Also:

Constant Field Values

USER_DISPLAY_NAME_PROPERTY_ID

public static final String USER_DISPLAY_NAME_PROPERTY_ID

See Also:

Constant Field Values

USER_LOCAL_USERNAME_PROPERTY_ID

public static final String USER_LOCAL_USERNAME_PROPERTY_ID

See Also:

Constant Field Values

USER_ACTIVE_PROPERTY_ID

public static final String USER_ACTIVE_PROPERTY_ID

See Also:

Constant Field Values

USER_CREATE_TIME_PROPERTY_ID

public static final String USER_CREATE_TIME_PROPERTY_ID

See Also:

Constant Field Values

USER_CONSECUTIVE_FAILURES_PROPERTY_ID

public static final String USER_CONSECUTIVE_FAILURES_PROPERTY_ID

See Also:

Constant Field Values

USER_ADMIN_PROPERTY_ID

public static final String USER_ADMIN_PROPERTY_ID

See Also:

Constant Field Values

USER_GROUPS_PROPERTY_ID

public static final String USER_GROUPS_PROPERTY_ID

See Also:

Constant Field Values

PASSWORD_PROPERTY_ID

@Deprecated
public static final String PASSWORD_PROPERTY_ID

Deprecated.

See Also:

Constant Field Values

OLD_PASSWORD_PROPERTY_ID

@Deprecated
public static final String OLD_PASSWORD_PROPERTY_ID

Deprecated.

See Also:

Constant Field Values

LDAP_USER_PROPERTY_ID

@Deprecated
public static final String LDAP_USER_PROPERTY_ID

Deprecated.

See Also:

Constant Field Values

USER_TYPE_PROPERTY_ID

@Deprecated
public static final String USER_TYPE_PROPERTY_ID

Deprecated.

See Also:

Constant Field Values

USER_PASSWORD_PROPERTY_ID

@Deprecated
public static final String USER_PASSWORD_PROPERTY_ID

Deprecated.

See Also:

Constant Field Values

USER_OLD_PASSWORD_PROPERTY_ID

@Deprecated
public static final String USER_OLD_PASSWORD_PROPERTY_ID

Deprecated.

See Also:

Constant Field Values

USER_LDAP_USER_PROPERTY_ID

@Deprecated
public static final String USER_LDAP_USER_PROPERTY_ID

Deprecated.

See Also:

Constant Field Values

USER_USER_TYPE_PROPERTY_ID

@Deprecated
public static final String USER_USER_TYPE_PROPERTY_ID

Deprecated.

See Also:

Constant Field Values

Method Detail

createResourcesAuthorized

public RequestStatus createResourcesAuthorized(Request request)
                                        throws SystemException,
                                               UnsupportedPropertyException,
                                               ResourceAlreadyExistsException,
                                               NoSuchParentResourceException

Description copied from class: AbstractAuthorizedResourceProvider

Create the resources defined by the properties in the given request object if authorization was granted to the authenticated user.

This method must be overwritten if AbstractAuthorizedResourceProvider.createResources(Request) is not overwritten.

Overrides:

createResourcesAuthorized 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

See Also:

AbstractAuthorizedResourceProvider.createResources(Request)

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

Description copied from class: AbstractAuthorizedResourceProvider

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

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

deleteResourcesAuthorized

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

Description copied from class: AbstractAuthorizedResourceProvider

Delete the resources selected by the given predicate if the authenticated user is authorized to do so.

This method must be overwritten if ResourceProvider.deleteResources(Request, Predicate) is not overwritten.

Overrides:

deleteResourcesAuthorized in class AbstractAuthorizedResourceProvider

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

See Also:

ResourceProvider.deleteResources(Request, Predicate)

evaluate

public boolean evaluate(Predicate predicate,
                        Resource resource)

ResourcePredicateEvaluator implementation. If property type is User/user_name, we do a case insensitive comparison so that we can return the retrieved username when it differs only in case with respect to the requested username.

Specified by:

evaluate in interface ResourcePredicateEvaluator

Parameters:

predicate - the predicate

resource - the resource

Returns:

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