Quick Start (SOAP mode): Protect a PDF in Statement Workflow for a new User, using the Java API

The following Java code example demonstrates how you can protect a document in Statement Workflow. This is a two-step process:

  • A new User, License and Policy are created.

  • The User is associated with the License and Policy, and the document is Protected.

 * This Java Quick Start uses the SOAP mode and contains the following JAR files 
 * in the class path: 
 * 1. adobe-rightsmanagement-client.jar 
 * 2. namespace.jar (if LiveCycle server is deployed on JBoss) 
 * 3. jaxb-api.jar (if LiveCycle server is deployed on JBoss) 
 * 4. jaxb-impl.jar (if LiveCycle server is deployed on JBoss) 
 * 5. jaxb-libs.jar (if LiveCycle server is deployed on JBoss) 
 * 6. jaxb-xjc.jar (if LiveCycle server is deployed on JBoss) 
 * 7. relaxngDatatype.jar (if LiveCycle server is deployed on JBoss) 
 * 8. xsdlib.jar (if LiveCycle server is deployed on JBoss) 
 * 9. adobe-livecycle-client.jar 
 * 10. adobe-usermanager-client.jar 
 * 11. adobe-utilities.jar 
 * 12. jbossall-client.jar (use a different JAR file if LiveCycle server is not deployed on JBoss) 
 * 13. activation.jar (required for SOAP mode) 
 * 14. axis.jar (required for SOAP mode) 
 * 15. commons-codec-1.3.jar (required for SOAP mode) 
 * 16.  commons-collections-3.1.jar  (required for SOAP mode) 
 * 17. commons-discovery.jar (required for SOAP mode) 
 * 18. commons-logging.jar (required for SOAP mode) 
 * 19. dom3-xml-apis-2.5.0.jar (required for SOAP mode) 
 * 20. jaxen-1.1-beta-9.jar (required for SOAP mode) 
 * 21. jaxrpc.jar (required for SOAP mode) 
 * 22. log4j.jar (required for SOAP mode) 
 * 23. mail.jar (required for SOAP mode) 
 * 24. saaj.jar (required for SOAP mode) 
 * 25. wsdl4j.jar (required for SOAP mode) 
 * 26. xalan.jar (required for SOAP mode) 
 * 27. xbean.jar (required for SOAP mode) 
 * 28. xercesImpl.jar (required for SOAP mode) 
 *  These JAR files are located in the following path: 
 * <install directory>/Adobe/Adobe LiveCycle ES4/sdk/client-libs/common 
 * The adobe-utilities.jar file is located in the following path: 
 * <install directory>/Adobe/Adobe LiveCycle ES4/sdk/client-libs/jboss 
 * The jbossall-client.jar file is located in the following path: 
 * <install directory>/Adobe/Adobe LiveCycle ES4/jboss/client 
 * SOAP required JAR files are located in the following path: 
 * <install directory>/Adobe/Adobe LiveCycle ES4/sdk/client-libs/thirdparty 
 * If you want to invoke a remote LiveCycle server instance and there is a 
 * firewall between the client application and LiveCycle server, then it is 
 * recommended that you use the SOAP mode. When using the SOAP mode, 
 * you have to include these additional JAR files 
 * For information about the SOAP 
 * mode, see "Setting connection properties" in Programming 
 * with LiveCycle server 
import java.util.*; 
import java.io.File; 
import java.io.FileInputStream; 
import com.adobe.idp.Document; 
import com.adobe.idp.dsc.clientsdk.ServiceClientFactory; 
import com.adobe.idp.dsc.clientsdk.ServiceClientFactoryProperties; 
import com.adobe.livecycle.rightsmanagement.client.*; 
import com.adobe.livecycle.rightsmanagement.RMSecureDocumentResult; 
import com.adobe.idp.um.api.infomodel.PrincipalSearchFilter; 
import com.adobe.idp.um.api.infomodel.PrincipalReference; 
import com.adobe.livecycle.usermanager.client.DirectoryManagerServiceClient; 
import com.adobe.edc.common.dto.PublishLicenseDTO; 
import com.adobe.idp.um.api.infomodel.User; 
import com.adobe.idp.um.api.impl.UMBaseLibrary; 
public class protectStatementWorkFlowSoap { 
    public static void main(String args[]) { 
            //Set connection properties required to invoke LiveCycle server using SOAP mode                                
            Properties connectionProps = new Properties(); 
            connectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_SOAP_ENDPOINT, "http://localhost:8080"); 
            connectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "Jboss"); 
            connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator"); 
            connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password"); 
            //Create a ServiceClientFactory instance 
            ServiceClientFactory factory = ServiceClientFactory.createInstance(connectionProps); 
            //Create a RightsManagementClient object 
            RightsManagementClient rightsClient = new RightsManagementClient(factory); 
            DirectoryManagerServiceClient directoryManagerServiceClient = new DirectoryManagerServiceClient(factory); 
            DocumentManager documentManager = rightsClient.getDocumentManager(); 
            AbstractPolicyManager abstractPolicyManager = rightsClient.getAbstractPolicyManager(); 
            //Reference a PDF document to which a policy is applied 
            FileInputStream is = new FileInputStream("C:\\Adobe\\Sample.pdf"); 
            Document inPDF = new Document(is); 
            //Create user 
            String userName = "wblue";        
            User user = UMBaseLibrary.createUser(userName, "DefaultDom", userName); 
            directoryManagerServiceClient.createLocalUser(user, "password");     
            //Ensure that the user was added 
            //Create a PrincipalSearchFilter to find the user by ID 
            List userList = new ArrayList<PrincipalReference>(); 
            PrincipalSearchFilter psf = new PrincipalSearchFilter(); 
            List p = directoryManagerServiceClient.findPrincipalReferences(psf); 
            PrincipalReference principal = (PrincipalReference)(p.get(0)); 
            //Create Policy From AbstractPolicy "test2" 
            String newPolicyId = abstractPolicyManager.createPolicyFromAbstractPolicy("Global Policy Set", "PolicyFromAbstractPolicy_AllowCopy","Global Policy Set", "AllowCopy", userList); 
            System.out.println("Created policy from abstract policy: " + newPolicyId); 
            //Create License for the Policy 
            PublishLicenseDTO publishLicense = documentManager.createLicense(newPolicyId, user.getUserid(), "DefaultDom"); 
            //get the license id from license object 
            String licID = publishLicense.getLicenseId(); 
            //Associate User with License and Policy 
            documentManager.associateUserWithLicenseAndPolicy("DefaultDom", user.getUserid(), licID, newPolicyId); 
            //protect the PDF document using license 
            RMSecureDocumentResult rmSecureDocument = documentManager.protectDocument(inPDF, publishLicense); 
            //Retrieve the policy-protected PDF document 
            Document protectedDocument = rmSecureDocument.protectedDoc; 
            //Save the policy-protected PDF document 
            String outputFile = "C:\\Adobe\\PolicyProtected"+ user.getUserid()+".pdf"; 
            File myFile = new File(outputFile); 
            System.out.println("Protected the PDF With policy"); 
        }catch(Exception ex){ 

// Ethnio survey code removed