mirror of
https://github.com/yanlongqi/jhinno-openapi-java-sdk.git
synced 2026-03-22 06:15:10 +08:00
使用文档完善
This commit is contained in:
lqyan
1
.idea/encodings.xml
generated
1
.idea/encodings.xml
generated
@@ -3,5 +3,6 @@
|
||||
<component name="Encoding">
|
||||
<file url="file://$PROJECT_DIR$/src/main/java" charset="UTF-8" />
|
||||
<file url="file://$PROJECT_DIR$/src/main/resources" charset="UTF-8" />
|
||||
<file url="PROJECT" charset="UTF-8" />
|
||||
</component>
|
||||
</project>
|
||||
17
README.md
17
README.md
@@ -56,13 +56,26 @@ mvn install:install-file -Dfile=D:/jar/jhinno-openapi-java-sdk-1.0.0-source.jar
|
||||
方法二：直接在`pom.xml`引用jar
|
||||
|
||||
```xml
|
||||
<!-- 其中${path-to-file}为jar的位置 -->
|
||||
<!-- 其中{path-to-file}为jar的位置 -->
|
||||
<dependency>
|
||||
<groupId>com.jhinno</groupId>
|
||||
<artifactId>jhinno-openapi-java-sdk</artifactId>
|
||||
<version>1.0.0</version>
|
||||
<scope>system</scope>
|
||||
<systemPath>${path-to-file}</systemPath>
|
||||
<systemPath>{path-to-file}</systemPath>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
例如
|
||||
|
||||
```xml
|
||||
<!-- 其中{path-to-file}为jar的位置 -->
|
||||
<dependency>
|
||||
<groupId>com.jhinno</groupId>
|
||||
<artifactId>jhinno-openapi-java-sdk</artifactId>
|
||||
<version>1.0.0</version>
|
||||
<scope>system</scope>
|
||||
<systemPath>D:/</systemPath>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
|
||||
13
pom.xml
13
pom.xml
@@ -116,7 +116,7 @@
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-jar-plugin</artifactId>
|
||||
<version>3.2.2</version>
|
||||
<version>3.3.0</version>
|
||||
</plugin>
|
||||
|
||||
<plugin>
|
||||
@@ -132,21 +132,18 @@
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>2.10.4</version>
|
||||
<version>3.6.3</version>
|
||||
<configuration>
|
||||
<sourcepath>target/generated-sources/delombok</sourcepath>
|
||||
<encoding>${project.build.sourceEncoding}</encoding>
|
||||
<docencoding>${project.build.sourceEncoding}</docencoding>
|
||||
<charset>${project.build.sourceEncoding}</charset>
|
||||
<doclint>none</doclint>
|
||||
<tags>
|
||||
<tag>
|
||||
<name>date</name>
|
||||
<placement>X</placement>
|
||||
</tag>
|
||||
<tag>
|
||||
<name>author</name>
|
||||
<placement>X</placement>
|
||||
</tag>
|
||||
</tags>
|
||||
</configuration>
|
||||
</plugin>
|
||||
@@ -170,8 +167,8 @@
|
||||
|
||||
<developers>
|
||||
<developer>
|
||||
<id>aliyunproducts</id>
|
||||
<name>Jhinno SDK</name>
|
||||
<id>lqyan</id>
|
||||
<name>lqyan</name>
|
||||
<email>lqyan@jhinno.com</email>
|
||||
</developer>
|
||||
</developers>
|
||||
|
||||
@@ -3,19 +3,13 @@ package com.jhinno.sdk.openapi;
|
||||
import lombok.Getter;
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* 这个异常标识传入的SDK方法的参数错误
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* 通常情况下{@link ClientException｝开发者额外处理它，因为它通常出现在开发的时候，
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* 例如： 调用重命名文件的接口，要求源文件路径和新的文件名是必填的参数，
|
||||
* 如果开发者在调用的过程中没填装个参数，则程序会抛出{@link ClientException｝
|
||||
* </p>
|
||||
*
|
||||
* 如果开发者在调用的过程中没填装个参数，则程序会抛出 {@link ClientException｝
|
||||
* <p>
|
||||
* @author yanlongqi
|
||||
* @date 2024/1/31 10:36
|
||||
*/
|
||||
|
||||
@@ -3,21 +3,14 @@ package com.jhinno.sdk.openapi;
|
||||
import lombok.Getter;
|
||||
|
||||
/**
|
||||
* <p>这个异常是客户端访问景行API时抛出的异常。
|
||||
* <p>{@link RuntimeException｝表示景行API客户端任何异常的类。
|
||||
* 一般情况下，{@link RuntimeException｝要么发生在发送请求之前，要么发生在收到OSS服务器端的响应之后。
|
||||
* 例如：如果在尝试发送请求时网络断开，则SDK将抛出{@link RuntimeException｝实例。
|
||||
* <p>{@link ServiceException｝是从景行API响应的错误代码转换而来的。
|
||||
* 例如，当请求的接口参数错误时，SDK会抛出一个｛@link ServiceException｝或其子类实例。
|
||||
* 并带有特定的错误代码，调用者可以用特定的逻辑来处理.
|
||||
* <p>
|
||||
* 这个异常是客户端访问景行API时抛出的异常。
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* {@link ClientException｝表示景行API客户端任何异常的类。
|
||||
* 一般情况下，{@link ClientException｝要么发生在发送请求之前，要么发生在收到OSS服务器端的响应之后。
|
||||
* 例如：如果在尝试发送请求时网络断开，则SDK将抛出{@link ClientException｝实例。
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* {@link ServiceException｝是从景行API响应的错误代码转换而来的。
|
||||
* 例如，当请求的接口参数错误时，SDK会抛出一个｛@link ServiceException｝或其子类实例，
|
||||
* 并带有特定的错误代码，调用者可以用特定的逻辑来处理。
|
||||
* </p>
|
||||
*
|
||||
* @author yanlongqi
|
||||
* @date 2024/1/30 11:27
|
||||
|
||||
@@ -5,25 +5,19 @@ import lombok.Getter;
|
||||
/**
|
||||
* <p>
|
||||
* 这是表示任何预期或意外的景行API服务器端错误的基本异常类。
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* {@link ServiceException｝ 是从景行API响应的错误代码转换而来的。
|
||||
* 例如，当请求的接口参数错误时，SDK会抛出一个｛@link ServiceException｝或其子类实例，
|
||||
* 并带有特定的错误代码，调用者可以用特定的逻辑来处理。
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* 另一方面{@link ClientException｝表示景行API客户端任何异常的类。
|
||||
* 一般情况下，{@link ClientException｝要么发生在发送请求之前，要么发生在收到OSS服务器端的响应之后。
|
||||
* 例如，如果在尝试发送请求时网络断开，则SDK将抛出{@link ClientException｝实例。
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* 所以一般来说，调用者只需要正确处理{@link ServiceException}，
|
||||
* 因为它意味着请求被处理，但由于不同的错误而没有完全完成。
|
||||
* 异常中的错误代码是良好的诊断信息。有时这些例外是完全预料到的。
|
||||
* </p>
|
||||
* <p>
|
||||
*
|
||||
* @author yanlongqi
|
||||
* @date 2024/1/30 11:35
|
||||
|
||||
@@ -20,11 +20,9 @@ import java.util.concurrent.ConcurrentHashMap;
|
||||
* 定义一个请求的执行器，该执行器是一个可以执行任何景行API接口（包含定制新增的接口，特殊接口除外，如有需求，可自行修改源码）
|
||||
* <p>
|
||||
* 注：接口都需要传入username来获取接口调用的token，匿名调用的接口可将username传为null
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* 对于定制接口，可参考以下步骤封装调用方法
|
||||
* </p>
|
||||
* <ol>
|
||||
* <li>定义一个const类同来存放接口的路径，方便后期的维护，如：{@link AppPathConstant}</li>
|
||||
* <li>继承{@link JHApiExecution}，如：{@link JHAppApiExecution}</li>
|
||||
|
||||
@@ -39,18 +39,15 @@ public class AppStartRequest {
|
||||
/**
|
||||
* <p>
|
||||
* 请求获取到的JHClient协议链接的过期目标时间。（必填）
|
||||
* </p>
|
||||
* <p>
|
||||
* 注意：
|
||||
* </p>
|
||||
* <p>
|
||||
* 1. 该时间戳是获取到的加密串的过期时间，需要传入一个未来的时间
|
||||
* （如：当前是2024-02-01 17:53:12，假设加密串5分钟之后过期，则该参数为：20240101175812）
|
||||
* </p>
|
||||
* <p>
|
||||
* 2. 该时间错由景行的JHClient进行验证，并不是在服务端进行验证，
|
||||
* 所以为了防止客户端的时间和服务器的时间不一致而导会话不能启动，
|
||||
* 因此此字段尽量在浏览器的生成
|
||||
* </p>
|
||||
*/
|
||||
private String currentTimestamp;
|
||||
|
||||
@@ -65,11 +62,8 @@ public class AppStartRequest {
|
||||
* 启动参数
|
||||
* <p>
|
||||
* 例如启动一个demo.exe 该demo.exe需要传入用户名，在命令行的的操作为 demo.exe -u admin
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* 此处传入的参数则为："-u admin"
|
||||
* </p>
|
||||
*/
|
||||
private String param;
|
||||
|
||||
|
||||
@@ -64,7 +64,6 @@ public class JHAppApiExecution extends JHApiExecution {
|
||||
* 查询当前用户的会话列表（管理员则查看所有用户的会话）
|
||||
* <p>
|
||||
* 注：开启密集后，仅能查看自己的会话和比自己密级低的会话
|
||||
* </p>
|
||||
*
|
||||
* @param username 用户名
|
||||
* @return 会话列表
|
||||
|
||||
@@ -76,7 +76,7 @@ public class JHJobApiExecution extends JHApiExecution {
|
||||
|
||||
/**
|
||||
* 分页查询作业列表
|
||||
* <p>作业名、作业状态等为非必填自动，如果为空则没有添加该查询条件</p
|
||||
* <p>作业名、作业状态等为非必填自动，如果为空则没有添加该查询条件</p>
|
||||
*
|
||||
* @param username 用户名
|
||||
* @param page 页码（非必填，默认：1）
|
||||
@@ -111,7 +111,7 @@ public class JHJobApiExecution extends JHApiExecution {
|
||||
|
||||
/**
|
||||
* 分页查询作业列表
|
||||
* <p>作业名、作业状态等为非必填自动，如果为空则没有添加该查询条件</p
|
||||
* <p>作业名、作业状态等为非必填自动，如果为空则没有添加该查询条件</p>
|
||||
*
|
||||
* @param username 用户名
|
||||
* @param page 页码（非必填，默认：1）
|
||||
|
||||
@@ -36,10 +36,11 @@ public class JobInfo {
|
||||
/**
|
||||
* 作业状态
|
||||
* <p>
|
||||
* 可能的取值见：{@link JobStatusEnum}<br/>
|
||||
* 如果作业是数组作业（即arrayJob="true"）时status的类型是一个map类型<br/>
|
||||
* 可能的取值见：{@link JobStatusEnum}
|
||||
* <p>
|
||||
* 如果作业是数组作业（即arrayJob="true"）时status的类型是一个map类型
|
||||
* <p>
|
||||
* 如：{"done":1,"run":12}
|
||||
* </p>
|
||||
*/
|
||||
private Object status;
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ import java.util.Map;
|
||||
|
||||
/**
|
||||
* 部门相关接口执行器
|
||||
* <br/>
|
||||
* <p>
|
||||
* 注：要调用以下接口，传入的username必须有user_manager的权限
|
||||
*
|
||||
* @author yanlongqi
|
||||
|
||||
@@ -12,7 +12,7 @@ import java.util.Map;
|
||||
|
||||
/**
|
||||
* 用户相关接口执行器
|
||||
* <br/>
|
||||
* <p>
|
||||
* 注：要调用以下接口，传入的username必须有user_manager的权限
|
||||
*
|
||||
* @author yanlongqi
|
||||
|
||||
@@ -100,10 +100,8 @@ public class JHApiClient {
|
||||
}
|
||||
|
||||
/**
|
||||
* 通过{@link DefaultHttpClientConfig｝默认配置的最大连接数和服务每次能并行接收的请求数量构建一个JHApiClient实例
|
||||
* <p>
|
||||
* 通过 {@link DefaultHttpClientConfig｝ 默认配置的最大连接数和服务每次能并行接收的请求数量构建一个JHApiClient实例
|
||||
* </p>
|
||||
*
|
||||
* @param baseUrl 景行接口服务的基础地址
|
||||
* @return JHApiClient的实例
|
||||
*/
|
||||
@@ -112,9 +110,8 @@ public class JHApiClient {
|
||||
}
|
||||
|
||||
/**
|
||||
* 通过外部传入的 {@link CloseableHttpClient｝ 构建一个请求客户端
|
||||
* 通过外部传入的{@link CloseableHttpClient｝构建一个请求客户端.
|
||||
* <p>
|
||||
*
|
||||
* @param httpClient 请求连接池
|
||||
* @param baseUrl 景行接口服务的基础地址
|
||||
* @return JHApiClient的实例
|
||||
@@ -179,7 +176,7 @@ public class JHApiClient {
|
||||
* <p>
|
||||
* {@link JHApiClient｝ 默认只配置了 socket连接超时的时间(socketTimeout) 、连接超时的时间(connectTimeout)、
|
||||
* 请求超时的时间(connectionRequestTimeout)这三项，其默认配置在{@link DefaultHttpClientConfig｝ 中。
|
||||
* 如果你要自定义你自己的配置，则可以通过{@link HttpClients｝ 构建自己的RequestConfig来请求接口
|
||||
* 如果你要自定义你自己的配置，则可以通过{@link HttpClients｝构建自己的RequestConfig来请求接口
|
||||
* </p>
|
||||
*
|
||||
* @param requestConfig HTTP请求的配置
|
||||
|
||||
Reference in New Issue
Block a user