Interface SharedEntity


  • public interface SharedEntity
    Entities implementing this support access control as implemented by the access utilities.

    The owner href (ownerHref), encoded acl (access) and parent path must be persisted.

    isCollection is usually derived.

    path may be persisted or derived.

    accessState is a transient object allowing us to calculate the access and possibly cache that calculation.

    Version:
    1.0
    Author:
    Mike Douglass
    • Method Detail

      • setOwnerHref

        void setOwnerHref​(String val)
        Href of owner
        Parameters:
        val -
      • getOwnerHref

        String getOwnerHref()
        Href of owner
        Returns:
        String
      • setAccess

        void setAccess​(String val)
        Encoded acl
        Parameters:
        val -
      • getAccess

        String getAccess()
        Encoded acl
        Returns:
        String
      • setParentPath

        void setParentPath​(String val)
        Access is inherited from the parent
        Parameters:
        val -
      • getParentPath

        String getParentPath()
        Access is inherited from the parent
        Returns:
        parentPath.
      • getPath

        String getPath()
        Returns:
        the full path of this entity (parentPath + "/" + name)
      • isCollection

        boolean isCollection()
        We only try to preserve access state in collections. There will be many more entity objects (events, cards etc) than collections. In addition, most entity objects don't have specific access set on them so the access is essentially the parent collection access.
        Returns:
        boolean true for this entity being a collection
      • setAccessState

        void setAccessState​(AccessState val)
        Set the access state
        Parameters:
        val -
      • getAccessState

        AccessState getAccessState()
        Returns:
        current AccessState object or null