|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.livecycle.rightsmanagement.client.infomodel.InfomodelObjectFactory
public class InfomodelObjectFactory
The InfomodelObjectFactory
class provides methods for creating new objects
that are used with Rights Management service.
These objects are specified in the following list:
EventSearchFilter
objectsLicense
objectsPermission
objectsPolicy
objectsPolicyEntry
objectsValidityPeriod
objectsWatermark
objects
Field Summary | |
---|---|
static int |
ALL_AUTHENTICATED_USERS_PRINCIPAL
Deprecated. This constant is provided only for compatibility with LiveCycle 7.x. Use the All Principals group instead. |
static int |
ALL_EXTERNAL_USERS_PRINCIPAL
Deprecated. This constant is provided only for compatibility with LiveCycle 7.x. |
static int |
ALL_INTERNAL_USERS_PRINCIPAL
Deprecated. This constant is provided only for compatibility with LiveCycle 7.x. |
static int |
ANONYMOUS_PRINCIPAL
Represents the anonymous principal. |
static int |
PUBLISHER_PRINCIPAL
Represents the publisher of the document. |
Method Summary | |
---|---|
static AbstractPolicy |
createAbstractPolicy()
Creates a new AbstractPolicy object that does not contain properties. |
static AbstractPolicyEntry |
createAbstractPolicyEntry()
Creates a new AbstractPolicyEntry object that has no set properties. |
static License |
createLicense(byte[] licenseXml)
Creates a License object from an XML document. |
static Permission |
createPermission(int permission)
Creates a new Permission object. |
static Policy |
createPolicy()
Creates a new Policy object that does not contain properties. |
static Policy |
createPolicy(byte[] policyXml)
Creates a new Policy object from the provided XML document. |
static PolicyEntry |
createPolicyEntry()
Creates a new PolicyEntry object that has no set properties. |
static Principal |
createSpecialPrincipal(int principalType)
Creates a Principal object of the specified type. |
static ValidityPeriod |
createValidityPeriod()
Creates a new ValidityPeriod object that has no properties set. |
static Watermark |
createWatermark()
Creates a new Watermark object that has no properties set. |
static Watermark2 |
createWatermark2()
Creates a new Watermark2 object that has no properties set. |
static Watermark2Element |
createWatermark2Element()
Creates a new Watermark2Element object that has no properties set. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int ANONYMOUS_PRINCIPAL
public static final int ALL_INTERNAL_USERS_PRINCIPAL
public static final int ALL_EXTERNAL_USERS_PRINCIPAL
public static final int ALL_AUTHENTICATED_USERS_PRINCIPAL
public static final int PUBLISHER_PRINCIPAL
Method Detail |
---|
public static License createLicense(byte[] licenseXml) throws PDRLException
License
object from an XML document.
Licenses are implemented as XML documents based on the PDRL schema.
Only LiveCycle ES can create licenses and associate them with documents and policies.
This method is useful if you have the XML representation of a license previously derived from
a License
object that the server created.
You can use this method to convert the
XML license back to a License
object.
For example, the license may have been stored
in an external repository for later retrieval.
licenseXml
- An array of bytes that contains the XML representation of a PDRL license.
License
object.
PDRLException
- if the XML document that licenseXml
represents is not valid.License
public static Policy createPolicy()
Policy
object that does not contain properties.
To see this method used in a code example, see
the Creating a new policy using the Java API quick start in Programming with LiveCycle ES4.
Policy
object.Policy
public static Policy createPolicy(byte[] policyXml) throws PDRLException
Policy
object from the provided XML document.
The XML document must be valid XML based on the XML schema defined by the PDRL schema.
policyXml
- An array of bytes that contains an XML representation of a PDRL policy.
Policy
object.
PDRLException
- if the XML document that licenseXml
represents is not valid.Policy
public static PolicyEntry createPolicyEntry()
PolicyEntry
object that has no set properties.
PolicyEntry
object.PolicyEntry
public static AbstractPolicy createAbstractPolicy()
AbstractPolicy
object that does not contain properties.
To see this method used in a code example, see
the Creating a new abstract policy using the Java API quick start in Programming with LiveCycle ES4.
AbstractPolicy
object.AbstractPolicy
public static AbstractPolicyEntry createAbstractPolicyEntry()
AbstractPolicyEntry
object that has no set properties.
AbstractPolicyEntry
object.AbstractPolicyEntry
public static ValidityPeriod createValidityPeriod()
ValidityPeriod
object that has no properties set.
ValidityPeriod
object.ValidityPeriod
public static Watermark createWatermark() throws PDRLException
Watermark
object that has no properties set.
Watermark
object.
PDRLException
Watermark
public static Watermark2 createWatermark2() throws PDRLException
Watermark2
object that has no properties set.
Watermark2
object.
PDRLException
Watermark2
public static Watermark2Element createWatermark2Element() throws PDRLException
Watermark2Element
object that has no properties set.
Watermark2Element
object.
PDRLException
Watermark2Element
public static Permission createPermission(int permission) throws PDRLException
Permission
object.
To see this method used in a code example, see
the Creating a new policy using the Java API quick start in Programming with LiveCycle ES4.
permission
- An integer value that represents the type of permission to create.
Static members of the Permission
object are passed to this method.
Permission
object.
PDRLException
Permission
public static Principal createSpecialPrincipal(int principalType) throws SDKException
Principal
object of the specified type.
To see this method used in a code example, see
the Creating a new policy using the Java API quick start in Programming with LiveCycle ES4.
principalType
- An integer value that represents the type of principal to create.
The constants that this class defines represent the principal types to use for principalType
.
Principal
object.
SDKException
- if principalType
does not represent a valid principal type.Principal
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |