Encryption Service Javaā¢ API Quick Start (SOAP) encryption-service-java-api-quickstart-soap
Quick Start (SOAP mode): Encrypting a PDF document using the Javaā¢ API
Quick Start (SOAP mode): Removing password-based encryption using the Javaā¢ API
Quick Start (SOAP mode): Encrypting a PDF document with a certificate using the Javaā¢ API
Quick Start (SOAP mode): Removing certificate-based encryption using the Javaā¢ API
Quick Start (SOAP mode): Unlocking an encrypted PDF document using the Javaā¢ API
Quick Start (SOAP mode): Determining encryption type using the Javaā¢ API
AEM Forms operations can be performed using the AEM Forms strongly typed API and the connection mode should be set to SOAP.
NOTE
Quick Starts in Programming with AEM forms are based on the Forms Server being deployed on JBossĀ® Application Server and the MicrosoftĀ® Windows operating system. However, if you are using another operating system, such as UNIXĀ®, replace Windows-specific paths with paths that are supported by the applicable operating system. Likewise, if you are using another J2EE application server, ensure that you specify valid connection properties. See Setting connection properties.
Quick Start (SOAP mode): Encrypting a PDF document using the Javaā¢ API quick-start-soap-mode-encrypting-a-pdf-document-using-the-java-api
The following Javaā¢ code example encrypts a PDF document named Loan.pdf with a password value of OpenPassword. The primary password is PermissionPassword. The secured PDF document is saved as a PDF file named EncryptLoan.pdf. (See Encrypting PDF Documents with a Password.)
ā/*
ā * This Java Quick Start uses the SOAP mode and contains the following JAR files
ā * in the class path:
ā * 1. adobe-encryption-client.jar
ā * 2. adobe-livecycle-client.jar
ā * 3. adobe-usermanager-client.jar
ā * 4. adobe-utilities.jar
ā * 5. jboss-client.jar (use a different JAR file if the Forms Server is not deployed
ā * on JBoss)
ā * 6. activation.jar (required for SOAP mode)
ā * 7. axis.jar (required for SOAP mode)
ā * 8. commons-codec-1.3.jar (required for SOAP mode)
ā * 9. commons-collections-3.1.jar (required for SOAP mode)
ā * 10. commons-discovery.jar (required for SOAP mode)
ā * 11. commons-logging.jar (required for SOAP mode)
ā * 12. dom3-xml-apis-2.5.0.jar (required for SOAP mode)
ā * 13. jaxen-1.1-beta-9.jar (required for SOAP mode)
ā * 14. jaxrpc.jar (required for SOAP mode)
ā * 15. log4j.jar (required for SOAP mode)
ā * 16. mail.jar (required for SOAP mode)
ā * 17. saaj.jar (required for SOAP mode)
ā * 18. wsdl4j.jar (required for SOAP mode)
ā * 19. xalan.jar (required for SOAP mode)
ā * 20. xbean.jar (required for SOAP mode)
ā * 21. xercesImpl.jar (required for SOAP mode)
ā *
ā * These JAR files are in the following path:
ā * <install directory>/sdk/client-libs/common
ā *
ā * The adobe-utilities.jar file is in the following path:
ā * <install directory>/sdk/client-libs/jboss
ā *
ā * The jboss-client.jar file is in the following path:
ā * <install directory>/jboss/bin/client
ā *
ā * SOAP required JAR files are in the following path:
ā * <install directory>/sdk/client-libs/thirdparty
ā *
ā * If you want to invoke a remote Forms Server instance and there is a
ā * firewall between the client application and the 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 AEM Forms
ā */
āimport java.io.File;
āimport java.io.FileInputStream;
āimport java.util.ArrayList;
āimport java.util.List;
āimport java.util.Properties;
āimport com.adobe.idp.Document;
āimport com.adobe.idp.dsc.clientsdk.ServiceClientFactory;
āimport com.adobe.idp.dsc.clientsdk.ServiceClientFactoryProperties;
āimport com.adobe.livecycle.encryption.client.*;
āpublic class PasswordEncryptPDFSoap{
ā public static void main(String[] args) {
ā try{
ā //Set connection properties required to invoke AEM Forms using SOAP mode
ā Properties connectionProps = new Properties();
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_SOAP_ENDPOINT, "https://'[server]:[port]'");
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_SOAP_PROTOCOL);
ā 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 myFactory = ServiceClientFactory.createInstance(connectionProps);
ā //Create an EncryptionServiceClient object
ā EncryptionServiceClient encryptClient = new EncryptionServiceClient(myFactory);
ā //Specify the PDF document to encrypt with a password
ā FileInputStream fileInputStream = new FileInputStream("C:\\ĆŪ¶¹ŹÓʵ\Loan.pdf");
ā Document inDoc = new Document (fileInputStream);
ā //Create a PasswordEncryptionOptionSpec object that stores encryption run-time values
ā PasswordEncryptionOptionSpec passSpec = new PasswordEncryptionOptionSpec();
ā //Specify the PDF document resource to encrypt
ā passSpec.setEncryptOption(PasswordEncryptionOption.ALL);
ā //Specify the permission associated with the password
ā //These permissions enable data to be extracted from a password
ā //protected PDF form
ā List<PasswordEncryptionPermission> encrypPermissions = new ArrayList<PasswordEncryptionPermission>();
ā encrypPermissions.add(PasswordEncryptionPermission.PASSWORD_EDIT_ADD);
ā encrypPermissions.add(PasswordEncryptionPermission.PASSWORD_EDIT_MODIFY);
ā passSpec.setPermissionsRequested(encrypPermissions);
ā //Specify the Acrobat version
ā passSpec.setCompatability(PasswordEncryptionCompatability.ACRO_7);
ā //Specify the password values
ā passSpec.setDocumentOpenPassword("OpenPassword");
ā passSpec.setPermissionPassword("PermissionPassword");
ā //Encrypt the PDF document
ā Document encryptDoc = encryptClient.encryptPDFUsingPassword(inDoc,passSpec);
ā //Save the password-encrypted PDF document
ā File outFile = new File("C:\\ĆŪ¶¹ŹÓʵ\EncryptLoan.pdf");
ā encryptDoc.copyToFile (outFile);
ā }catch (Exception e) {
ā e.printStackTrace();
ā }
ā }
ā}
Quick Start (SOAP mode): Removing password-based encryption using the Javaā¢ API quick-start-soap-mode-removing-password-based-encryption-using-the-java-api
The following Javaā¢ code example removes password-based encryption from a PDF document named EncryptLoan.pdf. The primary password value used to remove password-based encryption is PermissionPassword. The unsecured PDF document is saved as a PDF file named noEncryptionLoan.pdf. (See Removing Password Encryption.)
ā/*
ā * This Java Quick Start uses the SOAP mode and contains the following JAR files
ā * in the class path:
ā * 1. adobe-encryption-client.jar
ā * 2. adobe-livecycle-client.jar
ā * 3. adobe-usermanager-client.jar
ā * 4. adobe-utilities.jar
ā * 5. jboss-client.jar (use a different JAR file if the Forms Server is not deployed
ā * on JBoss)
ā * 6. activation.jar (required for SOAP mode)
ā * 7. axis.jar (required for SOAP mode)
ā * 8. commons-codec-1.3.jar (required for SOAP mode)
ā * 9. commons-collections-3.1.jar (required for SOAP mode)
ā * 10. commons-discovery.jar (required for SOAP mode)
ā * 11. commons-logging.jar (required for SOAP mode)
ā * 12. dom3-xml-apis-2.5.0.jar (required for SOAP mode)
ā * 13. jaxen-1.1-beta-9.jar (required for SOAP mode)
ā * 14. jaxrpc.jar (required for SOAP mode)
ā * 15. log4j.jar (required for SOAP mode)
ā * 16. mail.jar (required for SOAP mode)
ā * 17. saaj.jar (required for SOAP mode)
ā * 18. wsdl4j.jar (required for SOAP mode)
ā * 19. xalan.jar (required for SOAP mode)
ā * 20. xbean.jar (required for SOAP mode)
ā * 21. xercesImpl.jar (required for SOAP mode)
ā *
ā * These JAR files are in the following path:
ā * <install directory>/sdk/client-libs/common
ā *
ā * The adobe-utilities.jar file is in the following path:
ā * <install directory>/sdk/client-libs/jboss
ā *
ā * The jboss-client.jar file is in the following path:
ā * <install directory>/jboss/bin/client
ā *
ā * SOAP required JAR files are in the following path:
ā * <install directory>/sdk/client-libs/thirdparty
ā *
ā * If you want to invoke a remote Forms Server instance and there is a
ā * firewall between the client application and the 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 AEM Forms
ā */
āimport java.io.File;
āimport java.io.FileInputStream;
āimport java.util.Properties;
āimport com.adobe.idp.Document;
āimport com.adobe.idp.dsc.clientsdk.ServiceClientFactory;
āimport com.adobe.idp.dsc.clientsdk.ServiceClientFactoryProperties;
āimport com.adobe.livecycle.encryption.client.*;
āpublic class RemovePasswordFromPDFSOAP {
ā public static void main(String[] args) {
ā try{
ā //Set connection properties required to invoke AEM Forms
ā Properties connectionProps = new Properties();
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_SOAP_ENDPOINT, "https://'[server]:[port]'");
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_SOAP_PROTOCOL);
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "JBoss");
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator");
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password");
ā //Create a ServiceClientFactory object
ā ServiceClientFactory myFactory = ServiceClientFactory.createInstance(connectionProps);
ā //Create an EncryptionServiceClient object
ā EncryptionServiceClient encryptClient = new EncryptionServiceClient(myFactory);
ā //Get the encrypted PDF from which to remove password-based encryption
ā FileInputStream fileInputStream = new FileInputStream("C:\\ĆŪ¶¹ŹÓʵ\EncryptLoan.pdf");
ā Document inDoc = new Document (fileInputStream);
ā //Remove password-based encryption from the PDF document
ā Document encryptDoc = encryptClient.removePDFPasswordSecurity(inDoc,"PermissionPassword");
ā //Save the unsecured PDF document
ā File outFile = new File("C:\\ĆŪ¶¹ŹÓʵ\noEncryptionLoan.pdf");
ā encryptDoc.copyToFile (outFile);
ā }catch (Exception e) {
ā e.printStackTrace();
ā }
ā }
ā}
Quick Start (SOAP mode): Encrypting a PDF document with a certificate using the Javaā¢ API quick-start-soap-mode-encrypting-a-pdf-document-with-a-certificate-using-the-java-api
The following Javaā¢ code example encrypts a PDF document named Loan.pdf with a certificate named Encryption.cer. The encrypted PDF document is saved as a PDF file named EncryptLoanCert.pdf. (See Encrypting PDF Documents with Certificates.)
ā/*
ā * This Java Quick Start uses the SOAP mode and contains the following JAR files
ā * in the class path:
ā * 1. adobe-encryption-client.jar
ā * 2. adobe-livecycle-client.jar
ā * 3. adobe-usermanager-client.jar
ā * 4. adobe-utilities.jar
ā * 5. jboss-client.jar (use a different JAR file if the Forms Server is not deployed
ā * on JBoss)
ā * 6. activation.jar (required for SOAP mode)
ā * 7. axis.jar (required for SOAP mode)
ā * 8. commons-codec-1.3.jar (required for SOAP mode)
ā * 9. commons-collections-3.1.jar (required for SOAP mode)
ā * 10. commons-discovery.jar (required for SOAP mode)
ā * 11. commons-logging.jar (required for SOAP mode)
ā * 12. dom3-xml-apis-2.5.0.jar (required for SOAP mode)
ā * 13. jaxen-1.1-beta-9.jar (required for SOAP mode)
ā * 14. jaxrpc.jar (required for SOAP mode)
ā * 15. log4j.jar (required for SOAP mode)
ā * 16. mail.jar (required for SOAP mode)
ā * 17. saaj.jar (required for SOAP mode)
ā * 18. wsdl4j.jar (required for SOAP mode)
ā * 19. xalan.jar (required for SOAP mode)
ā * 20. xbean.jar (required for SOAP mode)
ā * 21. xercesImpl.jar (required for SOAP mode)
ā *
ā * These JAR files are in the following path:
ā * <install directory>/sdk/client-libs/common
ā *
ā * The adobe-utilities.jar file is in the following path:
ā * <install directory>/sdk/client-libs/jboss
ā *
ā * The jboss-client.jar file is in the following path:
ā * <install directory>/jboss/bin/client
ā *
ā * SOAP required JAR files are in the following path:
ā * <install directory>/sdk/client-libs/thirdparty
ā *
ā * If you want to invoke a remote Forms Server instance and there is a
ā * firewall between the client application and the 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 AEM Forms
ā */
āimport java.io.File;
āimport java.io.FileInputStream;
āimport java.util.ArrayList;
āimport java.util.List;
āimport java.util.Properties;
āimport com.adobe.idp.Document;
āimport com.adobe.idp.dsc.clientsdk.ServiceClientFactory;
āimport com.adobe.idp.dsc.clientsdk.ServiceClientFactoryProperties;
āimport com.adobe.livecycle.encryption.client.*;
āpublic class PKIEncryptPDFSoap {
ā public static void main(String[] args) {
ā try{
ā //Set connection properties required to invoke AEM Forms using SOAP mode
ā Properties connectionProps = new Properties();
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_SOAP_ENDPOINT, "https://'[server]:[port]'");
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_SOAP_PROTOCOL);
ā 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 myFactory = ServiceClientFactory.createInstance(connectionProps);
ā //Create an EncryptionServiceClient object
ā EncryptionServiceClient encryptClient = new EncryptionServiceClient(myFactory);
ā //Specify the PDF document to encrypt with a certificate
ā FileInputStream fileInputStream = new FileInputStream("C:\\ĆŪ¶¹ŹÓʵ\Loan.pdf");
ā Document inDoc = new Document (fileInputStream);
ā //Set the List that stores PKI information
ā List pkiIdentities = new ArrayList();
ā //Set the Permission List
ā List permList = new ArrayList();
ā permList.add(CertificateEncryptionPermissions.PKI_ALL_PERM) ;
ā //Create a Recipient object to store certificate information
ā Recipient recipient = new Recipient();
ā //Specify the private key that is used to encrypt the document
ā FileInputStream fileInputStreamCert = new FileInputStream("C:\\ĆŪ¶¹ŹÓʵ\Encryption.cer");
ā Document privateKey = new Document (fileInputStreamCert);
ā recipient.setX509Cert(privateKey);
ā //Create an EncryptionIdentity object
ā CertificateEncryptionIdentity encryptionId = new CertificateEncryptionIdentity();
ā encryptionId.setPerms(permList);
ā encryptionId.setRecipient(recipient);
ā //Add the EncryptionIdentity to the list
ā pkiIdentities.add(encryptionId);
ā //Set encryption run-time options
ā CertificateEncryptionOptionSpec certOptionsSpec = new CertificateEncryptionOptionSpec();
ā certOptionsSpec.setOption(CertificateEncryptionOption.ALL);
ā certOptionsSpec.setCompat(CertificateEncryptionCompatibility.ACRO_7);
ā //Encrypt the PDF document with a certificate
ā Document encryptDoc = encryptClient.encryptPDFUsingCertificates(inDoc,pkiIdentities, certOptionsSpec);
ā //Save the encrypted PDF document
ā File outFile = new File("C:\\ĆŪ¶¹ŹÓʵ\EncryptLoanCert.pdf");
ā encryptDoc.copyToFile (outFile);
ā }catch (Exception e) {
ā e.printStackTrace();
ā }
ā }
ā}
Quick Start (SOAP mode): Removing certificate-based encryption using the Javaā¢ API quick-start-soap-mode-removing-certificate-based-encryption-using-the-java-api
The following Javaā¢ code example removes certificate-based encryption from a PDF document named EncryptLoanCert.pdf. The alias of the public key that is used to remove encryption is Encryption. The unsecured PDF document is saved as a PDF file named noEncryptionLoan.pdf. (See Removing Certificate Based Encryption.)
ā/*
ā * This Java Quick Start uses the SOAP mode and contains the following JAR files
ā * in the class path:
ā * 1. adobe-encryption-client.jar
ā * 2. adobe-livecycle-client.jar
ā * 3. adobe-usermanager-client.jar
ā * 4. adobe-utilities.jar
ā * 5. jboss-client.jar (use a different JAR file if the Forms Server is not deployed
ā * on JBoss)
ā * 6. activation.jar (required for SOAP mode)
ā * 7. axis.jar (required for SOAP mode)
ā * 8. commons-codec-1.3.jar (required for SOAP mode)
ā * 9. commons-collections-3.1.jar (required for SOAP mode)
ā * 10. commons-discovery.jar (required for SOAP mode)
ā * 11. commons-logging.jar (required for SOAP mode)
ā * 12. dom3-xml-apis-2.5.0.jar (required for SOAP mode)
ā * 13. jaxen-1.1-beta-9.jar (required for SOAP mode)
ā * 14. jaxrpc.jar (required for SOAP mode)
ā * 15. log4j.jar (required for SOAP mode)
ā * 16. mail.jar (required for SOAP mode)
ā * 17. saaj.jar (required for SOAP mode)
ā * 18. wsdl4j.jar (required for SOAP mode)
ā * 19. xalan.jar (required for SOAP mode)
ā * 20. xbean.jar (required for SOAP mode)
ā * 21. xercesImpl.jar (required for SOAP mode)
ā *
ā * These JAR files are in the following path:
ā * <install directory>/sdk/client-libs/common
ā *
ā * The adobe-utilities.jar file is in the following path:
ā * <install directory>/sdk/client-libs/jboss
ā *
ā * The jboss-client.jar file is in the following path:
ā * <install directory>/jboss/bin/client/jboss/bin/client
ā *
ā * SOAP required JAR files are in the following path:
ā * <install directory>/sdk/client-libs/thirdparty
ā *
ā * If you want to invoke a remote Forms Server instance and there is a
ā * firewall between the client application and the 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 AEM Forms
ā */
āimport java.io.File;
āimport java.io.FileInputStream;
āimport java.util.Properties;
āimport com.adobe.idp.Document;
āimport com.adobe.idp.dsc.clientsdk.ServiceClientFactory;
āimport com.adobe.idp.dsc.clientsdk.ServiceClientFactoryProperties;
āimport com.adobe.livecycle.encryption.client.*;
āpublic class RemovePKIFromPDFSOAP {
ā public static void main(String[] args) {
ā try{
ā //Set connection properties required to invoke AEM Forms using SOAP mode
ā Properties connectionProps = new Properties();
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_SOAP_ENDPOINT, "https://'[server]:[port]'");
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_SOAP_PROTOCOL);
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "JBoss");
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator");
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password");
ā //Create a ServiceClientFactory object
ā ServiceClientFactory myFactory = ServiceClientFactory.createInstance(connectionProps);
ā //Create an EncryptionServiceClient object
ā EncryptionServiceClient encryptClient = new EncryptionServiceClient(myFactory);
ā //Get the encrypted PDF document
ā FileInputStream fileInputStream = new FileInputStream("C:\\ĆŪ¶¹ŹÓʵ\EncryptLoanCert.pdf");
ā Document inDoc = new Document (fileInputStream);
ā //Remove certificate-based encryption from the PDF document
ā Document encryptDoc = encryptClient.removePDFCertificateSecurity(inDoc, "Encryption");
ā //Save the unsecured PDF document
ā File outFile = new File("C:\\ĆŪ¶¹ŹÓʵ\noEncryptionLoan.pdf");
ā encryptDoc.copyToFile (outFile);
ā }catch (Exception e) {
ā e.printStackTrace();
ā }
ā }
ā}
Quick Start (SOAP mode): Unlocking an encrypted PDF document using the Javaā¢ API quick-start-soap-mode-unlocking-an-encrypted-pdf-document-using-the-java-api
The following Javaā¢ code example unlocks a password-encrypted PDF document named EncryptLoan.pdf. (See Unlocking Encrypted PDF Documents.)
ā/*
ā * This Java Quick Start uses the SOAP mode and contains the following JAR files
ā * in the class path:
ā * 1. adobe-encryption-client.jar
ā * 2. adobe-livecycle-client.jar
ā * 3. adobe-usermanager-client.jar
ā * 4. adobe-utilities.jar
ā * 5. jboss-client.jar (use a different JAR file if Forms Server is not deployed
ā * on JBoss)
ā * 6. activation.jar (required for SOAP mode)
ā * 7. axis.jar (required for SOAP mode)
ā * 8. commons-codec-1.3.jar (required for SOAP mode)
ā * 9. commons-collections-3.1.jar (required for SOAP mode)
ā * 10. commons-discovery.jar (required for SOAP mode)
ā * 11. commons-logging.jar (required for SOAP mode)
ā * 12. dom3-xml-apis-2.5.0.jar (required for SOAP mode)
ā * 13. jaxen-1.1-beta-9.jar (required for SOAP mode)
ā * 14. jaxrpc.jar (required for SOAP mode)
ā * 15. log4j.jar (required for SOAP mode)
ā * 16. mail.jar (required for SOAP mode)
ā * 17. saaj.jar (required for SOAP mode)
ā * 18. wsdl4j.jar (required for SOAP mode)
ā * 19. xalan.jar (required for SOAP mode)
ā * 20. xbean.jar (required for SOAP mode)
ā * 21. xercesImpl.jar (required for SOAP mode)
ā *
ā * These JAR files are in the following path:
ā * <install directory>/sdk/client-libs/common
ā *
ā * The adobe-utilities.jar file is in the following path:
ā * <install directory>/sdk/client-libs/jboss
ā *
ā * The jboss-client.jar file is in the following path:
ā * <install directory>/jboss/bin/client
ā *
ā * SOAP required JAR files are in the following path:
ā * <install directory>/sdk/client-libs/thirdparty
ā *
ā * If you want to invoke a remote Forms Server instance and there is a
ā * firewall between the client application and the 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 AEM Forms
ā */
āimport java.io.FileInputStream;
āimport java.util.Properties;
āimport com.adobe.idp.Document;
āimport com.adobe.idp.dsc.clientsdk.ServiceClientFactory;
āimport com.adobe.idp.dsc.clientsdk.ServiceClientFactoryProperties;
āimport com.adobe.livecycle.encryption.client.*;
āpublic class UnlockPDFSOAP {
ā public static void main(String[] args) {
ā try{
ā //Set connection properties required to invoke AEM Forms using SOAP mode
ā Properties connectionProps = new Properties();
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_SOAP_ENDPOINT, "https://'[server]:[port]'");
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_SOAP_PROTOCOL);
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "JBoss");
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator");
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password");
ā //Create a ServiceClientFactory object
ā ServiceClientFactory myFactory = ServiceClientFactory.createInstance(connectionProps);
ā //Create an EncryptionServiceClient object
ā EncryptionServiceClient encryptClient = new EncryptionServiceClient(myFactory);
ā //Get the password-encrypted PDF document to unlock
ā FileInputStream fileInputStream = new FileInputStream("C:\\ĆŪ¶¹ŹÓʵ\EncryptLoan.pdf");
ā Document inDoc = new Document (fileInputStream);
ā //Specify the password to open the password-encrypted PDF document
ā String openPassword = "OpenPassword" ;
ā //Unlock the password-encrypted PDF document
ā Document unlockedDoc = encryptClient.unlockPDFUsingPassword(inDoc,openPassword);
ā }catch (Exception e) {
ā System.out.println("The following error occurred during this operation " +e.getMessage());
ā }
ā }
ā}
Quick Start (SOAP mode): Determining encryption type using the Javaā¢ API quick-start-soap-mode-determining-encryption-type-using-the-java-api
The following Javaā¢ code example determines the type of encryption that is protecting a PDF document named EncryptLoan.pdf. (See Determining Encryption Type.)
ā/*
ā * This Java Quick Start uses the SOAP mode and contains the following JAR files
ā * in the class path:
ā * 1. adobe-encryption-client.jar
ā * 2. adobe-livecycle-client.jar
ā * 3. adobe-usermanager-client.jar
ā * 4. adobe-utilities.jar
ā * 5. jboss-client.jar (use a different JAR file if the Forms Server is not deployed
ā * on JBoss)
ā * 6. activation.jar (required for SOAP mode)
ā * 7. axis.jar (required for SOAP mode)
ā * 8. commons-codec-1.3.jar (required for SOAP mode)
ā * 9. commons-collections-3.1.jar (required for SOAP mode)
ā * 10. commons-discovery.jar (required for SOAP mode)
ā * 11. commons-logging.jar (required for SOAP mode)
ā * 12. dom3-xml-apis-2.5.0.jar (required for SOAP mode)
ā * 13. jaxen-1.1-beta-9.jar (required for SOAP mode)
ā * 14. jaxrpc.jar (required for SOAP mode)
ā * 15. log4j.jar (required for SOAP mode)
ā * 16. mail.jar (required for SOAP mode)
ā * 17. saaj.jar (required for SOAP mode)
ā * 18. wsdl4j.jar (required for SOAP mode)
ā * 19. xalan.jar (required for SOAP mode)
ā * 20. xbean.jar (required for SOAP mode)
ā * 21. xercesImpl.jar (required for SOAP mode)
ā *
ā * These JAR files are in the following path:
ā * <install directory>/sdk/client-libs/common
ā *
ā * The adobe-utilities.jar file is in the following path:
ā * <install directory>/sdk/client-libs/jboss
ā *
ā * The jboss-client.jar file is in the following path:
ā * <install directory>/jboss/bin/client
ā *
ā * SOAP required JAR files are in the following path:
ā * <install directory>/sdk/client-libs/thirdparty
ā *
ā * If you want to invoke a remote Forms Server instance and there is a
ā * firewall between the client application and the 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 AEM Forms
ā */
āimport java.io.FileInputStream;
āimport java.util.Properties;
āimport com.adobe.idp.Document;
āimport com.adobe.idp.dsc.clientsdk.ServiceClientFactory;
āimport com.adobe.idp.dsc.clientsdk.ServiceClientFactoryProperties;
āimport com.adobe.livecycle.encryption.client.*;
āpublic class GetEncryptionTypeSOAP {
ā public static void main(String[] args) {
ā try{
ā //Set connection properties required to invoke AEM Forms using SOAP mode
ā Properties connectionProps = new Properties();
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_SOAP_ENDPOINT, "https://'[server]:[port]'");
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_SOAP_PROTOCOL);
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "JBoss");
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator");
ā connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password");
ā //Create a ServiceClientFactory object
ā ServiceClientFactory myFactory = ServiceClientFactory.createInstance(connectionProps);
ā //Create a EncryptionServiceClient object
ā EncryptionServiceClient encryptClient = new EncryptionServiceClient(myFactory);
ā //Get the PDF document
ā FileInputStream fileInputStream = new FileInputStream("C:\\ĆŪ¶¹ŹÓʵ\EncryptLoan.pdf");
ā Document inDoc = new Document (fileInputStream);
ā //Determine the type of encryption of the PDF document
ā EncryptionTypeResult encryptTypeResult = encryptClient.getPDFEncryption(inDoc);
ā if (encryptTypeResult.getEncryptionType() == EncryptionType.PASSWORD)
ā System.out.println("The PDF document is protected with password-based encryption");
ā else if (encryptTypeResult.getEncryptionType() == EncryptionType.POLICY_SERVER)
ā System.out.println("The PDF document is protected with policy");
ā else if (encryptTypeResult.getEncryptionType() == EncryptionType.CERTIFICATE)
ā System.out.println("The PDF document is protected with certificate-based encryption");
ā else if (encryptTypeResult.getEncryptionType() == EncryptionType.OTHER)
ā System.out.println("The PDF document is protected with another type of encryption");
ā else if (encryptTypeResult.getEncryptionType() == EncryptionType.NONE)
ā System.out.println("The PDF document is not protected.");
ā }catch (Exception e) {
ā e.printStackTrace();
ā }
ā }
ā}
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2