Creating Policies

When creating a policy using the web service API, reference an existing Portable Document Rights Language (PDRL) XML file that describes the policy. Policy permissions and the principal are defined in the PDRL document. The following XML document is an example of a PDRL document.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> 
<Policy PolicyInstanceVersion="1" PolicyID="5DA3F847-DE76-F9CC-63EA-49A8D59154DE" PolicyCreationTime="2004-08-30T00:02:28.294+00:00" PolicyType="1" PolicySchemaVersion="1.0" PolicyName="SDK Test Policy -4344050357301573237" PolicyDescription="An SDK Test policy" xmlns="http://www.adobe.com/schema/1.0/pdrl"> 
      <PolicyEntry> 
         <ns1:Permission PermissionName="com.adobe.aps.onlineOpen" Access="ALLOW" xmlns:ns1="http://www.adobe.com/schema/1.0/pdrl" xmlns="http://www.adobe.com/schema/1.0/pdrl-ex" /> 
 
         <ns2:Permission PermissionName="com.adobe.aps.offlineOpen" Access="ALLOW" xmlns:ns2="http://www.adobe.com/schema/1.0/pdrl" xmlns="http://www.adobe.com/schema/1.0/pdrl-ex" /> 
 
         <ns3:Permission PermissionName="com.adobe.aps.pdf.editNotes" Access="ALLOW" xmlns:ns3="http://www.adobe.com/schema/1.0/pdrl" xmlns="http://www.adobe.com/schema/1.0/pdrl-ex" /> 
 
         <ns4:Permission PermissionName="com.adobe.aps.pdf.fillAndSign" Access="ALLOW" xmlns:ns4="http://www.adobe.com/schema/1.0/pdrl" xmlns="http://www.adobe.com/schema/1.0/pdrl-ex" /> 
 
         <Principal PrincipalNameType="SYSTEM"> 
            <PrincipalDomain>EDC_SPECIAL</PrincipalDomain> 
 
            <PrincipalName>all_internal_users</PrincipalName> 
         </Principal> 
      </PolicyEntry> 
 
      <PolicyEntry> 
         <ns5:Permission PermissionName="com.adobe.aps.onlineOpen" Access="ALLOW" xmlns:ns5="http://www.adobe.com/schema/1.0/pdrl" xmlns="http://www.adobe.com/schema/1.0/pdrl-ex" /> 
 
         <ns6:Permission PermissionName="com.adobe.aps.offlineOpen" Access="ALLOW" xmlns:ns6="http://www.adobe.com/schema/1.0/pdrl" xmlns="http://www.adobe.com/schema/1.0/pdrl-ex" /> 
 
         <ns7:Permission PermissionName="com.adobe.aps.pdf.copy" Access="ALLOW" xmlns:ns7="http://www.adobe.com/schema/1.0/pdrl" xmlns="http://www.adobe.com/schema/1.0/pdrl-ex" /> 
 
         <ns8:Permission PermissionName="com.adobe.aps.pdf.printLow" Access="ALLOW" xmlns="http://www.adobe.com/schema/1.0/pdrl-ex" xmlns:ns8="http://www.adobe.com/schema/1.0/pdrl" /> 
 
         <ns9:Permission PermissionName="com.adobe.aps.policySwitch" Access="ALLOW" xmlns:ns9="http://www.adobe.com/schema/1.0/pdrl" xmlns="http://www.adobe.com/schema/1.0/pdrl-ex" /> 
 
         <ns10:Permission PermissionName="com.adobe.aps.revoke" Access="ALLOW" xmlns="http://www.adobe.com/schema/1.0/pdrl-ex" xmlns:ns10="http://www.adobe.com/schema/1.0/pdrl" /> 
 
         <ns11:Permission PermissionName="com.adobe.aps.pdf.edit" Access="ALLOW" xmlns:ns11="http://www.adobe.com/schema/1.0/pdrl" xmlns="http://www.adobe.com/schema/1.0/pdrl-ex" /> 
 
         <ns12:Permission PermissionName="com.adobe.aps.pdf.editNotes" Access="ALLOW" xmlns:ns12="http://www.adobe.com/schema/1.0/pdrl" xmlns="http://www.adobe.com/schema/1.0/pdrl-ex" /> 
 
         <ns13:Permission PermissionName="com.adobe.aps.pdf.fillAndSign" Access="ALLOW" xmlns:ns13="http://www.adobe.com/schema/1.0/pdrl" xmlns="http://www.adobe.com/schema/1.0/pdrl-ex" /> 
 
         <ns14:Permission PermissionName="com.adobe.aps.pdf.printHigh" Access="ALLOW" xmlns:ns14="http://www.adobe.com/schema/1.0/pdrl" xmlns="http://www.adobe.com/schema/1.0/pdrl-ex" /> 
 
         <Principal PrincipalNameType="SYSTEM"> 
            <PrincipalDomain>EDC_SPECIAL</PrincipalDomain> 
 
            <PrincipalName>publisher</PrincipalName> 
         </Principal> 
      </PolicyEntry> 
 
      <OfflineLeasePeriod> 
         <Duration>P31D</Duration> 
      </OfflineLeasePeriod> 
 
      <AuditSettings isTracked="true" /> 
 
      <PolicyValidityPeriod isAbsoluteTime="false"> 
         <ValidityPeriodRelative> 
            <NotBeforeRelative>PT0S</NotBeforeRelative> 
 
            <NotAfterRelative>P20D</NotAfterRelative> 
         </ValidityPeriodRelative> 
      </PolicyValidityPeriod> 
</Policy> 

To create a policy, perform the following steps:

1. Include project files.

2. Create a Rights Management Client API object.

3. Set the policy’s attributes.

4. Create a policy entry.

5. Register the policy.

Create a policy by using the Rights Management API (Java):

1. Include project files.

   Include client JAR files, such as adobe-rightsmanagement-client.jar, in your Java project’s class path.

2. Create a Rights Management Client API object.

   • Create a ServiceClientFactory object that contains connection properties.

   • Create a RightsManagementClient object by using its constructor and passing the ServiceClientFactory object.

3. Set the policy’s attributes.

   • Create a Policy object by invoking the InfomodelObjectFactory object’s static createPolicy method. This method returns a Policy object.

   • Set the policy’s name attribute by invoking the Policy object’s setName method and passing a string value that specifies the policy name.

   • Set the policy’s description by invoking the Policy object’s setDescription method and passing a string value that specifies the policy’s description.

   • Set the policy set to which the new policy belongs by invoking the Policy object’s setPolicySetName method and passing a string value that specifies the policy set name. (You can specify null for this parameter value that results in the policy being added to the My Policies policy set.)

   • Create the policy’s validity period by invoking the InfomodelObjectFactory object’s static createValidityPeriod method. This method returns a ValidityPeriod object.

   • Set the number of days for which a policy-protected document is accessible by invoking the ValidityPeriod object’s setRelativeExpirationDays method and passing an integer value that specifies the number of days.

   • Set the policy’s validity period by invoking the Policy object’s setValidityPeriod method and passing the ValidityPeriod object.

4. Create a policy entry.

   • Create a policy entry by invoking the InfomodelObjectFactory object’s static createPolicyEntry method. This method returns a PolicyEntry object.

   • Specify the policy’s permissions by invoking the InfomodelObjectFactory object’s static createPermission method. Pass a static data member that belongs to the Permission interface that represents the permission. This method returns a Permission object. For example, to add the permission that enables users to copy data from a policy-protected PDF document, pass Permission.COPY . (Repeat this step for each permission to add).

   • Add the permission to the policy entry by invoking the PolicyEntry object’s addPermission method and passing the Permission object. (Repeat this step for each Permission object that you created).

   • Create the policy principal by invoking the InfomodelObjectFactory object’s static createSpecialPrincipal method. Pass a data member that belongs to the InfomodelObjectFactory object that represents the principal. This method returns a Principal object. For example, to add the publisher of the document as the principal, pass InfomodelObjectFactory.PUBLISHER_PRINCIPAL .

   • Add the principal to the policy entry by invoking the PolicyEntry object’s setPrincipal method and passing the Principal object.

   • Add the policy entry to the policy by invoking the Policy object’s addPolicyEntry method and passing the PolicyEntry object.

5. Register the policy.

   • Create a PolicyManager object by invoking the RightsManagementClient object’s getPolicyManager method.

   • Register the policy by invoking the PolicyManager object’s registerPolicy method and passing the following values:

     • The Policy object that represents the policy to register.

   • A string value that represents the policy set that the policy belongs to.

   If you use a AEM forms administrator account within connection settings to create the RightsManagementClient object, then specify the policy set name when you invoke the registerPolicy method. If you pass a null value for the policy set, the policy is created in the administrators My Policies policy set.

   If you use a Rights Management user within connection settings, then you can invoke the overloaded registerPolicy method that accepts only the policy. That is, you do not need to specify the policy set name. However, the policy is added to the policy set named My Policies . If you do not want to add the new policy to this policy set, then specify a policy set name when you invoke the registerPolicy method.

   Note: When creating a policy, reference an existing policy set. If you specify a policy set that does not exist, then an exception is thrown.

For code examples using the Rights Management service, see the following Quick Starts in API Quick Starts (Code Examples) :

• “Quick Start (EJB mode): Creating a policy using the Java API”

• “Quick Start (SOAP mode): Creating a policy using the Java API”

Create a policy by using the Rights Management API (web service):

1. Include project files.

   Create a Microsoft .NET project that uses MTOM. Ensure that you use the following WSDL definition: http://localhost:8080/soap/services/RightsManagementService?WSDL&lc_version=9.0.1 .

   Note: Replace localhost with the IP address of the server hosting LiveCycle.

2. Create a Rights Management Client API object.

   • Create a RightsManagementServiceClient object by using its default constructor.

   • Create a RightsManagementServiceClient.Endpoint.Address object by using the System.ServiceModel.EndpointAddress constructor. Pass a string value that specifies the WSDL to the LiveCycle service (for example, http://localhost:8080/soap/services/RightsManagementService?WSDL .) You do not need to use the lc_version attribute. This attribute is used when you create a service reference.)

   • Create a System.ServiceModel.BasicHttpBinding object by getting the value of the RightsManagementServiceClient.Endpoint.Binding field. Cast the return value to BasicHttpBinding .

   • Set the System.ServiceModel.BasicHttpBinding object’s MessageEncoding field to WSMessageEncoding.Mtom . This value ensures that MTOM is used.

   • Enable basic HTTP authentication by performing the following tasks:

     • Assign the AEM forms user name to the field RightsManagementServiceClient.ClientCredentials.UserName.UserName .

     • Assign the corresponding password value to the field RightsManagementServiceClient.ClientCredentials.UserName.Password .

     • Assign the constant value HttpClientCredentialType.Basic to the field BasicHttpBindingSecurity.Transport.ClientCredentialType .

   • Assign the constant value BasicHttpSecurityMode.TransportCredentialOnly to the field BasicHttpBindingSecurity.Security.Mode .

3. Set the policy’s attributes.

   • Create a PolicySpec object by using its constructor.

   • Set the policy’s name by assigning a string value to the PolicySpec object’s name data member.

   • Set the policy’s description by assigning a string value to the PolicySpec object’s description data member.

   • Set the policy set to which the policy will belong by assigning a string value to the PolicySpec object’s policySetName data member. You must specify an existing policy set name. (You can specify null for this parameter value that results in the policy being added to My Policies .)

   • Set the policy’s offline lease period by assigning an integer value to the PolicySpec object’s offlineLeasePeriod data member.

   • Set the PolicySpec object’s policyXml data member with a string value that represents PDRL XML data. To perform this task, create a .NET StreamReader object by using its constructor. Pass the location of a PDRL XML file that represents the policy to the StreamReader constructor. Next, invoke the StreamReader object’s ReadLine method and assign the return value to a string variable. Iterate through the StreamReader object until the ReadLine method returns null. Assign the string variable to the PolicySpec object’s policyXml data member.

4. Create a policy entry.

   It is not necessary to create a policy entry when creating a policy using the Rights Management web service API. The policy entry is defined in the PDRL document.

5. Register the policy.

   Register the policy by invoking the RightsManagementServiceClient object’s registerPolicy method and passing the following values:

   • The PolicySpec object that represents the policy to register.

   • A string value that represents the policy set that the policy belongs to. You can specify a null value which results in the policy being added to the MyPolices policy set.

   If you use a AEM forms administrator account within connection settings to create the RightsManagementClient object, specify the policy set name when you invoke the registerPolicy method.

   If you use a Rights Management user within connection settings, then you can invoke the overloaded registerPolicy method that accepts only the policy. That is, you do not need to specify the policy set name. However, the policy is added to the policy set named My Policies . If you do not want to add the new policy to this policy set, then specify a policy set name when you invoke the registerPolicy method.

   Note: When creating a policy and you specify a policy set, ensure that you specify an existing policy set. If you specify a policy set that does not exist, then an exception is thrown.

For code examples using the Rights Management service, see the following Quick Starts in API Quick Starts (Code Examples) :

• “Quick Start (MTOM): Creating a policy using the web service API”

• “Quick Start (SwaRef): Creating a policy using the web service API”