Package org.apache.jackrabbit.webdav.security

Class Privilege

java.lang.Object
org.apache.jackrabbit.webdav.security.Privilege
All Implemented Interfaces:
XmlSerializable
public class Privilege extends Object implements XmlSerializable
Privilege

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Privilege
    PRIVILEGE_ALL
    DAV:all is an aggregate privilege that contains the entire set of privileges that can be applied to the resource.
    static final Privilege
    PRIVILEGE_BIND
    The DAV:bind privilege allows a method to add a new member URL to the specified collection (for example via PUT or MKCOL).
    static final Privilege
    PRIVILEGE_READ
    The read privilege controls methods that return information about the state of the resource, including the resource's properties.
    static final Privilege
    PRIVILEGE_READ_ACL
    The DAV:read-acl privilege controls the use of PROPFIND to retrieve the DAV:acl property of the resource.
    static final Privilege
    PRIVILEGE_READ_CURRENT_USER_PRIVILEGE_SET
    The DAV:read-current-user-privilege-set privilege controls the use of PROPFIND to retrieve the DAV:current-user-privilege-set property of the resource.
    static final Privilege
    PRIVILEGE_UNBIND
    The DAV:unbind privilege allows a method to remove a member URL from the specified collection (for example via DELETE or MOVE).
    static final Privilege
    PRIVILEGE_UNLOCK
    The DAV:unlock privilege controls the use of the UNLOCK method by a principal other than the lock owner (the principal that created a lock can always perform an UNLOCK).
    static final Privilege
    PRIVILEGE_WRITE
    The write privilege controls methods that lock a resource or modify the content, dead properties, or (in the case of a collection) membership of the resource, such as PUT and PROPPATCH.
    static final Privilege
    PRIVILEGE_WRITE_ACL
    The DAV:write-acl privilege controls use of the ACL method to modify the DAV:acl property of the resource.
    static final Privilege
    PRIVILEGE_WRITE_CONTENT
    The DAV:write-content privilege controls methods that modify the content of an existing resource, such as PUT.
    static final Privilege
    PRIVILEGE_WRITE_PROPERTIES
    The DAV:write-properties privilege controls methods that modify the dead properties of the resource, such as PROPPATCH.
    static final String
    XML_PRIVILEGE
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
     
    Namespace
    getNamespace()
     
    static Privilege
    getPrivilege(String privilege, Namespace namespace)
    Factory method to create/retrieve a Privilege.
    static Privilege
    getPrivilege(Element privilege)
    Factory method to create/retrieve a Privilege from the given DAV:privilege element.
    Element
    toXml(Document document)
    Returns the xml representation of the implementing object as Element.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • XML_PRIVILEGE

      public static final String XML_PRIVILEGE
      See Also:

    • PRIVILEGE_READ

      public static final Privilege PRIVILEGE_READ
      The read privilege controls methods that return information about the state of the resource, including the resource's properties. Affected methods include GET and PROPFIND and OPTIONS.
      See Also:

    • PRIVILEGE_WRITE

      public static final Privilege PRIVILEGE_WRITE
      The write privilege controls methods that lock a resource or modify the content, dead properties, or (in the case of a collection) membership of the resource, such as PUT and PROPPATCH.
      See Also:

    • PRIVILEGE_WRITE_PROPERTIES

      public static final Privilege PRIVILEGE_WRITE_PROPERTIES
      The DAV:write-properties privilege controls methods that modify the dead properties of the resource, such as PROPPATCH. Whether this privilege may be used to control access to any live properties is determined by the implementation.
      See Also:

    • PRIVILEGE_WRITE_CONTENT

      public static final Privilege PRIVILEGE_WRITE_CONTENT
      The DAV:write-content privilege controls methods that modify the content of an existing resource, such as PUT.
      See Also:

    • PRIVILEGE_UNLOCK

      public static final Privilege PRIVILEGE_UNLOCK
      The DAV:unlock privilege controls the use of the UNLOCK method by a principal other than the lock owner (the principal that created a lock can always perform an UNLOCK).
      See Also:

    • PRIVILEGE_READ_ACL

      public static final Privilege PRIVILEGE_READ_ACL
      The DAV:read-acl privilege controls the use of PROPFIND to retrieve the DAV:acl property of the resource.
      See Also:

    • PRIVILEGE_READ_CURRENT_USER_PRIVILEGE_SET

      public static final Privilege PRIVILEGE_READ_CURRENT_USER_PRIVILEGE_SET
      The DAV:read-current-user-privilege-set privilege controls the use of PROPFIND to retrieve the DAV:current-user-privilege-set property of the resource.
      See Also:

    • PRIVILEGE_WRITE_ACL

      public static final Privilege PRIVILEGE_WRITE_ACL
      The DAV:write-acl privilege controls use of the ACL method to modify the DAV:acl property of the resource.
      See Also:

    • PRIVILEGE_BIND

      public static final Privilege PRIVILEGE_BIND
      The DAV:bind privilege allows a method to add a new member URL to the specified collection (for example via PUT or MKCOL). It is ignored for resources that are not collections.
      See Also:

    • PRIVILEGE_UNBIND

      public static final Privilege PRIVILEGE_UNBIND
      The DAV:unbind privilege allows a method to remove a member URL from the specified collection (for example via DELETE or MOVE). It is ignored for resources that are not collections.
      See Also:

    • PRIVILEGE_ALL

      public static final Privilege PRIVILEGE_ALL
      DAV:all is an aggregate privilege that contains the entire set of privileges that can be applied to the resource.
      See Also:

  • Method Details

    • getName

      public String getName()
      Returns:
      The local name of this Privilege.

    • getNamespace

      public Namespace getNamespace()
      Returns:
      The namespace of this Privilege.

    • toXml

      public Element toXml(Document document)
      Description copied from interface: XmlSerializable
      Returns the xml representation of the implementing object as Element. The given Document is used as factory and represents the owner document of the returned DOM element.
      Specified by:
      toXml in interface XmlSerializable
      Parameters:
      document - to be used as factory.
      Returns:
      a w3c element representing this object
      See Also:

    • getPrivilege

      public static Privilege getPrivilege(String privilege, Namespace namespace)
      Factory method to create/retrieve a Privilege.
      Parameters:
      privilege -
      namespace -
      Returns:

    • getPrivilege

      public static Privilege getPrivilege(Element privilege) throws DavException
      Factory method to create/retrieve a Privilege from the given DAV:privilege element.
      Parameters:
      privilege -
      Returns:
      Throws:
      DavException