Package org.apache.sling.testing.mock.jcr

Class MockUserManager

java.lang.Object

org.apache.sling.testing.mock.jcr.MockUserManager

All Implemented Interfaces:

org.apache.jackrabbit.api.security.user.UserManager

public class MockUserManager
extends Object
implements org.apache.jackrabbit.api.security.user.UserManager

Mock UserManager implementation.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,org.apache.jackrabbit.api.security.user.Authorizable>	authorizables
protected javax.jcr.Session	session

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

SEARCH_TYPE_AUTHORIZABLE, SEARCH_TYPE_GROUP, SEARCH_TYPE_USER

Constructor Summary

Constructors

Constructor	Description
MockUserManager()	Deprecated. use MockUserManager(Session) instead
MockUserManager(javax.jcr.Session session)

Method Summary

Modifier and Type	Method	Description
void	autoSave(boolean autoSave)
@NotNull org.apache.jackrabbit.api.security.user.Group	createGroup(@NotNull String groupID)
@NotNull org.apache.jackrabbit.api.security.user.Group	createGroup(@NotNull String groupID, @NotNull Principal principal, @Nullable String intermediatePath)
@NotNull org.apache.jackrabbit.api.security.user.Group	createGroup(@NotNull Principal principal)
@NotNull org.apache.jackrabbit.api.security.user.Group	createGroup(@NotNull Principal principal, @Nullable String intermediatePath)
@NotNull org.apache.jackrabbit.api.security.user.User	createSystemUser(@NotNull String userID, @Nullable String intermediatePath)
@NotNull org.apache.jackrabbit.api.security.user.User	createUser(@NotNull String userID, @Nullable String password)
@NotNull org.apache.jackrabbit.api.security.user.User	createUser(@NotNull String userID, @Nullable String password, @NotNull Principal principal, @Nullable String intermediatePath)
protected javax.jcr.Node	ensureAuthorizablePathExists(@NotNull String intermediatePath, @NotNull String principalName, @NotNull String authorizableNodeType)	Creates the user/group home folder if they don't exist yet
protected javax.jcr.Node	ensureAuthorizablePathExists(@Nullable String intermediatePath, @NotNull String principalName, boolean isGroup)	Deprecated, for removal: This API element is subject to removal in a future version. use ensureAuthorizablePathExists(String, String, String) instead
@NotNull Iterator<org.apache.jackrabbit.api.security.user.Authorizable>	findAuthorizables(@NotNull String relPath, @Nullable String value)
@NotNull Iterator<org.apache.jackrabbit.api.security.user.Authorizable>	findAuthorizables(@NotNull String relPath, @Nullable String value, int searchType)
@NotNull Iterator<org.apache.jackrabbit.api.security.user.Authorizable>	findAuthorizables(@NotNull org.apache.jackrabbit.api.security.user.Query query)
@Nullable org.apache.jackrabbit.api.security.user.Authorizable	getAuthorizable(@NotNull String id)
<T extends org.apache.jackrabbit.api.security.user.Authorizable> T	getAuthorizable(@NotNull String id, @NotNull Class<T> authorizableClass)
@Nullable org.apache.jackrabbit.api.security.user.Authorizable	getAuthorizable(@NotNull Principal principal)
@Nullable org.apache.jackrabbit.api.security.user.Authorizable	getAuthorizableByPath(@NotNull String path)
boolean	isAutoSave()
protected @Nullable String	toPrincipalName(@Nullable String id, @Nullable Principal principal)	Calculates the principal name, preferring the supplied id or fallback to the Principal.getName() value

Methods inherited from class java.lang.Object

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

Field Detail

session

protected javax.jcr.Session session

authorizables

protected Map<String,org.apache.jackrabbit.api.security.user.Authorizable> authorizables

Constructor Detail

MockUserManager

@Deprecated
public MockUserManager()

Deprecated.

use MockUserManager(Session) instead

MockUserManager

public MockUserManager(javax.jcr.Session session)

Parameters:

session - the jcr session where the people state is stored

Method Detail

isAutoSave

public boolean isAutoSave()

Specified by:

isAutoSave in interface org.apache.jackrabbit.api.security.user.UserManager

autoSave

public void autoSave(boolean autoSave)
              throws javax.jcr.RepositoryException

Specified by:

autoSave in interface org.apache.jackrabbit.api.security.user.UserManager

Throws:

javax.jcr.RepositoryException

createGroup

@NotNull
public @NotNull org.apache.jackrabbit.api.security.user.Group createGroup(@NotNull
                                                                          @NotNull String groupID)
                                                                   throws javax.jcr.RepositoryException

Specified by:

createGroup in interface org.apache.jackrabbit.api.security.user.UserManager

Throws:

javax.jcr.RepositoryException

createGroup

@NotNull
public @NotNull org.apache.jackrabbit.api.security.user.Group createGroup(@NotNull
                                                                          @NotNull Principal principal)
                                                                   throws javax.jcr.RepositoryException

Specified by:

createGroup in interface org.apache.jackrabbit.api.security.user.UserManager

Throws:

javax.jcr.RepositoryException

createGroup

@NotNull
public @NotNull org.apache.jackrabbit.api.security.user.Group createGroup(@NotNull
                                                                          @NotNull Principal principal,
                                                                          @Nullable
                                                                          @Nullable String intermediatePath)
                                                                   throws javax.jcr.RepositoryException

Specified by:

createGroup in interface org.apache.jackrabbit.api.security.user.UserManager

Throws:

javax.jcr.RepositoryException

createGroup

@NotNull
public @NotNull org.apache.jackrabbit.api.security.user.Group createGroup(@NotNull
                                                                          @NotNull String groupID,
                                                                          @NotNull
                                                                          @NotNull Principal principal,
                                                                          @Nullable
                                                                          @Nullable String intermediatePath)
                                                                   throws javax.jcr.RepositoryException

Specified by:

createGroup in interface org.apache.jackrabbit.api.security.user.UserManager

Throws:

javax.jcr.RepositoryException

toPrincipalName

@Nullable
protected @Nullable String toPrincipalName(@Nullable
                                           @Nullable String id,
                                           @Nullable
                                           @Nullable Principal principal)

Calculates the principal name, preferring the supplied id or fallback to the Principal.getName() value

Parameters:

id - the user or group id

principal - the principal

Returns:

the principal name

ensureAuthorizablePathExists

@Deprecated(forRemoval=true,
            since="1.4.0")
protected javax.jcr.Node ensureAuthorizablePathExists(@Nullable
                                                      @Nullable String intermediatePath,
                                                      @NotNull
                                                      @NotNull String principalName,
                                                      boolean isGroup)
                                               throws javax.jcr.RepositoryException

Deprecated, for removal: This API element is subject to removal in a future version.

use ensureAuthorizablePathExists(String, String, String) instead

Creates the user/group home folder if they don't exist yet

Parameters:

intermediatePath - the parent path

principalName - Principal name

isGroup - Is group

Returns:

Existing or created node

Throws:

javax.jcr.RepositoryException - Repository exception

ensureAuthorizablePathExists

protected javax.jcr.Node ensureAuthorizablePathExists(@NotNull
                                                      @NotNull String intermediatePath,
                                                      @NotNull
                                                      @NotNull String principalName,
                                                      @NotNull
                                                      @NotNull String authorizableNodeType)
                                               throws javax.jcr.RepositoryException

Creates the user/group home folder if they don't exist yet

Parameters:

intermediatePath - the parent path

principalName - Principal name

authorizableNodeType - the node type for the user or group node

Returns:

Existing or created node

Throws:

javax.jcr.RepositoryException - Repository exception

createSystemUser

@NotNull
public @NotNull org.apache.jackrabbit.api.security.user.User createSystemUser(@NotNull
                                                                              @NotNull String userID,
                                                                              @Nullable
                                                                              @Nullable String intermediatePath)
                                                                       throws javax.jcr.RepositoryException

Specified by:

createSystemUser in interface org.apache.jackrabbit.api.security.user.UserManager

Throws:

javax.jcr.RepositoryException

createUser

@NotNull
public @NotNull org.apache.jackrabbit.api.security.user.User createUser(@NotNull
                                                                        @NotNull String userID,
                                                                        @Nullable
                                                                        @Nullable String password)
                                                                 throws javax.jcr.RepositoryException

Specified by:

createUser in interface org.apache.jackrabbit.api.security.user.UserManager

Throws:

javax.jcr.RepositoryException

createUser

@NotNull
public @NotNull org.apache.jackrabbit.api.security.user.User createUser(@NotNull
                                                                        @NotNull String userID,
                                                                        @Nullable
                                                                        @Nullable String password,
                                                                        @NotNull
                                                                        @NotNull Principal principal,
                                                                        @Nullable
                                                                        @Nullable String intermediatePath)
                                                                 throws javax.jcr.RepositoryException

Specified by:

createUser in interface org.apache.jackrabbit.api.security.user.UserManager

Throws:

javax.jcr.RepositoryException

findAuthorizables

@NotNull
public @NotNull Iterator<org.apache.jackrabbit.api.security.user.Authorizable> findAuthorizables(@NotNull
                                                                                                 @NotNull org.apache.jackrabbit.api.security.user.Query query)
                                                                                          throws javax.jcr.RepositoryException

Specified by:

findAuthorizables in interface org.apache.jackrabbit.api.security.user.UserManager

Throws:

javax.jcr.RepositoryException

findAuthorizables

@NotNull
public @NotNull Iterator<org.apache.jackrabbit.api.security.user.Authorizable> findAuthorizables(@NotNull
                                                                                                 @NotNull String relPath,
                                                                                                 @Nullable
                                                                                                 @Nullable String value)
                                                                                          throws javax.jcr.RepositoryException

Specified by:

findAuthorizables in interface org.apache.jackrabbit.api.security.user.UserManager

Throws:

javax.jcr.RepositoryException

findAuthorizables

@NotNull
public @NotNull Iterator<org.apache.jackrabbit.api.security.user.Authorizable> findAuthorizables(@NotNull
                                                                                                 @NotNull String relPath,
                                                                                                 @Nullable
                                                                                                 @Nullable String value,
                                                                                                 int searchType)
                                                                                          throws javax.jcr.RepositoryException

Specified by:

findAuthorizables in interface org.apache.jackrabbit.api.security.user.UserManager

Throws:

javax.jcr.RepositoryException

getAuthorizable

@Nullable
public @Nullable org.apache.jackrabbit.api.security.user.Authorizable getAuthorizable(@NotNull
                                                                                      @NotNull String id)
                                                                               throws javax.jcr.RepositoryException

Specified by:

getAuthorizable in interface org.apache.jackrabbit.api.security.user.UserManager

Throws:

javax.jcr.RepositoryException

getAuthorizable

@Nullable
public @Nullable org.apache.jackrabbit.api.security.user.Authorizable getAuthorizable(@NotNull
                                                                                      @NotNull Principal principal)
                                                                               throws javax.jcr.RepositoryException

Specified by:

getAuthorizable in interface org.apache.jackrabbit.api.security.user.UserManager

Throws:

javax.jcr.RepositoryException

getAuthorizable

@Nullable
public <T extends org.apache.jackrabbit.api.security.user.Authorizable> T getAuthorizable(@NotNull
                                                                                          @NotNull String id,
                                                                                          @NotNull
                                                                                          @NotNull Class<T> authorizableClass)
                                                                                   throws javax.jcr.RepositoryException

Specified by:

getAuthorizable in interface org.apache.jackrabbit.api.security.user.UserManager

Throws:

javax.jcr.RepositoryException

getAuthorizableByPath

@Nullable
public @Nullable org.apache.jackrabbit.api.security.user.Authorizable getAuthorizableByPath(@NotNull
                                                                                            @NotNull String path)
                                                                                     throws javax.jcr.RepositoryException

Specified by:

getAuthorizableByPath in interface org.apache.jackrabbit.api.security.user.UserManager

Throws:

javax.jcr.RepositoryException