Class XMPSchemaRightsManagement

java.lang.Object
org.apache.jempbox.xmp.XMPSchema
org.apache.jempbox.xmp.XMPSchemaRightsManagement

public class XMPSchemaRightsManagement extends XMPSchema
Define XMP properties that are related to rights management.
Version:
$Revision: 1.6 $
Author:
Ben Litchfield
  • Field Details

  • Constructor Details

    • XMPSchemaRightsManagement

      public XMPSchemaRightsManagement(XMPMetadata parent)
      Construct a new blank PDF schema.
      Parameters:
      parent - The parent metadata schema that this will be part of.
    • XMPSchemaRightsManagement

      public XMPSchemaRightsManagement(Element element, String prefix)
      Constructor from existing XML element.
      Parameters:
      element - The existing element.
      prefix - The schema prefix.
  • Method Details

    • setCertificateURL

      public void setCertificateURL(String certificate)
      The online rights management certificate.
      Parameters:
      certificate - The URL to the rights cert.
    • getCertificateURL

      public String getCertificateURL()
      Get the URL of the rights managment certificate.
      Returns:
      The rights management certificate URL.
    • setMarked

      public void setMarked(Boolean marked)
      Flag indicating if this is a rights managed resource.
      Parameters:
      marked - The marked value.
    • getMarked

      public Boolean getMarked()
      Get the flag that indicates if this is a marked resource..
      Returns:
      The value of the marked flag.
    • removeOwner

      public void removeOwner(String owner)
      Remove an owner from the list.
      Parameters:
      owner - The owner to remove.
    • addOwner

      public void addOwner(String owner)
      Add an owner to the list.
      Parameters:
      owner - A new legal owner to this resource.
    • getOwners

      public List<String> getOwners()
      Get the complete list of legal owners.
      Returns:
      The list of owners.
    • setUsageTerms

      public void setUsageTerms(String terms)
      Set the default usage terms for this resource.
      Parameters:
      terms - The resource usage terms.
    • getUsageTerms

      public String getUsageTerms()
      Get the default usage terms for the document.
      Returns:
      The terms for this resource.
    • setDescription

      public void setDescription(String language, String terms)
      Set the usage terms of this resource in a specific language.
      Parameters:
      language - The language code.
      terms - The terms of this resource.
    • getUsageTerms

      public String getUsageTerms(String language)
      Get the usage terms in a specific language.
      Parameters:
      language - The language code to get the description for.
      Returns:
      The usage terms in the specified language or null if it does not exist.
    • getUsageTermsLanguages

      public List<String> getUsageTermsLanguages()
      Get a list of all languages that a usage term exists for.
      Returns:
      A non-null list of languages, potentially an empty list.
    • setWebStatement

      public void setWebStatement(String webStatement)
      Set the external link that describes the owners/rights of this resource.
      Parameters:
      webStatement - The URL to a terms site.
    • getWebStatement

      public String getWebStatement()
      Get the URL that describes the terms of this resource.
      Returns:
      The usage rights URL.
    • setCopyright

      public void setCopyright(String copyright)
      Set the copyright information.
      Parameters:
      copyright - The copyright information.
    • getCopyright

      public String getCopyright()
      Get the copyright information.
      Returns:
      The copyright information.