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:
    Adaptable

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PROPERTY_DESCRIPTION
      Deprecated.
      no longer stored in the authorizable properties but only in the profile
      static java.lang.String PROPERTY_EMAIL
      Deprecated.
      no longer stored in the authorizable properties but only in the profile
      static java.lang.String PROPERTY_FIRST_NAME
      Deprecated.
      no longer stored in the authorizable properties but only in the profile
      static java.lang.String PROPERTY_ID
      Deprecated.
      UserID is not stored as separate property any more.
      static java.lang.String PROPERTY_IMPERSONATORS
      Deprecated.
      Constant PROPERTY_IMPERSONATORS="rep:impersonators"
      static java.lang.String PROPERTY_LAST_NAME
      Deprecated.
      no longer stored in the authorizable properties but only in the profile
      static java.lang.String PROPERTY_NAME
      Deprecated.
      no longer stored in the authorizable properties but only in the profile
      static java.lang.String PROPERTY_PASSWORD
      Deprecated.
      Constant PROPERTY_PASSWORD="rep:password"
      static java.lang.String PROPERTY_PRINCIPAL
      Deprecated.
      Constant PROPERTY_PRINCIPAL="rep:principalName"

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getHomePath()
      Deprecated.
      getHomePath.
      java.lang.String getID()
      Deprecated.
      The ID is a unique identifier within the UserManager this User has been acquired from.
      The following must be true:
      java.lang.String getName()
      Deprecated.
      A human readable Name.
      java.security.Principal getPrincipal()
      Deprecated.
      getPrincipal.
      Privilege getPrivilege​(java.lang.String privilege)
      Deprecated.
      CQ 5.5
      java.util.Collection<Privilege> getPrivileges()
      Deprecated.
      CQ 5.5
      Profile getProfile()
      Deprecated.
      Default profile for this Authorizable
      java.lang.String getProperty​(java.lang.String name)
      Deprecated.
      Retrieve the property value with the given name.
      java.util.Iterator<java.lang.String> getPropertyNames()
      Deprecated.
      Returns the names of properties present with this Authorizable.
      void grantPrivilege​(java.lang.String privilege)
      Deprecated.
      CQ 5.5
      boolean hasPermission​(java.lang.String privilege)
      Deprecated.
      CQ 5.5
      boolean hasPermissionOn​(java.lang.String privilege, java.lang.String resourcePath)
      Deprecated.
      CQ 5.5
      boolean isUser()
      Deprecated.
      If an Authorizable is a User according this test-method a cast to User Class MUST be possible.
      java.util.Iterator<Group> memberOf()
      Deprecated.
      The Groups a Authorizable is member of.
      Transitive membership is not resolved.
      void remove()
      Deprecated.
      delete this Authorizable
      boolean removeProperty​(java.lang.String name)
      Deprecated.
      Removes the property with the given name.
      void revokePrivilege​(java.lang.String privilege)
      Deprecated.
      CQ 5.5
      void setProperty​(java.lang.String name, java.lang.String value)
      Deprecated.
      Set an arbitrary property to this Authorizable.

    • Field Detail

      • PROPERTY_PRINCIPAL

        static final java.lang.String PROPERTY_PRINCIPAL
        Deprecated.
        Constant PROPERTY_PRINCIPAL="rep:principalName"
        See Also:
        Constant Field Values

      • PROPERTY_ID

        @Deprecated
static final java.lang.String PROPERTY_ID
        Deprecated.
        UserID is not stored as separate property any more.
        See Also:
        Constant Field Values

      • PROPERTY_PASSWORD

        static final java.lang.String PROPERTY_PASSWORD
        Deprecated.
        Constant PROPERTY_PASSWORD="rep:password"
        See Also:
        Constant Field Values

      • PROPERTY_IMPERSONATORS

        static final java.lang.String PROPERTY_IMPERSONATORS
        Deprecated.
        Constant PROPERTY_IMPERSONATORS="rep:impersonators"
        See Also:
        Constant Field Values

      • PROPERTY_NAME

        @Deprecated
static final java.lang.String PROPERTY_NAME
        Deprecated.
        no longer stored in the authorizable properties but only in the profile
        See Also:
        Constant Field Values

      • PROPERTY_DESCRIPTION

        @Deprecated
static final java.lang.String PROPERTY_DESCRIPTION
        Deprecated.
        no longer stored in the authorizable properties but only in the profile
        See Also:
        Constant Field Values

      • PROPERTY_EMAIL

        @Deprecated
static final java.lang.String PROPERTY_EMAIL
        Deprecated.
        no longer stored in the authorizable properties but only in the profile
        See Also:
        Constant Field Values

      • PROPERTY_FIRST_NAME

        @Deprecated
static final java.lang.String PROPERTY_FIRST_NAME
        Deprecated.
        no longer stored in the authorizable properties but only in the profile
        See Also:
        Constant Field Values

      • PROPERTY_LAST_NAME

        @Deprecated
static final java.lang.String PROPERTY_LAST_NAME
        Deprecated.
        no longer stored in the authorizable properties but only in the profile
        See Also:
        Constant Field Values

    • Method Detail

      • 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:
        User

      • getID

        java.lang.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:
        UserManager.get(String)

      • getName

        java.lang.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

        java.security.Principal getPrincipal()
        Deprecated.

        getPrincipal.

        Returns:
        this Authorizable holds, if authenticated

      • getPropertyNames

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

      • getProperty

        java.lang.String getProperty​(java.lang.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​(java.lang.String name,
                 java.lang.String value)
          throws javax.jcr.AccessDeniedException
        Deprecated.
        Set an arbitrary property to this Authorizable.
        Parameters:
        name - name of the Property to set
        value - to set
        Throws:
        javax.jcr.AccessDeniedException - the editing session isn't allowed to write.

      • removeProperty

        boolean removeProperty​(java.lang.String name)
                throws javax.jcr.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:
        javax.jcr.AccessDeniedException - the editing session isn't allowed to write.

      • memberOf

        java.util.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

        java.lang.String getHomePath()
        Deprecated.

        getHomePath.

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

      • hasPermission

        boolean hasPermission​(java.lang.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:
        grantPrivilege(String)

      • getPrivilege

        Privilege getPrivilege​(java.lang.String privilege)
                throws javax.jcr.AccessDeniedException
        Deprecated.
        CQ 5.5

        getPrivilege.

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

      • grantPrivilege

        void grantPrivilege​(java.lang.String privilege)
             throws javax.jcr.AccessDeniedException
        Deprecated.
        CQ 5.5

        grantPrivilege.

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

      • revokePrivilege

        void revokePrivilege​(java.lang.String privilege)
              throws javax.jcr.AccessDeniedException
        Deprecated.
        CQ 5.5

        revokePrivilege.

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

      • getPrivileges

        java.util.Collection<Privilege> getPrivileges()
                                       throws javax.jcr.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:
        javax.jcr.AccessDeniedException - in case the session that acquired this authorizable is not allowed read Privileges

      • remove

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