Merge branch 'beta1.2.4'

Author: C-WangPengHui

README.md

@@ -1,124 +1,141 @@
-## compdfkit-pdf-api-java
+## ComPDFKit API in Java
+
+[ComPDFKit](https://api.compdf.com/api/docs/introduction) API provides a variety of Java API tools that allow you to create an efficient document processing workflow in a single API call. Try our various APIs for free — no credit card required.
+
 
-This is the compdfkit-pdf-api Java SDK  for the [ComPDFKit](https://api.compdf.com/api/docs/introduction) API.
 
 ## Requirements
 
-JAVA JDK 1.8 and later.
+Programming Environment: Java JDK 1.8 and higher.
+
+Dependencies: Maven.
 
-Maven 3.6 and later.
 
-Springboot 2.3.0.RELEASE and later.
 
 ## Installation
 
-Add the following dependency to your pom.xml:
+Add the following dependency to your ***"pom.xml"***:
 
 ```
 <dependency>
     <groupId>com.compdf</groupId>
-    <artifactId>compdfkit-pdf-api-java</artifactId>
-    <version>1.2.2</version>
+    <artifactId>compdfkit-api-java</artifactId>
+    <version>1.2.4</version>
 </dependency>
 ```
 
+
+
 ## Create API Client
 
-You can use your **publicKey** and **secretKey** to complete the authentication
+You can use your **publicKey** and **secretKey** to complete the authentication. You need to [sign in](https://api.compdf.com/login) your ComPDFKit API account to get your **publicKey** and **secretKey** at the [dashboard](https://api-dashboard.compdf.com/api/keys). If you are new to ComPDFKit, click here to [sign up](https://api.compdf.com/signup) for a free trial.
 
-Project public Key ：You can find the public key in [Management Panel](https://api-dashboard.compdf.com/api/keys).
+- Project public Key : You can find the public key in [Management Panel](https://api-dashboard.compdf.com/api/keys).
 
-Project secret Key ： You can find the secret Key in [Management Panel](https://api-dashboard.compdf.com/api/keys).
+- Project secret Key : You can find the secret Key in [Management Panel](https://api-dashboard.compdf.com/api/keys).
 
 ```java
-ComPdfKitClient client = new ComPdfKitClient(<publicKey>, <secretKey>);
+CPDFClient client = new CPDFClient(<publicKey>, <secretKey>);
 ```
 
+
+
 ## Create Task
 
-A task ID is automatically generated for you based on the type of PDF tool you choose. You can provide the callback notification URL. After the task processing is completed, we will notify you of the task result through the callback interface. You can perform other operations according to the task result, such as downloading the result file.
+A task ID is automatically generated for you based on the type of PDF tool you choose. You can provide the callback notification URL. After the task processing is completed, we will notify you of the task result through the callback interface. You can perform other operations according to the request result, such as checking the status of the task, uploading files, starting the task, or downloading the result file.
 
 ```java
 // Create a client
-ComPdfKitClient client = new ComPdfKitClient(<publicKey>, <secretKey>);
+CPDFClient client = new CPDFClient(<publicKey>, <secretKey>);
 
+// Create a task
 // Create an example of a PDF TO WORD task
-CreateTaskResult result = client.createTask(PDFToOfficeEnum.PDF_TO_WORD.getValue());
+CPDFCreateTaskResult result = client.createTask(CPDFConversionEnum.PDF_TO_WORD.getValue());
 
-//Get a task id
-String jobId = result.getTaskId();
+// Get a task id
+String taskId = result.getTaskId();
 ```
 
-## Upload Files
 
-Upload the original file and bind the file to the task ID. The field parameter is used to pass the JSON string to set the processing parameters for the file. Each file will generate automatically a unique filekey. Please note that a maximum of five files can be uploaded for a task ID and no files can be uploaded for that task after it has started.
 
+## Upload Files
 
+Upload the original file and bind the file to the task ID. The field parameter is used to pass the JSON string to set the processing parameters for the file. Each file will generate automatically a unique filekey. Please note that a maximum of five files can be uploaded for a task ID and no files can be uploaded for that task after it has started.
 
 ```java
 // Create a client
-ComPdfKitClient client = new ComPdfKitClient(<publicKey>, <secretKey>);
+CPDFClient client = new CPDFClient(<publicKey>, <secretKey>);
 
 // Create a task
 // Create an example of a PDF TO WORD task
-CreateTaskResult result = client.createTask(PDFToOfficeEnum.PDF_TO_WORD.getValue());
+CPDFCreateTaskResult result = client.createTask(CPDFConversionEnum.PDF_TO_WORD.getValue());
 
 // Get a task id
-String jobId = result.getTaskId();
+String taskId = result.getTaskId();
 
-// Upload file
-client.uploadFile(<convertFile>, jobId);
+// Upload files
+client.uploadFile(<convertFile>, taskId);
 ```
 
 
 
 ## Execute the task
 
-After the file upload is completed, call this interface with the task ID to process file.
+After the file upload is completed, call this interface with the task ID to process the files.
 
 ```java
 // Create a client
-ComPdfKitClient client = new ComPdfKitClient(<publicKey>, <secretKey>);
+CPDFClient client = new CPDFClient(<publicKey>, <secretKey>);
 
 // Create a task
-// Create an example of a PDF TO EXCEL task
-CreateTaskResult result = client.createTask(PDFToOfficeEnum.PDF_TO_WORD.getValue());
+// Create an example of a PDF TO WORD task
+CPDFCreateTaskResult result = client.createTask(CPDFConversionEnum.PDF_TO_WORD.getValue());
 
 // Get a task id
-String jobId = result.getTaskId();
+String taskId = result.getTaskId();
 
 // Upload files
-client.uploadFile(<convertFile>, jobId);
+client.uploadFile(<convertFile>, taskId);
 
 // execute Task
-client.executeTask(jobId);
+client.executeTask(taskId);
 ```
 
-## Get TaskInfo
 
-Request task status and file-related metadata based on the task ID.
+
+## Get Task Info
+
+Request task status and file-related meta data based on the task ID.
 
 ```java
 // Create a client
-ComPdfKitClient client = new ComPdfKitClient(<publicKey>, <secretKey>);
+CPDFClient client = new CPDFClient(<publicKey>, <secretKey>);
 
 // Create a task
 // Create an example of a PDF TO WORD task
-CreateTaskResult result = client.createTask(PDFToOfficeEnum.PDF_TO_WORD.getValue());
+CPDFCreateTaskResult result = client.createTask(CPDFConversionEnum.PDF_TO_WORD.getValue());
 
 // Get a task id
-String jobId = result.getTaskId();
+String taskId = result.getTaskId();
 
 // Upload files
-client.uploadFile(<convertFile>, jobId);
+client.uploadFile(<convertFile>, taskId);
 
-// execute Task
-client.executeTask(jobId);
+// Execute Task
+client.executeTask(taskId);
 
-// query TaskInfo
-QueryTaskInfoResult taskInfo = client.queryTaskInfo(jobId)
+// Query TaskInfo
+CPDFTaskInfoResult taskInfo = client.getTaskInfo(taskId);
 ```
 
+
+
+## Samples
+
+See ***"Samples"*** folder in this folder.
+
+
+
 ## Resources
 
 * [ComPDFKit API Documentation](https://api.compdf.com/api/docs/introduction)

pom.xml

@@ -42,12 +42,12 @@
 
 
     <groupId>com.compdf</groupId>
-    <artifactId>compdfkit-pdf-api-java</artifactId>
-    <version>1.2.2</version>
+    <artifactId>compdfkit-api-java</artifactId>
+    <version>1.2.4</version>
 
-    <name>compdfkit-pdf-api-java</name>
-    <description>compdfkit-pdf-api-java</description>
-    <url>https://github.com/ComPDFKit/compdfkit-pdf-api-java</url>
+    <name>compdfkit-api-java</name>
+    <description>compdfkit-api-java</description>
+    <url>https://github.com/ComPDFKit/compdfkit-api-java</url>
 
     <licenses>
         <license>
@@ -70,9 +70,9 @@
     </developers>
 
     <scm>
-        <connection>https://github.com/ComPDFKit/compdfkit-pdf-api-java.git</connection>
-        <developerConnection>scm:git:ssh://git@github.com:ComPDFKit/compdfkit-pdf-api-java.git</developerConnection>
-        <url>https://github.com/ComPDFKit/compdfkit-pdf-api-java</url>
+        <connection>https://github.com/ComPDFKit/compdfkit-api-java.git</connection>
+        <developerConnection>scm:git:ssh://git@github.com:ComPDFKit/compdfkit-api-java.git</developerConnection>
+        <url>https://github.com/ComPDFKit/compdfkit-api-java</url>
     </scm>
 
 
@@ -82,7 +82,7 @@
 
     <profiles>
         <profile>
-            <id>ossrh</id>
+            <id>release</id>
             <activation>
                 <activeByDefault>true</activeByDefault>
             </activation>
@@ -165,7 +165,7 @@
 
     </profiles>
     <build>
-        <finalName>compdfkit-pdf-api-java</finalName>
+        <finalName>compdfkit-api-java</finalName>
     </build>
 
 </project>

samples/pom.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version>2.3.0.RELEASE</version>
+        <relativePath/>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>samples</artifactId>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.compdf</groupId>
+            <artifactId>compdfkit-api-java</artifactId>
+            <version>1.2.4</version>
+        </dependency>
+    </dependencies>
+
+</project>

samples/src/main/java/com/compdfkit/AddWatermark.java

@@ -0,0 +1,122 @@
+//  Copyright © 2014-2023 PDF Technologies, Inc. All Rights Reserved.
+//
+//  THIS SOURCE CODE AND ANY ACCOMPANYING DOCUMENTATION ARE PROTECTED BY INTERNATIONAL COPYRIGHT LAW
+//  AND MAY NOT BE RESOLD OR REDISTRIBUTED. USAGE IS BOUND TO THE ComPDFKit LICENSE AGREEMENT.
+//  UNAUTHORIZED REPRODUCTION OR DISTRIBUTION IS SUBJECT TO CIVIL AND CRIMINAL PENALTIES.
+//  This notice may not be removed from this file.
+
+package com.compdfkit;
+
+
+import com.compdfkit.client.CPDFClient;
+import com.compdfkit.constant.CPDFConstant;
+import com.compdfkit.enums.CPDFDocumentEditorEnum;
+import com.compdfkit.param.CPDFAddWatermarkParameter;
+import com.compdfkit.pojo.comPdfKit.CPDFCreateTaskResult;
+import com.compdfkit.pojo.comPdfKit.CPDFFileInfo;
+import com.compdfkit.pojo.comPdfKit.CPDFTaskInfoResult;
+import com.compdfkit.pojo.comPdfKit.CPDFUploadFileResult;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.util.concurrent.Executors;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.ScheduledFuture;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicReference;
+
+public class AddWatermark {
+
+    private static final String publicKey = "";
+    private static final String secretKey = "";
+    private static final CPDFClient client = new CPDFClient(publicKey,secretKey);
+
+    public static void main(String[] args) throws FileNotFoundException {
+        AddWatermark.addWatermarkText();
+//        AddWatermark.addWatermarkImage();
+    }
+
+    public static void addWatermarkText() throws FileNotFoundException {
+        // create Task
+        CPDFCreateTaskResult createTaskResult = client.createTask(CPDFDocumentEditorEnum.ADD_WATERMARK);
+        // taskId
+        String taskId = createTaskResult.getTaskId();
+        // upload File
+        File file = new File("sample/test.pdf");
+        String filePassword = "";
+        CPDFAddWatermarkParameter fileParameter = new CPDFAddWatermarkParameter();
+        fileParameter.setType("text");
+        fileParameter.setScale("1");
+        fileParameter.setOpacity("0.5");
+        fileParameter.setRotation("0.785");
+        fileParameter.setTargetPages("1-2");
+        fileParameter.setVertalign("center");
+        fileParameter.setHorizalign("left");
+        fileParameter.setXoffset("100");
+        fileParameter.setYoffset("100");
+        fileParameter.setContent("test");
+        fileParameter.setTextColor("#59c5bb");
+        fileParameter.setFullScreen("1");
+        fileParameter.setHorizontalSpace("10");
+        fileParameter.setVerticalSpace("10");
+        CPDFUploadFileResult uploadFileResult = client.uploadFile(new FileInputStream(file),taskId,filePassword,fileParameter,file.getName());
+        String fileKey = uploadFileResult.getFileKey();
+        // perform tasks
+        client.executeTask(taskId);
+        // get task processing information
+        CPDFTaskInfoResult taskInfo = client.getTaskInfo(taskId);
+        // determine whether the task status is "TaskFinish"
+        if (taskInfo.getTaskStatus().equals(CPDFConstant.TASK_FINISH)) {
+            System.out.println(taskInfo);
+            // get the final file processing information
+            CPDFFileInfo fileInfo = client.getFileInfo(fileKey);
+            System.out.println(fileInfo);
+            // if the task is finished, cancel the scheduled task
+        }else {
+            System.out.println("Task incomplete processing");
+        }
+    }
+
+    public static void addWatermarkImage() throws IOException {
+        // create Task
+        CPDFCreateTaskResult createTaskResult = client.createTask(CPDFDocumentEditorEnum.ADD_WATERMARK);
+        // taskId
+        String taskId = createTaskResult.getTaskId();
+        // upload File
+        File file = new File("sample/test.pdf");
+        String filePassword = "";
+        CPDFAddWatermarkParameter fileParameter = new CPDFAddWatermarkParameter();
+        fileParameter.setType("image");
+        fileParameter.setScale("0.5");
+        fileParameter.setOpacity("0.5");
+        fileParameter.setRotation("45");
+        fileParameter.setTargetPages("1-2");
+        fileParameter.setVertalign("center");
+        fileParameter.setHorizalign("left");
+        fileParameter.setXoffset("50");
+        fileParameter.setYoffset("50");
+        fileParameter.setFullScreen("1");
+        fileParameter.setHorizontalSpace("100");
+        fileParameter.setVerticalSpace("100");
+        fileParameter.setFront("1");
+        CPDFUploadFileResult uploadFileResult = client.uploadFile(file,taskId,fileParameter,new File("sample/test.jpg"));
+        String fileKey = uploadFileResult.getFileKey();
+        // perform tasks
+        client.executeTask(taskId);
+        // get task processing information
+        CPDFTaskInfoResult taskInfo = client.getTaskInfo(taskId);
+        // determine whether the task status is "TaskFinish"
+        if (taskInfo.getTaskStatus().equals(CPDFConstant.TASK_FINISH)) {
+            System.out.println(taskInfo);
+            // get the final file processing information
+            CPDFFileInfo fileInfo = client.getFileInfo(fileKey);
+            System.out.println(fileInfo);
+            // if the task is finished, cancel the scheduled task
+        }else {
+            System.out.println("Task incomplete processing");
+        }
+    }
+
+}