Package org.exoplatform.caldav.client

Record Class AccessControlEntry

java.lang.Object
java.lang.Record
org.exoplatform.caldav.client.AccessControlEntry
Record Components:
principal - whom the entry applies to
inverted - whether it applies to everyone except that principal (DAV:invert)
deny - whether it denies rather than grants
privileges - the privileges granted or denied, as Clark names, never empty for a parsed entry
protectedEntry - whether the server marks it DAV:protected: it cannot be changed, and it is never sent back
inheritedFrom - the resource it is inherited from (DAV:inherited), null when it is this collection's own; an inherited entry is never sent back either
public record AccessControlEntry(AccessControlEntry.AcePrincipal principal, boolean inverted, boolean deny, Set<String> privileges, boolean protectedEntry, String inheritedFrom) extends Record
One access control entry of a collection's DAV:acl, as RFC 3744 §5.5 defines it: who it applies to, whether it grants or denies, which privileges, and whether the server lets it be changed (EXO-90253).

The client parses every entry into this shape entirely or not at all (CollectionAcl.understood()): an ACL request replaces every entry that is neither protected nor inherited (§8.1), so an entry this record could not represent would be deleted by writing the list back. The shape is therefore the whole grammar of §5.5 and no less.

Privileges are held as Clark names, {namespace}local — {DAV:}read, {urn:ietf:params:xml:ns:caldav}read-free-busy — so a privilege of any namespace survives the round trip.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final record 
    AccessControlEntry.AcePrincipal
    Whom an entry applies to: one of the six forms RFC 3744 §5.5.1 allows.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CALDAV_NS
    The namespace of CalDAV's elements.
    static final String
    DAV_NS
    The namespace of WebDAV's own elements.
    static final String
    READ
    DAV:read, the one privilege eXo grants.
    static final Set<String>
    READ_ONLY_PRIVILEGES
    The privileges that let a principal see a calendar and nothing more: what "can view" means when an entry is read back.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AccessControlEntry(AccessControlEntry.AcePrincipal principal, boolean inverted, boolean deny, Set<String> privileges, boolean protectedEntry, String inheritedFrom)
    Creates an instance of a AccessControlEntry record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    appliesTo(String canonicalPrincipal)
    Whether this entry names exactly one principal path, compared in the canonical form a recorded principal is held in.
    static String
    clark(String namespace, String localName)
    A Clark name: {namespace}local.
    boolean
    deny()
    Returns the value of the deny record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    grantsRead()
    Whether this entry lets a principal read the calendar: a grant, not inverted, naming DAV:read or DAV:all.
    boolean
    grantsReadOnly()
    Whether this entry is a plain grant carrying nothing beyond seeing the calendar.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    inheritedFrom()
    Returns the value of the inheritedFrom record component.
    boolean
    inverted()
    Returns the value of the inverted record component.
    boolean
    isModifiable()
    Whether an ACL request may carry this entry: neither protected nor inherited (RFC 3744 §8.1 leaves both where they are, and sending one is a conflict the server refuses).
    AccessControlEntry.AcePrincipal
    principal()
    Returns the value of the principal record component.
    static String
    principalHrefOf(String canonicalPrincipal)
    The href a principal path is written as: every segment percent-encoded outside the unreserved set, and a trailing slash, since a principal is a collection.
    Set<String>
    privileges()
    Returns the value of the privileges record component.
    boolean
    protectedEntry()
    Returns the value of the protectedEntry record component.
    static AccessControlEntry
    readGrantTo(String principalHref)
    The entry eXo writes to share a calendar: grant DAV:read to one principal, nothing else.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • DAV_NS

      public static final String DAV_NS
      The namespace of WebDAV's own elements.
      See Also:

    • CALDAV_NS

      public static final String CALDAV_NS
      The namespace of CalDAV's elements.
      See Also:

    • READ

      public static final String READ
      DAV:read, the one privilege eXo grants.

    • READ_ONLY_PRIVILEGES

      public static final Set<String> READ_ONLY_PRIVILEGES
      The privileges that let a principal see a calendar and nothing more: what "can view" means when an entry is read back. DAV:read itself; read-current-user-privilege-set, which Stalwart reports beside it on a read share; and CALDAV:read-free-busy, which RFC 4791 §6.1.1 aggregates under DAV:read.

  • Constructor Details

    • AccessControlEntry

      public AccessControlEntry(AccessControlEntry.AcePrincipal principal, boolean inverted, boolean deny, Set<String> privileges, boolean protectedEntry, String inheritedFrom)
      Creates an instance of a AccessControlEntry record class.
      Parameters:
      principal - the value for the principal record component
      inverted - the value for the inverted record component
      deny - the value for the deny record component
      privileges - the value for the privileges record component
      protectedEntry - the value for the protectedEntry record component
      inheritedFrom - the value for the inheritedFrom record component

  • Method Details

    • readGrantTo

      public static AccessControlEntry readGrantTo(String principalHref)
      The entry eXo writes to share a calendar: grant DAV:read to one principal, nothing else.
      Parameters:
      principalHref - the principal's server-absolute href
      Returns:
      the entry

    • isModifiable

      public boolean isModifiable()
      Whether an ACL request may carry this entry: neither protected nor inherited (RFC 3744 §8.1 leaves both where they are, and sending one is a conflict the server refuses).
      Returns:
      true for an entry of this collection's own that may be rewritten

    • grantsRead

      public boolean grantsRead()
      Whether this entry lets a principal read the calendar: a grant, not inverted, naming DAV:read or DAV:all.
      Returns:
      true when it grants read

    • grantsReadOnly

      public boolean grantsReadOnly()
      Whether this entry is a plain grant carrying nothing beyond seeing the calendar.
      Returns:
      true when every privilege is a read-only one

    • appliesTo

      public boolean appliesTo(String canonicalPrincipal)
      Whether this entry names exactly one principal path, compared in the canonical form a recorded principal is held in.
      Parameters:
      canonicalPrincipal - a principal path, canonical, not null
      Returns:
      true when the entry's principal is an href naming it

    • principalHrefOf

      public static String principalHrefOf(String canonicalPrincipal)
      The href a principal path is written as: every segment percent-encoded outside the unreserved set, and a trailing slash, since a principal is a collection. A canonical path decodes %40 to @; this puts it back, so the server reads the spelling it answers itself.
      Parameters:
      canonicalPrincipal - a server-absolute principal path, decoded, with or without a trailing slash
      Returns:
      the href

    • clark

      public static String clark(String namespace, String localName)
      A Clark name: {namespace}local.
      Parameters:
      namespace - the element's namespace
      localName - the element's local name
      Returns:
      the Clark name

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • principal

      public AccessControlEntry.AcePrincipal principal()
      Returns the value of the principal record component.
      Returns:
      the value of the principal record component

    • inverted

      public boolean inverted()
      Returns the value of the inverted record component.
      Returns:
      the value of the inverted record component

    • deny

      public boolean deny()
      Returns the value of the deny record component.
      Returns:
      the value of the deny record component

    • privileges

      public Set<String> privileges()
      Returns the value of the privileges record component.
      Returns:
      the value of the privileges record component

    • protectedEntry

      public boolean protectedEntry()
      Returns the value of the protectedEntry record component.
      Returns:
      the value of the protectedEntry record component

    • inheritedFrom

      public String inheritedFrom()
      Returns the value of the inheritedFrom record component.
      Returns:
      the value of the inheritedFrom record component