com.adobe.livecycle.rightsmanagement.client.infomodel
Class InfomodelObjectFactory

java.lang.Object
  extended by com.adobe.livecycle.rightsmanagement.client.infomodel.InfomodelObjectFactory

public class InfomodelObjectFactory
extends java.lang.Object

The InfomodelObjectFactory class provides methods for creating new objects that are used with Rights Management service. These objects are specified in the following list:


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

ANONYMOUS_PRINCIPAL

public static final int ANONYMOUS_PRINCIPAL
Represents the anonymous principal. Policies that provide permissions to the anonymous principal enable any user to open the documents secured with that policy without being authenticated.

See Also:
Constant Field Values

ALL_INTERNAL_USERS_PRINCIPAL

public static final int ALL_INTERNAL_USERS_PRINCIPAL
Deprecated. This constant is provided only for compatibility with LiveCycle 7.x.
Represents all internal users.

See Also:
Constant Field Values

ALL_EXTERNAL_USERS_PRINCIPAL

public static final int ALL_EXTERNAL_USERS_PRINCIPAL
Deprecated. This constant is provided only for compatibility with LiveCycle 7.x.
Represents all external users.

See Also:
Constant Field Values

ALL_AUTHENTICATED_USERS_PRINCIPAL

public static final int ALL_AUTHENTICATED_USERS_PRINCIPAL
Deprecated. This constant is provided only for compatibility with LiveCycle 7.x. Use the All Principals group instead.
Represents all users who can authenticate against the server, which includes all internal and external users.

See Also:
Constant Field Values

PUBLISHER_PRINCIPAL

public static final int PUBLISHER_PRINCIPAL
Represents the publisher of the document. If a policy includes the Publisher principal, then the user who secures a document with the policy is granted the Publisher permissions for that document.

See Also:
Constant Field Values
Method Detail

createLicense

public static License createLicense(byte[] licenseXml)
                             throws PDRLException
Creates a 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.

Parameters:
licenseXml - An array of bytes that contains the XML representation of a PDRL license.
Returns:
A License object.
Throws:
PDRLException - if the XML document that licenseXml represents is not valid.
See Also:
License

createPolicy

public static Policy createPolicy()
Creates a new 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.

Returns:
A new Policy object.
See Also:
Policy

createPolicy

public static Policy createPolicy(byte[] policyXml)
                           throws PDRLException
Creates a new Policy object from the provided XML document. The XML document must be valid XML based on the XML schema defined by the PDRL schema.

Parameters:
policyXml - An array of bytes that contains an XML representation of a PDRL policy.
Returns:
A Policy object.
Throws:
PDRLException - if the XML document that licenseXml represents is not valid.
See Also:
Policy

createPolicyEntry

public static PolicyEntry createPolicyEntry()
Creates a new PolicyEntry object that has no set properties.

Returns:
A new PolicyEntry object.
See Also:
PolicyEntry

createAbstractPolicy

public static AbstractPolicy createAbstractPolicy()
Creates a new 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.

Returns:
A new AbstractPolicy object.
See Also:
AbstractPolicy

createAbstractPolicyEntry

public static AbstractPolicyEntry createAbstractPolicyEntry()
Creates a new AbstractPolicyEntry object that has no set properties.

Returns:
A new AbstractPolicyEntry object.
See Also:
AbstractPolicyEntry

createValidityPeriod

public static ValidityPeriod createValidityPeriod()
Creates a new ValidityPeriod object that has no properties set.

Returns:
A new ValidityPeriod object.
See Also:
ValidityPeriod

createWatermark

public static Watermark createWatermark()
                                 throws PDRLException
Creates a new Watermark object that has no properties set.

Returns:
A new Watermark object.
Throws:
PDRLException
See Also:
Watermark

createWatermark2

public static Watermark2 createWatermark2()
                                   throws PDRLException
Creates a new Watermark2 object that has no properties set.

Returns:
A new Watermark2 object.
Throws:
PDRLException
See Also:
Watermark2

createWatermark2Element

public static Watermark2Element createWatermark2Element()
                                                 throws PDRLException
Creates a new Watermark2Element object that has no properties set.

Returns:
A new Watermark2Element object.
Throws:
PDRLException
See Also:
Watermark2Element

createPermission

public static Permission createPermission(int permission)
                                   throws PDRLException
Creates a new 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.

Parameters:
permission - An integer value that represents the type of permission to create. Static members of the Permission object are passed to this method.
Returns:
A new Permission object.
Throws:
PDRLException
See Also:
Permission

createSpecialPrincipal

public static Principal createSpecialPrincipal(int principalType)
                                        throws SDKException
Creates a 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.

Parameters:
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.
Returns:
A Principal object.
Throws:
SDKException - if principalType does not represent a valid principal type.
See Also:
Principal


[an error occurred while processing this directive] [an error occurred while processing this directive]