com.adobe.livecycle.rightsmanagement.client.infomodel
Interface License

All Superinterfaces:
java.lang.Cloneable

public interface License
extends java.lang.Cloneable

The License interface provides methods for retrieving information about licenses and the XML representation of licenses. License objects represent licenses that the Rights Management service creates and stores in the database. Only the Rights Management service can create licenses. Licenses are implemented as XML documents according to the PDRL schema. You can use LicenseManager to modify license properties.

To see this interface used in a code example, see the Revoking a document using the Java API quick start in Programming with Adobe Experience Manager Forms.


Field Summary
static int DOCUMENT_REVISED
          Indicates that a document was revoked because the document was revised.
static int DOCUMENT_TERMINATED
          Indicates that a document was revoked because the document was terminated.
static int GENERAL_MESSAGE
          Indicates a general reason that a document was revoked.
 
Method Summary
 java.lang.String getAlternateId()
          Retrieves the alternate identification of the license.
 java.lang.String getDocumentName()
          Retrieves the name of the document associated with the license.
 java.lang.String getId()
          Retrieves the unique identification of the license.
 int getInstanceVersion()
          Retrieves the version of the license.
 java.util.Date getIssueDate()
          Retrieves the date when the Rights Management service issued the license.
 java.lang.String getIssuingAuthority()
          Retrieves the URL of the host server that created the license.
 java.lang.String getPolicyId()
          Retrieves the identification of the policy that the license is associated with.
 Principal getPublisher()
          Retrieves the user who secured the document that the license is associated with.
 int getRevocationReason()
          Retrieves the reason that the license was revoked.
 java.lang.String getRevocationUrl()
          Retrieves the URL provided for the revoked license.
 java.lang.String getSchemaVersion()
          Retrieves the version of the PDRL schema for the license.
 boolean isRevoked()
          Retrieves the revocation state of the license.
 byte[] toXml()
          Creates an XML representation of the license.
 

Field Detail

DOCUMENT_REVISED

static final int DOCUMENT_REVISED
Indicates that a document was revoked because the document was revised.

See Also:
Constant Field Values

DOCUMENT_TERMINATED

static final int DOCUMENT_TERMINATED
Indicates that a document was revoked because the document was terminated.

See Also:
Constant Field Values

GENERAL_MESSAGE

static final int GENERAL_MESSAGE
Indicates a general reason that a document was revoked.

See Also:
Constant Field Values
Method Detail

getSchemaVersion

java.lang.String getSchemaVersion()
Retrieves the version of the PDRL schema for the license.

Returns:
A java.lang.String that holds the version of the PDRL schema.

getInstanceVersion

int getInstanceVersion()
Retrieves the version of the license. The license version is set to 1 when the license is created and is incremented by 1 each time the license is modified.

Returns:
A java.lang.String that holds the version of the license.

getPolicyId

java.lang.String getPolicyId()
Retrieves the identification of the policy that the license is associated with.

Returns:
A java.lang.String that holds the identification of the policy.
See Also:
Policy

getIssuingAuthority

java.lang.String getIssuingAuthority()
Retrieves the URL of the host server that created the license.

Returns:
A java.lang.String that holds the URL of the server.

getId

java.lang.String getId()
Retrieves the unique identification of the license.

Returns:
A java.lang.String that holds the identification of the license.

getIssueDate

java.util.Date getIssueDate()
Retrieves the date when the Rights Management service issued the license.

Returns:
A java.util.Date object that contains the issue date of the license.

getPublisher

Principal getPublisher()
Retrieves the user who secured the document that the license is associated with.

Returns:
A Principal object that represents the person who published the associated document.

toXml

byte[] toXml()
             throws PDRLException
Creates an XML representation of the license.

Returns:
An array of bytes that holds the XML representation of the license.
Throws:
PDRLException

getDocumentName

java.lang.String getDocumentName()
Retrieves the name of the document associated with the license.

Returns:
A string value that specifies the name of the document.

isRevoked

boolean isRevoked()
Retrieves the revocation state of the license.

Returns:
true if the license is revoked, false if the license is not revoked.

getRevocationReason

int getRevocationReason()
Retrieves the reason that the license was revoked.

Returns:
An integer that holds the constant that indicates the revocation reason and zero if the license is not revoked.
See Also:
License.DOCUMENT_REVISED, License.DOCUMENT_TERMINATED, License.GENERAL_MESSAGE

getRevocationUrl

java.lang.String getRevocationUrl()
Retrieves the URL provided for the revoked license.

Returns:
A java.lang.String that holds the URL provided for the revoked license and null if no URL was provided.
See Also:
LicenseManager.revokeLicense(java.lang.String, int, java.net.URL)

getAlternateId

java.lang.String getAlternateId()
Retrieves the alternate identification of the license.

Returns:
A java.lang.String that holds the the alternate identification of the license and null if no alternate identification is set.