1 Star 3 Fork 0

嘉诚开源 / jcoss-client-java-sdk

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

JCOSS Client JAVA SDK

介绍

JCOSS Client JAVA SDK 是嘉诚分布式对象存储系统提供的客户端JAVA SDK,使用户能够以应用程序的方式访问对象存储系统。

SDK快速入门

本文介绍如何快速使用JCOSS Java SDK完成常见操作,如创建存储桶(Bucket)、上传文件(Object)、下载文件(Object)等。

环境要求

  • Java 1.8
  • Maven3

示例工程

JCOSS Java SDK提供了基于Maven的示例工程。您可以在本地设备上编译和运行示例工程,或者以示例工程为基础开发您的应用。

安装SDK

本文基于 jdk1.8.0_144 版本编写。

对于在嘉诚公司内部部署的对象存储系统和客户自行安装的对象存储系统分别通过以下方式安装SDK:

  • 嘉诚公司内部的对象存储系统使用如下方式安装SDK:

在Maven工程中使用JCOSS Java SDK,只需在pom.xml中加入相应依赖即可。以21.07.02-alpha版本为例,在pom文件中加入如下内容:

<dependencies>
    <dependency>
        <groupId>com.jc.bdp</groupId>
        <artifactId>jcoss-client-java-sdk</artifactId>
        <version>v21.07.02-alpha</version>
    </dependency>
    <dependency>
        <groupId>org.yaml</groupId>
        <artifactId>snakeyaml</artifactId>
        <version>1.17</version>
    </dependency>
    <dependency>
        <groupId>commons-lang</groupId>
        <artifactId>commons-lang</artifactId>
        <version>2.6</version>
    </dependency>
    <dependency>
        <groupId>com.amazonaws</groupId>
        <artifactId>aws-java-sdk-s3</artifactId>
        <version>1.12.13</version>
    </dependency>
    <dependency>
        <groupId>org.apache.tika</groupId>
        <artifactId>tika-core</artifactId>
        <version>1.18</version>
    </dependency>
</dependencies>
  • 客户自行安装部署的对象存储系统使用如下方式安装SDK:
  1. 从gitee克隆SDK源码
git clone https://gitee.com/jiachengnet/jcoss-client-java-sdk.git
  1. 使用IntelliJ IDEA 编译源码,生成jcoss-client-java-sdk.jar

  2. 在IntelliJ IDEA中选择您的工程,右键选择File > Project Structure > Modules > Dependencies > + > JARs or directories,根据提示选择jcoss-client-java-sdk.jar即可

初始化

JCOSSClient是JCOSS的客户端,用于管理存储桶和对象等JCOSS资源。使用Java SDK发起JCOSS请求前,您需要在application.yml文件中完成配置项并初始化一个JCOSSClient实例。

秘钥获取请参考如何获取秘钥

通过配置文件方式配置并初始化一个JCOSSClient实例

说明:
JCOSSClient初始化时会默认创建一个以accessKey为名称的存储桶,也可以在上传对象前指定上传到哪个存储桶(上传对象前需先创建存储桶)

  1. JCOSSClient配置
    新建一个application.yml文件,将以下内容加入application.yml文件中并修改为您的endpoint、accesskey、secretkey所对应的配置信息
jcoss:
  endpoint: <JCOSS网关地址>
  accesskey: <yourAccessKey>
  secretkey: <yourSecretKey>
  1. 初始化一个JCOSSClient实例
JCOSSClient jcossClient = JCOSS.buildClient();

如何获取秘钥

由对象存储系统管理员创建租户并分配秘钥,创建命令如下:

  1. SSH登录到主控机,执行如下命令进入客户端,集群ID可从安装报告中获取;
cephadm shell --fsid <集群ID>
  1. 执行如下命令创建租户;从返回的JSON中可以获取到 asscessKey 和 secretKey;
radosgw-admin user create --tenant 租户标识 --uid 用户ID --display-name 显示的用户名称

说明:本示例中的租户标识为tenanta,用户ID为test

返回的JSON

{
    "user_id": "tenanta$test",
    "display_name": "test",
    "email": "",
    "suspended": 0,
    "max_buckets": 1000,
    "subusers": [],
    "keys": [
        {
            "user": "tenanta$test",
            "access_key": "N9DAMR4RI4WWUQD4H0S3",
            "secret_key": "bfOvAy9ia4oHy3USSzk40ObxCAYRsy5VmKWQ2RZA"
        }
    ],
    ...
}

创建存储桶

存储桶是JCOSS的全局命名空间,相当于对象的容器,可以存储若干对象。对象必须隶属于某个存储桶,在上传对象之前必须创建存储桶。以下代码用于创建存储桶:

// 创建一个JCOSSClient对象实例
JcossClient jcossClient = Jcoss.buildClient();

// 创建存储桶                
Bucket bucket = jcossClient.createBucket(testBucketName);

// 关闭JcossClient并释放资源
jcossClient.shutdown();

上传对象

上传对象前,您可以自定义文件元信息,也可以通过进度条功能查看上传进度。 如何查看上传进度请参考SDK使用手册-上传对象-进度条

// 创建一个JCOSSClient对象实例
JcossClient jcossClient = Jcoss.buildClient();

// 待上传的文件,包含文件后缀在内的完整路径,例如d:\\abc\\efg\\mypic.jpg               
File file = new File("d:\\abc\\efg\\mypic.jpg");

// 设置对象元信息
// 创建对象元数据实例
ObjectMetadata objectMetadata = new ObjectMetadata();
// 设置对象名称,用于下载时自动生成文件名,为必须参数
objectMetadata.addUserMetadata(ObjectEnum.NAME.name(),"mypic.jpg");
// 设置内容长度,为必须参数
objectMetadata.setContentLength(file.length());
// 设置内容类型,如果不设置,默认为application/octect-stream,非必须参数
objectMetadata.setContentType("image/jpeg");

// 开始上传
UploadObjectResult uploadResult = jcossClient.putObject(bucketName, file, objectMetadata);

// 关闭JcossClient并释放资源
jcossClient.shutdown();

说明:
JCOSSClient 在初始化时默认创建了一个存储桶,存储桶名称为accessKey。
使用默认的存储桶请参考 putObject(File file, ObjectMetadata objectMetadata) 方法。

下载对象

// 创建一个JCOSSClient对象实例
JcossClient jcossClient = Jcoss.buildClient();

// 存储桶名称
String bucketName = "mybucket";
// 对象的key,由上传对象后生成
String objectKey = "";
// 包含文件后缀在内的完整路径,例如d:\\abc\\efg\\mypic.jpg
String downloadFile = "d:\\abc\\efg\\mypic.jpg";

// 开始下载
jcossClient.getObject(bucketName, objectKey, downloadFile);

// 关闭JcossClient并释放资源
jcossClient.shutdown();
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

jcoss-client-java-sdk 是嘉诚分布式对象存储系统提供的客户端JAVA SDK,使用户能够以应用程序的方式访问对象存储系统。 展开 收起
Java
Apache-2.0
取消

发行版 (1)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/jiachengnet/jcoss-client-java-sdk.git
git@gitee.com:jiachengnet/jcoss-client-java-sdk.git
jiachengnet
jcoss-client-java-sdk
jcoss-client-java-sdk
develop

搜索帮助