Package com.day.cq.security

Interface Authorizable

All Superinterfaces:
Adaptable
All Known Subinterfaces:
Group, User
public interface Authorizable extends Adaptable
Deprecated.
cq 5.5 Use org.apache.jackrabbit.api.security.user.Authorizable instead.
Base Class for Objects which act on the Repository. This can be Users, eg. the authenticated subject, or Groups of Users. The Authorizable is related to a Session via the User-ID.
Allow to adapt the Authorizable to Other resources like its Home, Preferences etc.
See Also:

  • Field Details

  • Method Details

    • isUser

      boolean isUser()
      Deprecated.
      If an Authorizable is a User according this test-method a cast to User Class MUST be possible.
      Returns:
      true if the Authorizable is a User
      See Also:

    • getID

      String getID()
      Deprecated.
      The ID is a unique identifier within the UserManager this User has been acquired from.
      The following must be true: 
        String id = "userId"
  User u = userManger.get(id);
  u.extractID().equals(id);
      Returns:
      the ID of this User.
      See Also:

    • getName

      String getName()
      Deprecated.
      A human readable Name. E.g. Implementations may return the full name of a User
      Returns:
      full name of this authorizable

    • getPrincipal

      Principal getPrincipal()
      Deprecated.

      getPrincipal.

      Returns:
      this Authorizable holds, if authenticated

    • getPropertyNames

      Iterator<String> getPropertyNames()
      Deprecated.
      Returns the names of properties present with this Authorizable.
      Returns:
      names of properties.
      See Also:

    • getProperty

      String getProperty(String name)
      Deprecated.
      Retrieve the property value with the given name.
      Parameters:
      name - of the Property
      Returns:
      Property or nullif property does not exist or does not have a value

    • setProperty

      void setProperty(String name, String value) throws AccessDeniedException
      Deprecated.
      Set an arbitrary property to this Authorizable.
      Parameters:
      name - name of the Property to set
      value - to set
      Throws:
      AccessDeniedException - the editing session isn't allowed to write.

    • removeProperty

      boolean removeProperty(String name) throws AccessDeniedException
      Deprecated.
      Removes the property with the given name.
      Parameters:
      name - of the Property to remove
      Returns:
      true If the property with the specified name was successfully removed; false if no such property was present.
      Throws:
      AccessDeniedException - the editing session isn't allowed to write.

    • memberOf

      Iterator<Group> memberOf()
      Deprecated.
      The Groups a Authorizable is member of.
      Transitive membership is not resolved. Thus the following is true: if Authorizable A is member of Group G g.members() contains A.
      Returns:
      Iterator containing all Groups the Authorizable is direct member of

    • getHomePath

      String getHomePath()
      Deprecated.

      getHomePath.

      Returns:
      an absolute Path, this User may use as Home-Directory

    • hasPermission

      boolean hasPermission(String privilege)
      Deprecated.
      CQ 5.5

      hasPermission.

      Parameters:
      privilege - identifier of the privilege (eg. workflow/privilege/start)
      Returns:
      true if the privilege is set. false if not or if Privilege.isPathDependent() privilege is pathDependant}
      See Also:

    • hasPermissionOn

      boolean hasPermissionOn(String privilege, String resourcePath)
      Deprecated.
      CQ 5.5

      hasPermissionOn.

      Parameters:
      privilege - identifier of the privilege (eg. workflow/privilege/start)
      resourcePath - path of the resource
      Returns:
      true if the privilege is set. if Privilege.isPathDependent() privilege is pathDependant}. it has additionaly to grant on the given resource-path
      See Also:

    • getPrivilege

      Privilege getPrivilege(String privilege) throws AccessDeniedException
      Deprecated.
      CQ 5.5

      getPrivilege.

      Parameters:
      privilege - identifier of the privilege (eg. workflow/privilege/start)
      Returns:
      Privilege or null if none set
      Throws:
      AccessDeniedException - in case the session that acquired this authorizable is not allowed read Privileges
      See Also:

    • grantPrivilege

      void grantPrivilege(String privilege) throws AccessDeniedException
      Deprecated.
      CQ 5.5

      grantPrivilege.

      Parameters:
      privilege - identifier to grant the current Authorizable
      Throws:
      AccessDeniedException - in case the session that acquired this authorizable is not allowed grant Privileges

    • revokePrivilege

      void revokePrivilege(String privilege) throws AccessDeniedException
      Deprecated.
      CQ 5.5

      revokePrivilege.

      Parameters:
      privilege - identifier of the privilege to remove from this Authorizable
      Throws:
      AccessDeniedException - in case the session that acquired this authorizable is not allowed revoke Privileges

    • getPrivileges

      Collection<Privilege> getPrivileges() throws AccessDeniedException
      Deprecated.
      CQ 5.5

      getPrivileges.

      Returns:
      collection of Privileges granted the current Authorizable this includes only the privileges granted explicitly and not those granted by group-membership.
      Throws:
      AccessDeniedException - in case the session that acquired this authorizable is not allowed read Privileges

    • getProfile

      Profile getProfile()
      Deprecated.
      Default profile for this Authorizable
      Returns:
      or null if there is no Profile for this Authorizable
      See Also:

    • remove

      void remove() throws AccessDeniedException
      Deprecated.
      delete this Authorizable
      Throws:
      AccessDeniedException - in case the session that acquired this authorizable is not allowed to remove this