Merge branch 'feat/v3-api-test' of jihulab.com:authing/sdk/authing-java-sdk-v5 into feat/v3-api-test

Author: 廖长江

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 cj
+Copyright (c) 2022 Authing
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README-zh_CN.md

@@ -0,0 +1,42 @@
+<div align=center>
+  <img width="250" src="https://files.authing.co/authing-console/authing-logo-new-20210924.svg" />
+</div>
+<div align="center">
+  <a href="javascript:;"><img src="https://img.shields.io/badge/test-passing-brightgreen" /></a>
+  <a href="https://forum.authing.cn/" target="_blank"><img src="https://img.shields.io/badge/chat-forum-blue" /></a>
+  <a href="https://console.authing.cn/openapi/#/" target="_blank"><img src="https://img.shields.io/badge/docs-passing-brightgreen" /></a>
+  <a href="javascript:;"><img src="https://img.shields.io/badge/License-MIT-success" alt="License"></a>
+</div>
+
+[English](./README.md) | 简体中文
+
+你可以使用此 Authing Java SDK 快速为新开发的或已有的后端应用集成认证能力。
+
+## 📚 文档
+
+更多示例和使用说明可参考[官方文档](https://docs.authing.cn/v3/reference/sdk/java/install.html)
+
+此版本基于 Authing V3 版本的[用户认证 API](https://api.authing.cn/openapi/v3/authentication/) 和[管理 API](https://api.authing.cn/openapi/v3/management/)，如果你需要使用历史版本的 SDK，请查看 [旧版文档](https://docs.authing.cn/v2/reference/sdk-for-java/)。
+
+
+## ❓ 获取帮助
+
+如果需要在线技术支持，可访问[官方论坛](https://forum.authing.cn/). 此仓库的 issue 仅用于上报 Bug 和提交新功能特性。
+
+## 🤝 开源共建
+
+- Fork 此仓库
+- 创建自己的 git 分支 (git checkout -b my-new-feature)
+- 提交你的修改 (git commit -am 'Add some feature')
+- 将修改内容推送到远程分支 (git push -u origin my-new-feature)
+- 创建一个 Pull Request
+
+感谢所有为 Java SDK 做出贡献的人！
+
+[为 Authing 开源仓库做出贡献](https://github.com/Authing/.github/blob/main/CONTRIBUTING.md#简体中文)
+
+## 🎁 开源许可
+
+[MIT](https://opensource.org/licenses/MIT)
+
+Copyright (c) 2019 Authing

README.md

@@ -1,188 +1,43 @@
-# authing-java-sdk
+<div align=center>
+  <img width="250" src="https://files.authing.co/authing-console/authing-logo-new-20210924.svg" />
+</div>
+<div align="center">
+  <a href="javascript:;"><img src="https://img.shields.io/badge/test-passing-brightgreen" /></a>
+  <a href="https://forum.authing.cn/" target="_blank"><img src="https://img.shields.io/badge/chat-forum-blue" /></a>
+  <a href="https://console.authing.cn/openapi/" target="_blank"><img src="https://img.shields.io/badge/docs-passing-brightgreen" /></a>
+  <a href="javascript:;"><img src="https://img.shields.io/badge/License-MIT-success" alt="License"></a>
+</div>
 
-[Authing](https://authing.cn) 身份云 `Java` 语言客户端，包含 [Authing Open API](https://api.authing.cn/openapi/) 所有 Management API 的请求方法以及通过 OIDC 协议实现的认证侧的认证相关方法。
+English | [简体中文](./README-zh_CN.md)
 
-Management 模块以管理员（Administrator）的身份进行请求，用于管理 Authing 用户、角色、分组、组织机构等资源；一般来说，你在 Authing 控制台中能做的所有操作，都能用此模块完成。
+You can use the Authing Java SDK to quickly integrate authentication capabilities for new or existing Back End applications.
 
-AuthenticationClient 模块提供认证相关的调用方法，支持包括获取认证地址、获取登录态（用户信息，令牌）、检查令牌、登出等认证相关方法。
 
-如果你需要以终端用户（End User）的身份进行登录、注册、登出等操作，请使用 [Guard](https://www.authing.cn/learn/guard) .
+## 📚 Documentation
 
-## 安装
+To check out documentation, please refers to [docs](https://docs.authing.cn/v3/reference/sdk/java/install.html).
 
-### Gradle
+This SDK is built upon [Authing Management API(v3)](https://api.authing.cn/openapi/v3/management/) and [Authing Authentication API(v3)](https://api.authing.cn/openapi/v3/authentication/), for older version, please refers to [older version docs](https://docs.authing.cn/v2/reference/sdk-for-java/).
 
-```bash
-implementation "cn.authing:authing-java-sdk:<{final_version}>"
-```
 
-### Maven
+## ❓ Questions
 
-```xml
-<dependency>
-    <groupId>cn.authing</groupId>
-    <artifactId>authing-java-sdk</artifactId>
-    <version>{final_version}</version>
-</dependency>
-```
+For questions and support please use the [official forum](https://forum.authing.cn/). The issue list of this repo is exclusively for bug reports and feature requests.
 
-## 初始化
+## 🤝 Contribution
 
-初始化 `ManagementClient` 需要使用 `accessKeyId` 和 `accessKeySecret` 参数:
+- Fork it
+- Create your feature branch (git checkout -b my-new-feature)
+- Commit your changes (git commit -am 'Add some feature')
+- Push to the branch (git push -u origin my-new-feature)
+- Create new Pull Request
 
-```java
-import cn.authing.sdk.java.client.ManagementClient;
-import cn.authing.sdk.java.model.ManagementClientOptions;
+Thank you to all the people who already contributed to Java SDK !
 
-ManagementClientOptions clientOptions = new ManagementClientOptions("AUTHING_USERPOOL_ID", "AUTHING_USERPOOL_SECRET");
-ManagementClient managementClient = new ManagementClient(clientOptions);
-```
+[Contributing to Authing Open Source Repos](https://github.com/Authing/.github/blob/main/CONTRIBUTING.md#English)
 
-`ManagementClient` 会自动从 Authing 服务器获取 Management API Token，并通过返回的 Token 过期时间自动对 Token 进行缓存。
+## 🎁 License
 
-完整的参数和释义如下：
+[MIT](https://opensource.org/licenses/MIT)
 
-- `accessKeyId`: Authing 用户池 ID;
-- `accessKeySecret`: Authing 用户池密钥;
-- `timeout`: 超时时间，单位为 ms，默认为 10000 ms;
-- `host`: Authing 服务器地址，默认为 `https://api.authing.cn`。如果你使用的是 Authing 公有云版本，请忽略此参数。如果你使用的是私有化部署的版本，此参数必填，格式如下: https://authing-api.my-authing-service.com（最后不带斜杠 /）。
-- `lang`: 接口 Message 返回语言格式（可选），可选值为 zh-CN 和 en-US，默认为 zh-CN。
-
-初始化 `AuthenticationClient` 需要使用 `appId` 、 `appSecret` 、 `host` 、 `redirectUri` 参数:
-
-```java
-import cn.authing.sdk.java.client.AuthenticationClient;
-import cn.authing.sdk.java.model.AuthenticationClientOptions;
-
-AuthenticationClientOptions clientOptions = new AuthenticationClientOptions("APP_ID", "APP_SECRET", "HOST", "REDIRECT_URI");
-AuthenticationClient authenticationClient = new AuthenticationClient(clientOptions);
-
-```
-
-完整的参数和释义如下：
-
-- `appId`: Authing 应用 ID ;
-- `appSecret`: Authing 应用 Secret;
-- `host`: 应用对应的用户池域名，例如 pool.authing.cn;
-- `redirectUri`: 认证完成后的重定向目标 URL, 会进行校验，需要和控制台的设置保持一致。
-- `logoutRedirectUri`: 登出完成后的重定向目标 URL。
-- `scope`: 应用侧向 Authing 请求的权限，以空格分隔，默认为 'openid profile'，成功获取的权限会出现在 Access Token 的 scope 字段中。
-- `serverJWKS`: 服务端的 JWKS 公钥，用于验证 Token 签名，默认会通过网络请求从服务端的 JWKS 端点自动获取。
-- `cookieKey`: 存储认证上下文的 Cookie 名称。
-
-认证侧相关的使用和方法说明，你可以在 [Authing Nodejs SDK](https://docs.authing.cn/v2/reference-new/sdk/v5/node/authentication.html) 中查看。
-
-## 快速开始
-
-初始化完成 `ManagementClient` 之后，你可以获取 `ManagementClient` 的实例，然后调用此实例上的方法。例如：
-
-- 获取用户列表
-
-```java
-import cn.authing.sdk.java.dto.*;
-import cn.authing.sdk.java.client.ManagementClient;
-import cn.authing.sdk.java.model.ManagementClientOptions;
-
-public static void main(String[] args) {
-    ManagementClientOptions clientOptions = new ManagementClientOptions("AUTHING_USERPOOL_ID", "AUTHING_USERPOOL_SECRET");
-    ManagementClient managementClient = new ManagementClient(clientOptions);
-    ListUsersDto request = new ListUsersDto();
-    request.setPage(1);
-    request.setLimit(10);
-    UserPaginatedRespDto response = managementClient.listUsers(request);
-    System.out.println(response);
-}
-```
-
-- 创建角色
-
-```java
-import cn.authing.sdk.java.dto.*;
-import cn.authing.sdk.java.client.ManagementClient;
-import cn.authing.sdk.java.model.ManagementClientOptions;
-
-public static void main(String[] args) {
-    ManagementClientOptions clientOptions = new ManagementClientOptions("AUTHING_USERPOOL_ID", "AUTHING_USERPOOL_SECRET");
-    ManagementClient managementClient = new ManagementClient(clientOptions);
-    CreateRoleDto request = new CreateRoleDto();
-    request.setCode("code");
-    request.setNamespace("namespace");
-    request.setDescription("description");
-    RoleSingleRespDto response = managementClient.createRole(request);
-    System.out.println(response);
-}
-```
-
-完整的接口列表，你可以在 [Authing Open API](https://api.authing.cn/openapi/) 和 [SDK 文档](https://authing-open-api.readme.io/reference/java) 中获取。
-
-## 错误处理
-
-`ManagementClient` 中的每个方法，遵循统一的返回结构：
-
-- `statusCode`: 请求是否成功状态码，当 `statusCode` 为 200 时，表示操作成功，非 200 全部为失败。
-- `apiCode`: 细分错误码，当 `apiCode` 非 200 时，可通过此错误码得到具体的错误类型。
-- `message`: 具体的错误信息。
-- `data`: 具体返回的接口数据。
-
-一般情况下，如果你只需要判断操作是否成功，只需要对比一下 `code` 是否为 200。如果非 200，可以在代码中通抛出异常或者任何你项目中使用的异常处理方式。
-
-```java
-import cn.authing.sdk.java.dto.*;
-import cn.authing.sdk.java.client.ManagementClient;
-import cn.authing.sdk.java.model.ManagementClientOptions;
-
-public static void main(String[] args) {
-    ManagementClientOptions clientOptions = new ManagementClientOptions("AUTHING_USERPOOL_ID", "AUTHING_USERPOOL_SECRET");
-    ManagementClient managementClient = new ManagementClient(clientOptions);
-    CreateRoleDto request = new CreateRoleDto();
-    request.setCode("code");
-    request.setNamespace("namespace");
-    request.setDescription("description");
-    RoleSingleRespDto response = managementClient.createRole(request);
-
-    if (response.getCode() != 200) {
-    throw new RuntimeException(response.getMessage()); // 抛出异常，由全局异常捕捉中间件进行异常捕捉
-    }
-
-    // 继续你的业务逻辑 ...
-}
-```
-
-## 私有化部署
-
-如果你使用的是私有化部署的 Authing IDaaS 服务，需要指定此 Authing 私有化实例的 `host`，如：
-
-```java
-import cn.authing.sdk.java.dto.*;
-import cn.authing.sdk.java.model.ManagementClientOptions;
-
-public class ManagementClientTest {
-
-    private static final String ACCESS_KEY_ID = "YOUR_ACCESS_KEY_ID";
-    private static final String ACCESS_KEY_SECRET = "YOUR_ACCESS_KEY_SECRET";
-    // 您的 Authing 私有化实例 HOST 地址，格式例如 https://core.authing.cn
-    private static final String HOST = "YOUR_HOST";
-    private ManagementClient managementClient = null;
-
-    public ManagementClientTest() {
-        ManagementClientOptions clientOptions = new ManagementClientOptions(ACCESS_KEY_ID, ACCESS_KEY_SECRET);
-        clientOptions.setHost(HOST);
-        managementClient = new ManagementClient(clientOptions);
-    }
-
-}
-```
-
-如果你不清楚如何获取，可以联系 Authing IDaaS 服务管理员。
-
-## 资源
-
-- [官网](https://authing.cn)
-- [开发者文档](https://docs.authing.cn/)
-- [Authing Open API](https://api.authing.cn/openapi/)
-- [SDK 文档](https://authing-open-api.readme.io/reference/nodejs)
-- [论坛社区](https://forum.authing.cn/)
-
-## 获取帮助
-
-有任何疑问，可以在 Authing 论坛提出: [#authing-forum](https://forum.authing.cn/)
+Copyright (c) 2019 Authing