Package org.apache.jempbox.xmp
Class XMPSchemaRightsManagement
java.lang.Object
org.apache.jempbox.xmp.XMPSchema
org.apache.jempbox.xmp.XMPSchemaRightsManagement
Define XMP properties that are related to rights management.
- Version:
- $Revision: 1.6 $
- Author:
- Ben Litchfield
-
Field Summary
FieldsFields inherited from class org.apache.jempbox.xmp.XMPSchema
NS_NAMESPACE, prefix, schema
-
Constructor Summary
ConstructorsConstructorDescriptionXMPSchemaRightsManagement
(XMPMetadata parent) Construct a new blank PDF schema.XMPSchemaRightsManagement
(Element element, String prefix) Constructor from existing XML element. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add an owner to the list.Get the URL of the rights managment certificate.Get the copyright information.Get the flag that indicates if this is a marked resource..Get the complete list of legal owners.Get the default usage terms for the document.getUsageTerms
(String language) Get the usage terms in a specific language.Get a list of all languages that a usage term exists for.Get the URL that describes the terms of this resource.void
removeOwner
(String owner) Remove an owner from the list.void
setCertificateURL
(String certificate) The online rights management certificate.void
setCopyright
(String copyright) Set the copyright information.void
setDescription
(String language, String terms) Set the usage terms of this resource in a specific language.void
Flag indicating if this is a rights managed resource.void
setUsageTerms
(String terms) Set the default usage terms for this resource.void
setWebStatement
(String webStatement) Set the external link that describes the owners/rights of this resource.Methods inherited from class org.apache.jempbox.xmp.XMPSchema
addBagValue, addSequenceDateValue, addSequenceValue, addSequenceValue, getAbout, getBagList, getBooleanProperty, getDateProperty, getElement, getEventSequenceList, getIntegerProperty, getLanguageProperty, getLanguagePropertyLanguages, getSequenceDateList, getSequenceList, getTextProperty, getThumbnailProperty, merge, removeBagValue, removeSequenceDateValue, removeSequenceValue, removeSequenceValue, setAbout, setBooleanProperty, setDateProperty, setIntegerProperty, setLanguageProperty, setTextProperty, setThumbnailProperty
-
Field Details
-
NAMESPACE
The namespace for this schema.- See Also:
-
-
Constructor Details
-
XMPSchemaRightsManagement
Construct a new blank PDF schema.- Parameters:
parent
- The parent metadata schema that this will be part of.
-
XMPSchemaRightsManagement
Constructor from existing XML element.- Parameters:
element
- The existing element.prefix
- The schema prefix.
-
-
Method Details
-
setCertificateURL
The online rights management certificate.- Parameters:
certificate
- The URL to the rights cert.
-
getCertificateURL
Get the URL of the rights managment certificate.- Returns:
- The rights management certificate URL.
-
setMarked
Flag indicating if this is a rights managed resource.- Parameters:
marked
- The marked value.
-
getMarked
Get the flag that indicates if this is a marked resource..- Returns:
- The value of the marked flag.
-
removeOwner
Remove an owner from the list.- Parameters:
owner
- The owner to remove.
-
addOwner
Add an owner to the list.- Parameters:
owner
- A new legal owner to this resource.
-
getOwners
Get the complete list of legal owners.- Returns:
- The list of owners.
-
setUsageTerms
Set the default usage terms for this resource.- Parameters:
terms
- The resource usage terms.
-
getUsageTerms
Get the default usage terms for the document.- Returns:
- The terms for this resource.
-
setDescription
Set the usage terms of this resource in a specific language.- Parameters:
language
- The language code.terms
- The terms of this resource.
-
getUsageTerms
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
Get a list of all languages that a usage term exists for.- Returns:
- A non-null list of languages, potentially an empty list.
-
setWebStatement
Set the external link that describes the owners/rights of this resource.- Parameters:
webStatement
- The URL to a terms site.
-
getWebStatement
Get the URL that describes the terms of this resource.- Returns:
- The usage rights URL.
-
setCopyright
Set the copyright information.- Parameters:
copyright
- The copyright information.
-
getCopyright
Get the copyright information.- Returns:
- The copyright information.
-