org.apache.jackrabbit.oak.jcr.delegate

Class UserManagerDelegator

java.lang.Object

org.apache.jackrabbit.oak.jcr.delegate.UserManagerDelegator

All Implemented Interfaces:

UserManager

public class UserManagerDelegator
extends Object
implements UserManager

This implementation of UserManager delegates back to a delegatee wrapping each call into a UserManager closure.

See Also:

SessionDelegate.perform(org.apache.jackrabbit.oak.jcr.session.operation.SessionOperation)

Field Summary

Fields inherited from interface org.apache.jackrabbit.api.security.user.UserManager

SEARCH_TYPE_AUTHORIZABLE, SEARCH_TYPE_GROUP, SEARCH_TYPE_USER

Constructor Summary

Constructors

Constructor and Description
UserManagerDelegator(SessionDelegate sessionDelegate, UserManager userManagerDelegate)

Method Summary

Modifier and Type	Method and Description
void	autoSave(boolean enable) Changes the auto save behavior of this UserManager.
@NotNull Group	createGroup(@NotNull Principal principal) Creates a new Group that is based on the given principal.
@NotNull Group	createGroup(@NotNull Principal principal, @Nullable String intermediatePath) Same as UserManager.createGroup(String, Principal, String) where the name of the specified principal is used to create the group's ID.
@NotNull Group	createGroup(@NotNull String groupID) Creates a Group for the given groupID, which must not be null.
@NotNull Group	createGroup(@NotNull String groupID, @NotNull Principal principal, @Nullable String intermediatePath) Creates a new Group that is based on the given id, principal and the specified intermediatePath hint.
@NotNull User	createSystemUser(@NotNull String userID, @Nullable String intermediatePath) Create a new system user for the specified userID.
@NotNull User	createUser(@NotNull String userID, @Nullable String password) Creates an User for the given userID / password pair; neither of the specified parameters can be null. Same as UserManager.createUser(String,String,Principal,String) where the specified userID is equal to the principal name and the intermediate path is null.
@NotNull User	createUser(@NotNull String userID, @Nullable String password, @NotNull Principal principal, @Nullable String intermediatePath) Creates an User for the given parameters.
@NotNull Iterator<Authorizable>	findAuthorizables(@NotNull Query query) Return Authorizables that match a specific Query.
@NotNull Iterator<Authorizable>	findAuthorizables(@NotNull String relPath, @Nullable String value) Returns all Authorizables that have a property with the given relative path (or name) that matches the specified value.
@NotNull Iterator<Authorizable>	findAuthorizables(@NotNull String relPath, @Nullable String value, int searchType) Returns all Authorizables that have a property with the given relative path (or name) that matches the specified value.
@Nullable Authorizable	getAuthorizable(@NotNull Principal principal) Get the Authorizable by its Principal.
@Nullable Authorizable	getAuthorizable(@NotNull String id) Get the Authorizable by its id.
<T extends Authorizable> T	getAuthorizable(@NotNull String id, @NotNull Class<T> authorizableClass) Get the Authorizable of a specific type by its id.
@Nullable Authorizable	getAuthorizableByPath(@NotNull String path) In accordance to Authorizable.getPath() this method allows to retrieve an given authorizable by it's path.
boolean	isAutoSave() If any write operations executed through the User API are automatically persisted this method returns true.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserManagerDelegator

public UserManagerDelegator(SessionDelegate sessionDelegate,
                            UserManager userManagerDelegate)

Method Detail

getAuthorizable

@Nullable
public @Nullable Authorizable getAuthorizable(@NotNull
                                                        @NotNull String id)
                                                 throws RepositoryException

Description copied from interface: UserManager

Get the Authorizable by its id.

Specified by:

getAuthorizable in interface UserManager

Parameters:

id - The user or group id.

Returns:

Authorizable or null, if not present.

Throws:

RepositoryException - If an error occurs.

See Also:

Authorizable.getID()

getAuthorizable

@Nullable
public <T extends Authorizable> T getAuthorizable(@NotNull
                                                            @NotNull String id,
                                                            @NotNull
                                                            @NotNull Class<T> authorizableClass)
                                                     throws RepositoryException

Description copied from interface: UserManager

Get the Authorizable of a specific type by its id.

Specified by:

getAuthorizable in interface UserManager

Type Parameters:

T - the required Authorizable type.

Parameters:

id - the user or group id.

authorizableClass - the class of the type of Authorizable required; must not be null.

Returns:

Authorizable or null, if not present.

Throws:

AuthorizableTypeException - If an authorizable exists but is not of the requested type.

RepositoryException - If an error occurs

getAuthorizable

@Nullable
public @Nullable Authorizable getAuthorizable(@NotNull
                                                        @NotNull Principal principal)
                                                 throws RepositoryException

Description copied from interface: UserManager

Get the Authorizable by its Principal.

Specified by:

getAuthorizable in interface UserManager

Parameters:

principal - The principal of the authorizable to retrieve.

Returns:

Authorizable or null, if not present.

Throws:

RepositoryException - If an error occurs.

getAuthorizableByPath

@Nullable
public @Nullable Authorizable getAuthorizableByPath(@NotNull
                                                              @NotNull String path)
                                                       throws RepositoryException

Description copied from interface: UserManager

In accordance to Authorizable.getPath() this method allows to retrieve an given authorizable by it's path.

Specified by:

getAuthorizableByPath in interface UserManager

Parameters:

path - The path to an authorizable.

Returns:

Authorizable or null, if not present.

Throws:

UnsupportedRepositoryOperationException - If this implementation does support to retrieve authorizables by path.

RepositoryException - If another error occurs.

See Also:

Authorizable.getPath()

findAuthorizables

@NotNull
public @NotNull Iterator<Authorizable> findAuthorizables(@NotNull
                                                                  @NotNull String relPath,
                                                                  @Nullable
                                                                  @Nullable String value)
                                                           throws RepositoryException

Description copied from interface: UserManager

Returns all Authorizables that have a property with the given relative path (or name) that matches the specified value.

If a relative path with more than one segment is specified only properties exactly matching that patch will be returned. If, however, a name is specified all properties that may be retrieved using Authorizable.getProperty(String) will be searched for a match.

Specified by:

findAuthorizables in interface UserManager

Parameters:

relPath - A relative property path or name.

value - A string value to match.

Returns:

All Authorizables that have a property with the given name exactly matching the given value.

Throws:

RepositoryException - If an error occurs.

See Also:

Authorizable.getProperty(String)

findAuthorizables

@NotNull
public @NotNull Iterator<Authorizable> findAuthorizables(@NotNull
                                                                  @NotNull String relPath,
                                                                  @Nullable
                                                                  @Nullable String value,
                                                                  int searchType)
                                                           throws RepositoryException

Description copied from interface: UserManager

Returns all Authorizables that have a property with the given relative path (or name) that matches the specified value. In contrast to UserManager.findAuthorizables(String, String) the type of authorizable is respected while executing the search.

If a relative path with more than one segment is specified only properties exactly matching that path will be returned. If, however, a name is specified all properties that may be retrieved using Authorizable.getProperty(String) will be searched for a match.

Specified by:

findAuthorizables in interface UserManager

Parameters:

relPath - A relative property path or name.

value - A string value to match.

searchType - Any of the following constants:

• UserManager.SEARCH_TYPE_AUTHORIZABLE
• UserManager.SEARCH_TYPE_GROUP
• UserManager.SEARCH_TYPE_USER

Returns:

An iterator of Authorizable.

Throws:

RepositoryException - If an error occurs.

findAuthorizables

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

Description copied from interface: UserManager

Return Authorizables that match a specific Query.

Specified by:

findAuthorizables in interface UserManager

Parameters:

query - A query

Returns:

Iterator of authorizables witch match the query.

Throws:

RepositoryException - If an error occurs.

createUser

@NotNull
public @NotNull User createUser(@NotNull
                                         @NotNull String userID,
                                         @Nullable
                                         @Nullable String password)
                                  throws AuthorizableExistsException,
                                         RepositoryException

Description copied from interface: UserManager

Creates an User for the given userID / password pair; neither of the specified parameters can be null.
Same as UserManager.createUser(String,String,Principal,String) where the specified userID is equal to the principal name and the intermediate path is null.

Specified by:

createUser in interface UserManager

Parameters:

userID - The ID of the new user.

password - The initial password of this user.

Returns:

The new User.

Throws:

AuthorizableExistsException - in case the given userID is already in use or another Authorizable with the same principal name exists.

RepositoryException - If another error occurs.

createUser

@NotNull
public @NotNull User createUser(@NotNull
                                         @NotNull String userID,
                                         @Nullable
                                         @Nullable String password,
                                         @NotNull
                                         @NotNull Principal principal,
                                         @Nullable
                                         @Nullable String intermediatePath)
                                  throws RepositoryException

Description copied from interface: UserManager

Creates an User for the given parameters. If the implementation is not able to deal with the intermediatePath that parameter should be ignored. Except for the intermediatePath, neither of the specified parameters can be null.

Specified by:

createUser in interface UserManager

Parameters:

userID - The ID of the new user.

password - The initial password of the new user.

principal - The principal of the new user.

intermediatePath - An optional intermediate path used to create the new user. If the intermediate path is null an internal, implementation specific structure will be used.

Returns:

The new User.

Throws:

AuthorizableExistsException - in case the given userID is already in use or another Authorizable with the same principal name exists.

RepositoryException - If the current Session is not allowed to create users or some another error occurs.

createSystemUser

@NotNull
public @NotNull User createSystemUser(@NotNull
                                               @NotNull String userID,
                                               @Nullable
                                               @Nullable String intermediatePath)
                                        throws RepositoryException

Description copied from interface: UserManager

Create a new system user for the specified userID. The new authorizable is required to have the following characteristics:

• User.isSystemUser() returns true.
• The system user doesn't have a password set and doesn't allow change the password.
• The principal name is generated by the system; it may be the same as userID.
• A given implementation may choose to keep system users in a dedicated location and thus may impose restrictions on the intermediatePath.

Specified by:

createSystemUser in interface UserManager

Parameters:

userID - A valid userID.

intermediatePath - An optional intermediate path to create the new system user. The implemenation may decide to reject intermediate paths if they violate an implementation specific requirement with respect to the location where systems users are being held. If the intermediate path is null an internal implementation specific structure will be used.

Returns:

The new system user.

Throws:

AuthorizableExistsException - if an Authorizable with this id already exists.

RepositoryException - If another error occurs.

createGroup

@NotNull
public @NotNull Group createGroup(@NotNull
                                           @NotNull String groupID)
                                    throws RepositoryException

Description copied from interface: UserManager

Creates a Group for the given groupID, which must not be null.
Same as UserManager.createGroup(String, Principal,String) where the specified groupID is the name of the Principal the intermediate path is null.

Specified by:

createGroup in interface UserManager

Parameters:

groupID - The ID of the new group; must not be null.

Returns:

The new Group.

Throws:

AuthorizableExistsException - in case the given groupID is already in use or another Authorizable with the same ID or principal name already exists.

RepositoryException - If another error occurs.

createGroup

@NotNull
public @NotNull Group createGroup(@NotNull
                                           @NotNull Principal principal)
                                    throws RepositoryException

Description copied from interface: UserManager

Creates a new Group that is based on the given principal. Note that the group's ID is implementation specific. The implementation may take the principal name as ID hint but must in any case assert that it is unique among the IDs known to this manager.

Specified by:

createGroup in interface UserManager

Parameters:

principal - A non-null Principal

Returns:

The new Group.

Throws:

AuthorizableExistsException - in case the given principal is already in use with another Authorizable.

RepositoryException - If another error occurs.

createGroup

@NotNull
public @NotNull Group createGroup(@NotNull
                                           @NotNull Principal principal,
                                           @Nullable
                                           @Nullable String intermediatePath)
                                    throws RepositoryException

Description copied from interface: UserManager

Same as UserManager.createGroup(String, Principal, String) where the name of the specified principal is used to create the group's ID.

Specified by:

createGroup in interface UserManager

Parameters:

principal - The principal associated with the new group.

intermediatePath - An optional intermediate path used to create the new group. If the intermediate path is null an internal, implementation specific structure will be used.

Returns:

The new Group.

Throws:

AuthorizableExistsException - in case the given principal is already in use with another Authorizable.

RepositoryException - If another error occurs.

createGroup

@NotNull
public @NotNull Group createGroup(@NotNull
                                           @NotNull String groupID,
                                           @NotNull
                                           @NotNull Principal principal,
                                           @Nullable
                                           @Nullable String intermediatePath)
                                    throws RepositoryException

Description copied from interface: UserManager

Creates a new Group that is based on the given id, principal and the specified intermediatePath hint. If the implementation is not able to deal with the intermediatePath this parameter should be ignored.

Specified by:

createGroup in interface UserManager

Parameters:

groupID - The ID of the new group.

principal - The principal of the new group.

intermediatePath - An optional intermediate path used to create the new group. If the intermediate path is null an internal, implementation specific structure will be used.

Returns:

The new Group.

Throws:

AuthorizableExistsException - in case the given principal is already in use with another Authorizable.

RepositoryException - If another error occurs.

isAutoSave

public boolean isAutoSave()

Description copied from interface: UserManager

If any write operations executed through the User API are automatically persisted this method returns true. In this case there are no pending transient changes left and there is no need to explicitly call Session.save(). If this method returns false any changes must be completed by an extra save call on the Session associated with this UserManager.

Specified by:

isAutoSave in interface UserManager

Returns:

true if changes are automatically persisted; false if changes made through this API (including method calls on Authorizable and subclasses are only transient and must be persisted using Session.save().

See Also:

UserManager.autoSave(boolean)

autoSave

public void autoSave(boolean enable)
              throws RepositoryException

Description copied from interface: UserManager

Changes the auto save behavior of this UserManager.

Note, that this shouldn't be allowed in cases where the associated session is different from the original session accessing the user manager.

Specified by:

autoSave in interface UserManager

Parameters:

enable - If true changes made through this API will be automatically saved; otherwise an explicit call to Session.save() is required in order to persist changes.

Throws:

UnsupportedRepositoryOperationException - If the implementation does not allow to change the auto save behavior.

RepositoryException - If some other error occurs.