Package org.apache.jackrabbit.oak.security.user.query

Class UserQueryManager

java.lang.Object

org.apache.jackrabbit.oak.security.user.query.UserQueryManager

public class UserQueryManager
extends java.lang.Object

Query manager for user specific searches.

Constructor Summary

Constructors

Constructor	Description
UserQueryManager(@NotNull UserManagerImpl userManager, @NotNull NamePathMapper namePathMapper, @NotNull ConfigurationParameters config, @NotNull Root root)

Method Summary

Modifier and Type	Method	Description
@NotNull java.util.Iterator<Authorizable>	findAuthorizables(@NotNull java.lang.String relPath, @Nullable java.lang.String value, @NotNull AuthorizableType authorizableType)	Find the authorizables matching the following search parameters within the sub-tree defined by an authorizable tree:
@NotNull java.util.Iterator<Authorizable>	findAuthorizables(@NotNull java.lang.String relPath, @Nullable java.lang.String value, @NotNull AuthorizableType authorizableType, boolean exact)	Find the authorizables matching the following search parameters within the sub-tree defined by an authorizable tree:
@NotNull java.util.Iterator<Authorizable>	findAuthorizables(@NotNull Query query)	Find the authorizables matching the specified user Query.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserQueryManager

public UserQueryManager(@NotNull
                        @NotNull UserManagerImpl userManager,
                        @NotNull
                        @NotNull NamePathMapper namePathMapper,
                        @NotNull
                        @NotNull ConfigurationParameters config,
                        @NotNull
                        @NotNull Root root)

Method Detail

findAuthorizables

@NotNull
public @NotNull java.util.Iterator<Authorizable> findAuthorizables(@NotNull
                                                                   @NotNull Query query)
                                                            throws RepositoryException

Find the authorizables matching the specified user Query.

Parameters:

query - A query object.

Returns:

An iterator of authorizables that match the specified query.

Throws:

RepositoryException - If an error occurs.

findAuthorizables

@NotNull
public @NotNull java.util.Iterator<Authorizable> findAuthorizables(@NotNull
                                                                   @NotNull java.lang.String relPath,
                                                                   @Nullable
                                                                   @Nullable java.lang.String value,
                                                                   @NotNull
                                                                   @NotNull AuthorizableType authorizableType)
                                                            throws RepositoryException

Find the authorizables matching the following search parameters within the sub-tree defined by an authorizable tree:

Parameters:

relPath - A relative path (or a name) pointing to properties within the tree defined by a given authorizable node.

value - The property value to look for.

authorizableType - Filter the search results to only return authorizable trees of a given type. Passing AuthorizableType.AUTHORIZABLE indicates that no filtering for a specific authorizable type is desired. However, properties might still be search in the complete sub-tree of authorizables depending on the other query parameters.

Returns:

An iterator of authorizable trees that match the specified search parameters and filters or an empty iterator if no result can be found.

Throws:

RepositoryException - If an error occurs.

findAuthorizables

@NotNull
public @NotNull java.util.Iterator<Authorizable> findAuthorizables(@NotNull
                                                                   @NotNull java.lang.String relPath,
                                                                   @Nullable
                                                                   @Nullable java.lang.String value,
                                                                   @NotNull
                                                                   @NotNull AuthorizableType authorizableType,
                                                                   boolean exact)
                                                            throws RepositoryException

Find the authorizables matching the following search parameters within the sub-tree defined by an authorizable tree:

Parameters:

relPath - A relative path (or a name) pointing to properties within the tree defined by a given authorizable node.

value - The property value to look for.

authorizableType - Filter the search results to only return authorizable trees of a given type. Passing AuthorizableType.AUTHORIZABLE indicates that no filtering for a specific authorizable type is desired. However, properties might still be search in the complete sub-tree of authorizables depending on the other query parameters.

exact - A boolean flag indicating if the value must match exactly or not.s

Returns:

An iterator of authorizable trees that match the specified search parameters and filters or an empty iterator if no result can be found.

Throws:

RepositoryException - If an error occurs.