Package com.adobe.granite.security.user

Interface UserManagementService

@ProviderType
public interface UserManagementService

Service interface for common user management related tasks and utility methods.

Method Summary

Modifier and Type	Method	Description
String	getAdminId()
String	getAnonymousId()
String	getAuthorizableRootPath()
String	getEveryoneName()
String	getGroupRootPath()
String	getSystemUserRootPath()
String	getUserInternalId(Session session)	Retrieve the user identifier of currently logged in user for eg:- jcr:uuid of logged in user
UserManager	getUserManager(Session session)	Retrieve the UserManager associated with the given session.
String	getUserRootPath()

Method Detail

getUserManager

@Nonnull
UserManager getUserManager(@Nonnull
                           Session session)
                    throws UnsupportedOperationException,
                           RepositoryException

Retrieve the UserManager associated with the given session. This method is a shortcut for calling JackrabbitSession.getUserManager().

Parameters:

session - The editing session.

Returns:

The UserManager associated with the given session.

Throws:

UnsupportedOperationException - If the specified session is not an JackrabbitSession.

RepositoryException - If an error occurs or if the JCR repository doesn't support user managent.

getAuthorizableRootPath

@Nonnull
String getAuthorizableRootPath()

Returns:

the path of the common ancestor node for all users and groups.

getUserRootPath

@Nonnull
String getUserRootPath()

Returns:

the configured path of the user root node.

getGroupRootPath

@Nonnull
String getGroupRootPath()

Returns:

the configured path of the group root node.

getSystemUserRootPath

@Nonnull
String getSystemUserRootPath()

Returns:

the configured path of the system users root node.

getAnonymousId

@Nonnull
String getAnonymousId()

Returns:

The user ID of the anonymous (guest) user.

getUserInternalId

@Nonnull
String getUserInternalId(@Nonnull
                         Session session)
                  throws UnsupportedOperationException,
                         RepositoryException

Retrieve the user identifier of currently logged in user for eg:- jcr:uuid of logged in user

Parameters:

session - The current user session

Returns:

The user id(uuid) associated with user

Throws:

UnsupportedOperationException - If the specified session is not an JackrabbitSession or if Authorizable is not of User type.

RepositoryException - If an error occurs or user id doesnt exist or if the JCR repository doesn't support user management.

getAdminId

@Nonnull
String getAdminId()

Returns:

The user ID of the administrative user.

getEveryoneName

@Nonnull
String getEveryoneName()

Returns:

The name of the built-in everyone principal.