Package com.adobe.granite.security.user

Class UserPropertiesService

java.lang.Object
com.adobe.granite.security.user.UserPropertiesService
public abstract class UserPropertiesService extends Object
UserPropertiesService...

  • Field Details

    • PREFERENCES_PATH

      public static final String PREFERENCES_PATH
      See Also:

    • PROFILES_ROOT

      public static final String PROFILES_ROOT
      Constant for the profiles root of a given user.
      See Also:

    • PRIVATE_PROFILE

      public static final String PRIVATE_PROFILE
      Constant for the private profile root of a given user.
      See Also:

    • PUBLIC_PROFILE

      public static final String PUBLIC_PROFILE
      Constant for the default public profile root of a given user.
      See Also:

    • DEFAULT_PROFILES

      public static final String[] DEFAULT_PROFILES
      Constant array of the available default user profiles in descending ranking order.

    • PROFILE_RESOURCE_TYPE

      public static final String PROFILE_RESOURCE_TYPE
      Constant for the profile resource type.
      See Also:

    • PROFILE_PATH

      public static final String PROFILE_PATH
      Deprecated.
      use PRIVATE_PROFILE instead.
      Constant for the (previous) private profile of a given user.
      See Also:

    • DEFAULT_NODETYPE

      public static final String DEFAULT_NODETYPE
      See Also:

  • Constructor Details

    • UserPropertiesService

      public UserPropertiesService()

  • Method Details

    • createUserPropertiesManager

      public abstract UserPropertiesManager createUserPropertiesManager(ResourceResolver resolver) throws RepositoryException
      Create a new instance of UserPropertiesManager for the specified resolver.
      Parameters:
      resolver - The associated resource resolver.
      Returns:
      a new instance of UserPropertiesManager.
      Throws:
      RepositoryException - If an error occurs.

    • createUserPropertiesManager

      public abstract UserPropertiesManager createUserPropertiesManager(Session session, ResourceResolver resolver) throws RepositoryException
      Create a new instance of UserPropertiesManager for the specified session and resolver.
      Parameters:
      session - The editing session.
      resolver - The associated resource resolver.
      Returns:
      a new instance of UserPropertiesManager.
      Throws:
      RepositoryException - If an error occurs.

    • getResourceType

      public abstract String getResourceType(String userPropertiesName)
      Retrieve the resource type for the user properties with the specified name. The resource types are part of the service configuration.
      Parameters:
      userPropertiesName - Relative path to the user properties for which the resource type should be returned.
      Returns:
      resource type for the user properties with the specified name or null.

    • getNodeType

      public abstract String getNodeType(String userPropertiesName)
      Retrieve the node type for the user properties with the given name. Note, that the node types are part of the service configuration.
      Parameters:
      userPropertiesName - Relative path to the user properties for which the node type type should be returned.
      Returns:
      node type for the user properties with the specified name or DEFAULT_NODETYPE.

    • getAuthorizablePath

      public abstract String getAuthorizablePath(String authorizableId) throws RepositoryException
      Retrieves the path to the authorizable node that is identified by the specified authorizableId.
      Parameters:
      authorizableId - The ID of the authorizable.
      Returns:
      ?The path of the authorizable or null.
      Throws:
      RepositoryException - If an error occurs.

    • getAuthorizableId

      public abstract String getAuthorizableId(String userPropertiesPath) throws RepositoryException
      Retrieves the authorizableID corresponding to the given absolute path pointing to an user properties node.
      Parameters:
      userPropertiesPath - Absolute path to user properties node.
      Returns:
      The ID of the corresponding authorizable or null.
      Throws:
      RepositoryException - If an error occurs.