Package org.fcrepo.kernel.api.models

Interface ResourceHeaders

public interface ResourceHeaders
Header information for fedora resources.
Author:
bbpennel

  • Field Details

  • Method Details

    • getId

      FedoraId getId()
      Get the identifier for the described resource.
      Returns:
      identifier for the resource.

    • getParent

      FedoraId getParent()
      Get the identifier of the parent of the resource
      Returns:
      identifier of the parent

    • getArchivalGroupId

      FedoraId getArchivalGroupId()
      Get the identifier of the archival group resource that contains this resource, or null if the resource is not an archival part resource
      Returns:
      identifier of the containing archival group resource or null

    • getStateToken

      String getStateToken()
      Get the State Token value for the resource.
      Returns:
      state-token value

    • getInteractionModel

      String getInteractionModel()
      Get the interaction model for the resource
      Returns:
      interaction model URI

    • getMimeType

      String getMimeType()
      Get the mimetype describing the content contained by this resource
      Returns:
      mimetype

    • getFilename

      String getFilename()
      Get the filename for the content of this resource
      Returns:
      filename

    • getContentSize

      long getContentSize()
      Get the size in bytes of the content of this resource. May be -1 if the size is unknown or there is no content.
      Returns:
      size

    • getDigests

      Collection<URI> getDigests()
      Get the list of all digest URIs recorded for this resource
      Returns:
      digest URIs

    • getExternalUrl

      String getExternalUrl()
      Get the url of external content associated with this resource.
      Returns:
      external url

    • getExternalHandling

      String getExternalHandling()
      Get the handling type for external content associated with this resource.
      Returns:
      external handling value

    • getCreatedDate

      Instant getCreatedDate()
      Get the date this resource was created
      Returns:
      created date

    • getCreatedBy

      String getCreatedBy()
      Get the created by for the resource
      Returns:
      created by

    • getLastModifiedDate

      Instant getLastModifiedDate()
      Get the date this resource was last modified
      Returns:
      last modified date

    • getLastModifiedBy

      String getLastModifiedBy()
      Get the last modified by value for the resource
      Returns:
      last modified by

    • getMementoCreatedDate

      Instant getMementoCreatedDate()
      Get the date a memento for this resource was created. This field should generally be kept in sync with the last modified date, but they may not be the same, in the case that a memento was created as a result of an update to a different resource. Additionally, this date is NOT the same as the actual memento timestamp, which is determined by the timestamp on the OCFL version.
      Returns:
      memento created date

    • isArchivalGroup

      boolean isArchivalGroup()
      Determine whether a resource is an Archival Group
      Returns:
      Archival Group status

    • isObjectRoot

      boolean isObjectRoot()
      Determine whether a resource is the object root
      Returns:
      true if the resource is at the root of a persistence object

    • isDeleted

      boolean isDeleted()
      Determine if the resource is now a tombstone.
      Returns:
      Deleted status.

    • getContentPath

      String getContentPath()
      Returns the path to the content file the resource headers are associated with
      Returns:
      path the content file

    • getHeadersVersion

      String getHeadersVersion()
      Returns:
      the header version

    • getStorageRelativePath

      String getStorageRelativePath()
      Returns:
      the content path relative to the OCFL object root