Skip to content

Commit fa67d58

Browse files
dengwu12dengwu12
committed
oss java sdk
1 parent 4cff025 commit fa67d58

File tree

242 files changed

+33205
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

242 files changed

+33205
-1
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.svn

‎META-INF/LICENSE.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Copyright (C) Alibaba Cloud Computing
2+
All rights reserved.
3+
4+
版权所有 （C）阿里云计算有限公司
5+
6+
http://www.aliyun.com

‎META-INF/MANIFEST.MF

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Manifest-Version: 1.0
2+
Sealed: true
3+
Created-By: Alibaba Cloud Computing
4+
Implementation-Title: Aliyun OSS SDK for Java
5+
Implementation-Version: 1.0.0
6+
url: http://www.aliyun.com

‎README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,27 @@
1-
# aliyun-oss-java-sdk
1+
# OSS SDK for Java Developers
2+
3+
## Requirements
4+
5+
- Java 6+
6+
7+
## Build
8+
9+
```shell
10+
git clone ...
11+
cd aliyun-oss-java-sdk
12+
mvn clean packge -DskipTests
13+
```
14+
15+
- to run function tests, you will have to config user account in src/test/java/com/aliyun/oss/integrationtests/TestConfig.java,
16+
- to run performance tests, you will have to config user account in runner_conf.xml,
17+
and make sure your project has corresponding service enabled.
18+
19+
20+
## Authors && Contributors
21+
22+
- [Xing Mengbang](https://github.com/xingfeng2510)
23+
- [Zhang Ting](https://github.com/dengwu12)
24+
25+
## License
26+
27+
licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html)

‎doc/guide/Makefile

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
BUILDDIR = _build
9+
10+
# Internal variables.
11+
PAPEROPT_a4 = -D latex_paper_size=a4
12+
PAPEROPT_letter = -D latex_paper_size=letter
13+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14+
# the i18n builder cannot share the environment and doctrees with the others
15+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
16+
17+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
18+
19+
help:
20+
@echo "Please use \`make <target>' where <target> is one of"
21+
@echo " html to make standalone HTML files"
22+
@echo " dirhtml to make HTML files named index.html in directories"
23+
@echo " singlehtml to make a single large HTML file"
24+
@echo " pickle to make pickle files"
25+
@echo " json to make JSON files"
26+
@echo " htmlhelp to make HTML files and a HTML help project"
27+
@echo " qthelp to make HTML files and a qthelp project"
28+
@echo " devhelp to make HTML files and a Devhelp project"
29+
@echo " epub to make an epub"
30+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
31+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
32+
@echo " text to make text files"
33+
@echo " man to make manual pages"
34+
@echo " texinfo to make Texinfo files"
35+
@echo " info to make Texinfo files and run them through makeinfo"
36+
@echo " gettext to make PO message catalogs"
37+
@echo " changes to make an overview of all changed/added/deprecated items"
38+
@echo " linkcheck to check all external links for integrity"
39+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
40+
41+
clean:
42+
-rm -rf $(BUILDDIR)/*
43+
44+
html:
45+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
46+
@echo
47+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
48+
49+
dirhtml:
50+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
51+
@echo
52+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
53+
54+
singlehtml:
55+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
56+
@echo
57+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
58+
59+
pickle:
60+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
61+
@echo
62+
@echo "Build finished; now you can process the pickle files."
63+
64+
json:
65+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
66+
@echo
67+
@echo "Build finished; now you can process the JSON files."
68+
69+
htmlhelp:
70+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
71+
@echo
72+
@echo "Build finished; now you can run HTML Help Workshop with the" \
73+
".hhp project file in $(BUILDDIR)/htmlhelp."
74+
75+
qthelp:
76+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
77+
@echo
78+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
79+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
80+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OSS-Java.qhcp"
81+
@echo "To view the help file:"
82+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OSS-Java.qhc"
83+
84+
devhelp:
85+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
86+
@echo
87+
@echo "Build finished."
88+
@echo "To view the help file:"
89+
@echo "# mkdir -p $$HOME/.local/share/devhelp/OSS-Java"
90+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OSS-Java"
91+
@echo "# devhelp"
92+
93+
epub:
94+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
95+
@echo
96+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
97+
98+
latex:
99+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
100+
@echo
101+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
102+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
103+
"(use \`make latexpdf' here to do that automatically)."
104+
105+
latexpdf:
106+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
107+
@echo "Running LaTeX files through pdflatex..."
108+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
109+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
110+
111+
text:
112+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
113+
@echo
114+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
115+
116+
man:
117+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
118+
@echo
119+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
120+
121+
texinfo:
122+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
123+
@echo
124+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
125+
@echo "Run \`make' in that directory to run these through makeinfo" \
126+
"(use \`make info' here to do that automatically)."
127+
128+
info:
129+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
130+
@echo "Running Texinfo files through makeinfo..."
131+
make -C $(BUILDDIR)/texinfo info
132+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
133+
134+
gettext:
135+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
136+
@echo
137+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
138+
139+
changes:
140+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
141+
@echo
142+
@echo "The overview file is in $(BUILDDIR)/changes."
143+
144+
linkcheck:
145+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
146+
@echo
147+
@echo "Link check complete; look for any errors in the above output " \
148+
"or in $(BUILDDIR)/linkcheck/output.txt."
149+
150+
doctest:
151+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
152+
@echo "Testing of doctests in the sources finished, look at the " \
153+
"results in $(BUILDDIR)/doctest/output.txt."

‎doc/guide/OSSClient.rst

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
.. _ossclient-top:
2+
3+
*********
4+
OSSClient
5+
*********
6+
7+
OSSClient是OSS服务的Java客户端，它为调用者提供了一系列的方法，用于和OSS服务进行交互。
8+
9+
新建OSSClient
10+
================
11+
12+
新建一个OSSClient很简单，如下面代码所示：
13+
14+
.. code-block:: java
15+
16+
String key = "<key>";
17+
String secret = "<secret>";
18+
OSSClient client = new OSSClient(key, secret);
19+
20+
上面的方式使用默认域名作为OSS的服务地址，如果你想自己指定域名，可以传入endpoint参数来指定。
21+
22+
.. code-block:: java
23+
24+
String key = "<key>";
25+
String secret = "<secret>";
26+
String endpoint = "http://oss.aliyuncs.com";
27+
OSSClient client = new OSSClient(endpoint, accessKeyId, accessKeySecret);
28+
29+
配置OSSClient
30+
==============
31+
32+
如果你想配置OSSClient的一些细节的参数，可以在构造OSSClient的时候传入ClientConfiguration对象。
33+
ClientConfiguration是OSS服务的配置类，可以为客户端配置代理，最大连接数等参数。
34+
35+
使用代理
36+
----------
37+
38+
下面一段代码可以使客户端使用代理访问OSS服务：
39+
40+
.. code-block:: java
41+
42+
// 创建ClientConfiguration实例
43+
ClientConfiguration conf = new ClientConfiguration();
44+
45+
// 配置代理为本地8080端口
46+
conf.setProxyHost("127.0.0.1");
47+
conf.setProxyPort(8080);
48+
49+
// 创建OSS客户端
50+
client = new OSSClient(endpoint, accessKeySecret, accessKeySecret, conf);
51+
52+
上面代码使得客户端的所有操作都会使用127.0.0.1地址的8080端口做代理执行。
53+
54+
对于有用户验证的代理，可以配置用户名和密码：
55+
56+
.. code-block:: java
57+
58+
// 创建ClientConfiguration实例
59+
ClientConfiguration conf = new ClientConfiguration();
60+
61+
// 配置代理为本地8080端口
62+
conf.setProxyHost("127.0.0.1");
63+
conf.setProxyPort(8080);
64+
65+
//设置用户名和密码
66+
conf.setProxyUsername("username");
67+
conf.setProxyPassword("password");
68+
69+
设置网络参数
70+
------------
71+
72+
我们可以用ClientConfiguration设置一些网络参数：
73+
74+
.. code-block:: java
75+
76+
ClientConfiguration conf = new ClientConfiguration();
77+
78+
// 设置HTTP最大连接数为10
79+
conf.setMaxConnections(10);
80+
81+
// 设置TCP连接超时为5000毫秒
82+
conf.setConnectionTimeout(5000);
83+
84+
// 设置最大的重试次数为3
85+
conf.setMaxErrorRetry(3);
86+
87+
// 设置Socket传输数据超时的时间为2000毫秒
88+
conf.setSocketTimeout(2000);
89+
90+
ClientConfiguration所有参数
91+
------------------------------
92+
93+
通过ClientConfiguration能指定的所有参数如下表所示：
94+
95+
================== =====================================================
96+
参数 说明
97+
================== =====================================================
98+
UserAgent 用户代理，指HTTP的User-Agent头。默认为"aliyun-sdk-java"
99+
ProxyHost 代理服务器主机地址
100+
ProxyPort 代理服务器端口
101+
ProxyUsername 代理服务器验证的用户名
102+
ProxyPassword 代理服务器验证的密码
103+
ProxyDomain 访问NTLM验证的代理服务器的Windows域名
104+
ProxyWorkstation NTLM代理服务器的Windows工作站名称
105+
MaxConnections 允许打开的最大HTTP连接数。默认为50
106+
SocketTimeout 通过打开的连接传输数据的超时时间（单位：毫秒）。默认为50000毫秒
107+
ConnectionTimeout 建立连接的超时时间（单位：毫秒）。默认为50000毫秒
108+
MaxErrorRetry 可重试的请求失败后最大的重试次数。默认为3次
109+
================== =====================================================
110+
111+
112+
113+
114+
115+
116+
117+
118+

0 commit comments

Comments
 (0)