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
@NotNull java.lang.String	getAdminId()
@NotNull java.lang.String	getAnonymousId()
@NotNull java.lang.String	getAuthorizableRootPath()
@NotNull java.lang.String	getEveryoneName()
@NotNull java.lang.String	getGroupRootPath()
@NotNull java.lang.String	getSystemUserRootPath()
@NotNull UserManager	getUserManager(@NotNull javax.jcr.Session session)	Retrieve the UserManager associated with the given session.
@NotNull java.lang.String	getUserRootPath()

Method Detail

getUserManager

@NotNull
@NotNull UserManager getUserManager(@NotNull
                                    @NotNull javax.jcr.Session session)
                             throws java.lang.UnsupportedOperationException,
                                    javax.jcr.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:

java.lang.UnsupportedOperationException - If the specified session is not an JackrabbitSession.

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

getAuthorizableRootPath

@NotNull
@NotNull java.lang.String getAuthorizableRootPath()

Returns:

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

getUserRootPath

@NotNull
@NotNull java.lang.String getUserRootPath()

Returns:

the configured path of the user root node.

getGroupRootPath

@NotNull
@NotNull java.lang.String getGroupRootPath()

Returns:

the configured path of the group root node.

getSystemUserRootPath

@NotNull
@NotNull java.lang.String getSystemUserRootPath()

Returns:

the configured path of the system users root node.

getAnonymousId

@NotNull
@NotNull java.lang.String getAnonymousId()

Returns:

The user ID of the anonymous (guest) user.

getAdminId

@NotNull
@NotNull java.lang.String getAdminId()

Returns:

The user ID of the administrative user.

getEveryoneName

@NotNull
@NotNull java.lang.String getEveryoneName()

Returns:

The name of the built-in everyone principal.