Package org.apache.sling.jackrabbit.usermanager.impl.resource

Class AuthorizableResourceProvider

java.lang.Object

org.apache.sling.spi.resource.provider.ResourceProvider<Object>

org.apache.sling.jackrabbit.usermanager.impl.resource.AuthorizableResourceProvider

All Implemented Interfaces:

SystemUserManagerPaths

public class AuthorizableResourceProvider
extends ResourceProvider<Object>
implements SystemUserManagerPaths

Resource Provider implementation for jackrabbit UserManager resources.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	AuthorizableResourceProvider.AuthorizableWorker<T>	Interface for lambda expressions to do work on a resolved authorizable + optional relative path
static @interface	AuthorizableResourceProvider.Config
protected static interface	AuthorizableResourceProvider.PrincipalWorker<T>	Interface for lambda expressions to do work on a resolved principal

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SYSTEM_USER_MANAGER_PATH
static final String	SYSTEM_USER_MANAGER_GROUP_PATH	Deprecated. no longer used.
static final String	SYSTEM_USER_MANAGER_GROUP_PREFIX	Deprecated. no longer used.
static final String	SYSTEM_USER_MANAGER_PATH	Deprecated. no longer used.
static final String	SYSTEM_USER_MANAGER_USER_PATH	Deprecated. no longer used.
static final String	SYSTEM_USER_MANAGER_USER_PREFIX	Deprecated. no longer used.

Fields inherited from class org.apache.sling.spi.resource.provider.ResourceProvider

AUTH_ADMIN, AUTH_CLONE, AUTH_SERVICE_BUNDLE, AUTHENTICATE_LAZY, AUTHENTICATE_NO, AUTHENTICATE_REQUIRED, MODE_OVERLAY, MODE_PASSTHROUGH, PROPERTY_ADAPTABLE, PROPERTY_ATTRIBUTABLE, PROPERTY_AUTHENTICATE, PROPERTY_MODE, PROPERTY_MODIFIABLE, PROPERTY_NAME, PROPERTY_REFRESHABLE, PROPERTY_ROOT, PROPERTY_USE_RESOURCE_ACCESS_SECURITY, RESOURCE_TYPE_SYNTHETIC

Constructor Summary

Constructors

Constructor	Description
AuthorizableResourceProvider()

Method Summary

Modifier and Type	Method	Description
protected void	activate(AuthorizableResourceProvider.Config config)
protected List<Resource>	filterPropertyContainers(String relPath, org.apache.jackrabbit.api.security.user.Authorizable authorizable, Resource r)	Filter the resource children to return only the resources that are nested property containers
String	getGroupPrefix()	The path prefix (before the id) for groups
String	getGroupsPath()	The root path for all group resources
protected static Iterator<String>	getPropertyNames(String relPath, org.apache.jackrabbit.api.security.user.Authorizable authorizable)
Resource	getResource(ResolveContext<Object> ctx, String path, ResourceContext resourceContext, Resource parent)	Returns a resource from this resource provider or null if the resource provider cannot find it.
String	getRootPath()	The root path for usermanager resources
String	getUserPrefix()	The path prefix (before the id) for users
String	getUsersPath()	The root path for all user resources
Iterator<Resource>	listChildren(ResolveContext<Object> ctx, Resource parent)	Returns an Iterator of Resource objects loaded from the children of the given Resource.
protected <T> T	maybeDoAuthorizableWork(@NotNull ResolveContext<Object> ctx, @NotNull String path, @NotNull AuthorizableResourceProvider.AuthorizableWorker<T> authorizableWorker, @Nullable AuthorizableResourceProvider.PrincipalWorker<T> principalWorker)	If the path resolves to a user or group (with optional relPath suffix) then invoke the worker to do some work.

Methods inherited from class org.apache.sling.spi.resource.provider.ResourceProvider

adaptTo, authenticate, commit, copy, create, delete, getAttribute, getAttributeNames, getParent, getProviderContext, getQueryLanguageProvider, hasChanges, isLive, logout, move, orderBefore, refresh, revert, start, stop, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_SYSTEM_USER_MANAGER_PATH

public static final String DEFAULT_SYSTEM_USER_MANAGER_PATH

See Also:

• Constant Field Values

SYSTEM_USER_MANAGER_PATH

@Deprecated
public static final String SYSTEM_USER_MANAGER_PATH

Deprecated.

no longer used. Use SystemUserManagerPaths service instead.

See Also:

• Constant Field Values

SYSTEM_USER_MANAGER_USER_PATH

@Deprecated
public static final String SYSTEM_USER_MANAGER_USER_PATH

Deprecated.

no longer used. Use SystemUserManagerPaths service instead.

See Also:

• Constant Field Values

SYSTEM_USER_MANAGER_GROUP_PATH

@Deprecated
public static final String SYSTEM_USER_MANAGER_GROUP_PATH

Deprecated.

no longer used. Use SystemUserManagerPaths service instead.

See Also:

• Constant Field Values

SYSTEM_USER_MANAGER_USER_PREFIX

@Deprecated
public static final String SYSTEM_USER_MANAGER_USER_PREFIX

Deprecated.

no longer used. Use SystemUserManagerPaths service instead.

See Also:

• Constant Field Values

SYSTEM_USER_MANAGER_GROUP_PREFIX

@Deprecated
public static final String SYSTEM_USER_MANAGER_GROUP_PREFIX

Deprecated.

no longer used. Use SystemUserManagerPaths service instead.

See Also:

• Constant Field Values

Constructor Details

AuthorizableResourceProvider

public AuthorizableResourceProvider()

Method Details

activate

protected void activate(AuthorizableResourceProvider.Config config)

getRootPath

public String getRootPath()

Description copied from interface: SystemUserManagerPaths

The root path for usermanager resources

Specified by:

getRootPath in interface SystemUserManagerPaths

getUsersPath

public String getUsersPath()

Description copied from interface: SystemUserManagerPaths

The root path for all user resources

Specified by:

getUsersPath in interface SystemUserManagerPaths

getUserPrefix

public String getUserPrefix()

Description copied from interface: SystemUserManagerPaths

The path prefix (before the id) for users

Specified by:

getUserPrefix in interface SystemUserManagerPaths

getGroupsPath

public String getGroupsPath()

Description copied from interface: SystemUserManagerPaths

The root path for all group resources

Specified by:

getGroupsPath in interface SystemUserManagerPaths

getGroupPrefix

public String getGroupPrefix()

Description copied from interface: SystemUserManagerPaths

The path prefix (before the id) for groups

Specified by:

getGroupPrefix in interface SystemUserManagerPaths

getResource

public Resource getResource(ResolveContext<Object> ctx,
 String path,
 ResourceContext resourceContext,
 Resource parent)

Description copied from class: ResourceProvider

Returns a resource from this resource provider or null if the resource provider cannot find it. The path must have the ResourceProvider.PROPERTY_ROOT strings as its prefix. The resource provider must not return cached instances for a resource as the resource resolver will update the resource meta data of the resource at the end of the resolution process and this meta data might be different depending on the full path of resource resolution passed into the resource resolver.

Specified by:

getResource in class ResourceProvider<Object>

Parameters:

ctx - The ResolveContext.

path - The full path of the resource.

resourceContext - Additional information for resolving the resource

parent - Optional parent resource

Returns:

null If this provider does not have a resource for the path.

maybeDoAuthorizableWork

protected <T> T maybeDoAuthorizableWork(@NotNull
 @NotNull ResolveContext<Object> ctx,
 @NotNull
 @NotNull String path,
 @NotNull
 @NotNull AuthorizableResourceProvider.AuthorizableWorker<T> authorizableWorker,
 @Nullable
 @Nullable AuthorizableResourceProvider.PrincipalWorker<T> principalWorker)

If the path resolves to a user or group (with optional relPath suffix) then invoke the worker to do some work.

getPropertyNames

protected static Iterator<String> getPropertyNames(String relPath,
 org.apache.jackrabbit.api.security.user.Authorizable authorizable)

listChildren

public Iterator<Resource> listChildren(ResolveContext<Object> ctx,
 Resource parent)

Description copied from class: ResourceProvider

Returns an Iterator of Resource objects loaded from the children of the given Resource. The returned Resource instances are attached to the same ResourceResolver as the given parent resource.

This method may be called for resource providers whose root path list contains a path such that the resource path is a prefix of the list entry. This allows for the enumeration of deeply nested provided resources for which no actual parent hierarchy exists.

The returned iterator may in turn contain resources which do not actually exist but are required to traverse the resource tree. Such resources SHOULD be SyntheticResource objects whose resource type MUST be set to ResourceProvider.RESOURCE_TYPE_SYNTHETIC. As with ResourceProvider.getResource(ResolveContext, String, ResourceContext, Resource) the returned Resource objects must not be cached objects.

Specified by:

listChildren in class ResourceProvider<Object>

Parameters:

ctx - The ResolveContext.

parent - The Resource whose children are requested.

Returns:

An Iterator of Resource objects or null if the resource provider has no children for the given resource.

filterPropertyContainers

protected List<Resource> filterPropertyContainers(String relPath,
 org.apache.jackrabbit.api.security.user.Authorizable authorizable,
 Resource r)

Filter the resource children to return only the resources that are nested property containers

Parameters:

relPath - the relative path to start from

authorizable - the user or group

r - the resource to filter the children of

Returns:

list of resources that are property containers