Merge pull request #1 from aliyun/develop

Develop

Author: whybert

.travis.yml

@@ -0,0 +1,11 @@
+language: java
+jdk:
+- openjdk6
+- oraclejdk7
+- oraclejdk8
+env:
+  global:
+  - secure: SimZMTg4ZlUmeko5nIngk+NPMHA+nHZi9Bid8fFi7g4V3hkRjKByQgGoO+5GQzZacRttxosczAKkJ65tejgHZ3rcTBKqljOJ5Dw3jbh4+ABYLH9cY+GzEIodQvgpJzjcGqeWZNUlYdmEqXKsFEZcDdgvnDJJtkrHg8YQmJEwk9DVtyCnHYapXAcsK6xlaB14GIuLKbyZMw3n4tJ33+afusUdIXT1eJtYP3zKjY8VnHZWHFXnvrN7F7pynnKON8WSx4NZa3Wov290ByhPYglSdFTVX9zul7hPD4ZMfCJ5Om3Iz1O1m5yvLckn/y2IBwIGraXgvlXMKhqMMlb9Zvy2mmZWIOViOl/gG7g6LzbGbJMmj4vD95/Iv3FPO/j+M2F/xRUxjaGPIvhzP1Cd+P0NUZxPo5JQj0JYikDx0PTQd8RTOnzQ71YMXPbiL8Td1NcxwLrLqQLU5/lUoLIxusTDeMOu0EGbK43HAU6AlyAtxgjsTiva8OmR/AjfdHINotiBchoYjq9ZRrBzxakBvDLr+gnYn8UAdm6AoE8DOhz3ZoIgFiyjvNkQ31wWacoZrCoszY4ZE2QBwhXyfq7iAqJkPtg4qiftLnmOEMeyLEnKJM/kFk2tpYhxyBgLbxjdRG4WHaIXjE7lmKpzsPy43WnWJQMYFI3BuuC0dfDjuRbjy5s=
+  - secure: DXaytAv0L3pV8GlTbcCe0u0ajKDxnZhLnvBk3d8w9Y0AuncgWw4BMngeG2n+kATILRJwV0TS3a0yMRTqMF8o4yWwguHZtqKkU5dvWtbfQowoYaFbXkJZOCkaJL89h0LMTzTyXxNUQurp/U3XDSQARxyoXKBd65eZmj06oRIm5GyzQvc3kKzke7Jy/WhQ5r+3aEm0qUwomwaLVI9KFY81qo5eXkbndF1VLIhELhQgpB+brWUoRnzjssYIYPsYUgeTHrdhgePXbGP5Rk7T9OK/+giNCt4c5PLqUpnQ0SK4gGVpukAxKvoA/5KMxefrPdDypQ6If/TC01B7tYbH8QP88C0vZKccJlKyh9CLMmW3HBRFXGfMXISky1Kwn/8OCUZZrUISvGcDRAVmZx6+cOg6qbhYGHPjbJELA71mVRaIQfm8yQGXpPZeikpSLttzPAZMPb8Dgy3fGOlh3jppipeWO9jv2tJPaMnWBBVoXuWEpJXQXiRhhYrK7RLlBBJLyS3DGVd9c2G2b7o8SXPfQuvcxSMloEQtbBJUC0DENXwFwcfuNo1STGUrsHuUaLgRzjzL1tmkcDp8tU9f01qbhjrCHolWJTOFISDu8xQWPkWFapihWfrhshNizjnagicFxBgD6zhjSXgXHLEZQnkzgkBugToZZB+K4wDKD3xTaR8rt70=
+  - secure: QEQ2B9+5jinULaZgWAelkndYg+0RAczxv9OSEMYxEj9kzr8W6EJYeZi/KsTAY6kKI4IDZwptclDbKF+uVAruQ52UtDiNIu69AWfdYu2IL1YwQ3YGJRFtvA0qZpELAY3VHyB6zR9Qm0A1DeDtcYglL+QUlwL54lqVnz8Z+4hp8zikGKb7nYl+8oztWGYaghQSf641/7nZuZFyhOzhS34CN7tWEM8aSzYxBVg2G4x6bYTgbGJL00blzENbyqrWe4ZsMCXc1AWtxNLtS8TalOJxISKw97Gx5EksbSKPaaEhlfik1ooQ+w2UAgMAeSrcaMhFoOqZ6QLItoFveVu1CskHHwHngp7OziemroOG/8Ef8m11lVloZIRc7qogivYPHxhoFD49+n0xiaWsMXMOtUzP74z5T4P5AvbVtq4qycyCAxgMqh2c/wqTkezUQC+cw1Qho6kJM/bAxfyLPSOvOWMKbrRU09sM5/OA0+1JiU1QYbVuYY9w/z+9MaRMaFTsIioWWyAD8FF5TSMroBsjkFsQm7/uZFxWXFFZt8d6Tnq28nZfW31T0PwtIr8jknRe9p3ijLqqRh1i13DIE5u13ZyKsLJEBZyJdPyA3g3+oq7UfKFbIxFdjRM3JA+FQVh5yvrfxqu5qgC0RaU4uMXDu6Vg9AvuSVNedo9JjVjFwCcTU6Q=
+  - secure: gcOuRG1xp+o17hL2X29qPikn1Hkl2NI0TRSnbuiT8n8gZrpyrP3+BpDR/XxbedrOGLgU6lZFGY3ZX6m1+8aD2Xkh9nCK/X1TakJ02qSDzpvpBBHbroyd9fWS4Y6bMGNkdzO102MMg6q9ICiFhcOaxz7mFHt49TBlVI+YqL2xRUXOHq/ZMdopLiVxjpATXdFb9NV9MqVsCS/7XV9+o61QVqfpvHErbiKK7AqMj7X5VJjwDfW28tJHmq8VeFh4ZGzvEn7HF85Aq7W6FCuacejdP3rmY5z5yz5Z1kZTFV22+yXLKqe1Gt4yCn2lufw0soQTW+++2yVj9tgH/g7y9/YrDJbkjCfpYwOXRjQIS7NHMWB8qngMn4sGajt9VWTCP8EDx6WYdoYzOeq+grl1dH+pdwxtgmp+0nAZMsBwc16t+X6Jbx5yTu4mtacZOi/yTuy/3Zaas464XwW83oRHpw0PNi1H6lwmmJGW1+4L9HqqdDzjT/xeqwPGpcrSdAR6ENWSxaKfcVmfGt4BFDKzCW0LVSV555pW4lJMlzEr/L2DtL9QdpPGPtcAFfHuuzQBGt0i6cn4GRe+mMWatBnmlVX8Jb8VbOloWOWD4R3AzcQzso4FRtuUoQdFeQ+cVM7pzY8EhSoGkn8cbljOT/MVusdkfH03vVVUJnD2mLvjaSlqtwA=

README.md

@@ -1,7 +1,8 @@
-# Aliyun TableStore SDK for JAVA
+# Aliyun TableStore SDK for JAVA
 
 [![Software License](https://img.shields.io/badge/license-apache2-brightgreen.svg)](LICENSE)
 [![GitHub version](https://badge.fury.io/gh/aliyun%2Faliyun-tablestore-java-sdk.svg)](https://badge.fury.io/gh/aliyun%2Faliyun-tablestore-java-sdk)
+[![Build Status](https://travis-ci.org/aliyun/aliyun-tablestore-java-sdk.svg)](https://travis-ci.org/aliyun/aliyun-tablestore-java-sdk)
 
 ## 关于
  - 此JAVA SDK基于[阿里云表格存储服务](http://www.aliyun.com/product/ots/) API构建。
@@ -15,7 +16,7 @@
 
 ## 安装
 #### Maven方式
-下载[最新版JAR](https://search.maven.org/remote_content?g=com.aliyun.openservices&a=ots-public&v=LATEST)或者通过Maven：
+下载[最新版JAR包](https://search.maven.org/remote_content?g=com.aliyun.openservices&a=ots-public&v=LATEST)或者通过Maven：
 ```xml
 <dependency>
     <groupId>com.aliyun.openservices</groupId>

pom.xml

@@ -12,9 +12,8 @@
 
   <licenses>
     <license>
-      <name></name>
-      <url></url>
-      <distribution></distribution>
+      <name>The Apache Software License, Version 2.0</name>
+      <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
     </license>
   </licenses>
   <scm>
@@ -92,7 +91,7 @@
         <configuration> 
           <source>1.6</source>  
           <target>1.6</target>  
-          <encoding>UTF-8</encoding> 
+          <encoding>utf-8</encoding>
         </configuration> 
       </plugin>
         <plugin>
@@ -228,31 +227,6 @@
           </execution> 
         </executions> 
       </plugin>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-gpg-plugin</artifactId>
-        <version>1.5</version>
-        <executions>
-          <execution>
-            <id>sign-artifacts</id>
-            <phase>verify</phase>
-            <goals>
-              <goal>sign</goal>
-            </goals>
-          </execution>
-        </executions>
-      </plugin>
-      <plugin>
-        <groupId>org.sonatype.plugins</groupId>
-        <artifactId>nexus-staging-maven-plugin</artifactId>
-        <version>1.6.3</version>
-        <extensions>true</extensions>
-        <configuration>
-          <serverId>sonatype-nexus-staging</serverId>
-          <nexusUrl>https://oss.sonatype.org/</nexusUrl>
-          <autoReleaseAfterClose>true</autoReleaseAfterClose>
-        </configuration>
-      </plugin>
     </plugins> 
   </build>  
 </project>

src/main/java/com/aliyun/openservices/ots/DefaultOTSWriter.java

@@ -5,7 +5,6 @@
 import com.aliyun.openservices.ots.internal.writer.RowChangeEventHandler;
 import com.aliyun.openservices.ots.internal.writer.WriterConfig;
 import com.aliyun.openservices.ots.model.*;
-import com.aliyun.openservices.ots.utils.CalculateHelper;
 import com.aliyun.openservices.ots.utils.ParamChecker;
 import com.aliyun.openservices.ots.utils.Preconditions;
 import com.lmax.disruptor.InsufficientCapacityException;

src/main/java/com/aliyun/openservices/ots/OTSWriter.java

@@ -10,16 +10,16 @@
 /**
  * OTS提供了BatchWriteRow接口让用户能够向OTS批量导入数据，但是在实际使用过程中，BatchWriteRow接口的使用方式对开发者并不友好。例如用户
  * 需要自己计算并控制一次BatchWriteRow的数据量大小，需要关注行大小或者列大小是否超过OTS的限制，需要对主键去重以及处理单行错误的重试等等。
- * <p/>
+ *
  * OTSWriter旨在针对批量数据导入的场景提供一个更加易用的接口，但是不是所有场景均适用OTSWriter，在使用之前，请详细了解它的行为，否则会造成数据正确性的问题：
  *     - OTSWriter所有接口保证线程安全。
  *     - 调用{@link #addRowChange}接口向OTSWriter写入一行返回后，并不代表该行已经写入OTS，该行会保存在OTSWriter的本地缓冲中，等待flush，flush成功后该行才会被写入OTS。
  *     - 向OTSWriter写入的行的顺序与最终写入OTS的行的顺序不保证一致。
  *     - 所有通过OTSWriter的写入操作，需要使用者保证是幂等的，因为OTSWriter内部默认会启用重试，某一行可能会多次写入。
- *     - OTSWriter对缓冲区的flush时机由两个因素来控制：一个是<string>flushInterval</string>，根据时间定期的进行flush；
+ *     - OTSWriter对缓冲区的flush时机由两个因素来控制：一个是flushInterval，根据时间定期的进行flush；
  *       另一个是{@link com.aliyun.openservices.ots.internal.writer.WriterConfig#maxBatchSize}，根据缓冲区的数据量来决定是否需要flush。
  *     - OTSWriter在写入数据时，会自动对导入失败的行进行重试，但是并不保证所有行重试后最终一定能够被写入成功（例如：某一行在OTS中已经超过了256KB限制，则无法再向该行写入新的列）。
- *       此时经过若干次重试后若还有数据无法被写入成功，则这些行会被认为是脏数据，脏数据会通过<string>OTSCallback</string>反馈给使用者。
+ *       此时经过若干次重试后若还有数据无法被写入成功，则这些行会被认为是脏数据，脏数据会通OTSCallback反馈给使用者。
  *     - 再向OTSWriter写入数据之前，请先注册好Callback，否则若在注册CallBack之前已经有数据写入失败，则失败的行会直接被抛弃。
  *     - 程序退出前，需要显式调用{@link #flush}或{@link #close}，将还存在缓冲区中的数据进行flush，否则会造成这部分数据丢失。
  *
@@ -38,20 +38,20 @@
 public interface OTSWriter {
     /**
      * 向本地缓冲区增加一行数据。
-     * <p/>
+     *
      * 在写入缓冲区之前，会对该行数据做如下检查：
      *  - 该行的主键的Schema是否与表定义的相同。
      *  - 该行的主键列或属性列的值大小是否超过限制，值的限制配置在{@link com.aliyun.openservices.ots.internal.writer.WriterConfig#maxPKColumnSize}和{@link com.aliyun.openservices.ots.internal.writer.WriterConfig#maxAttrColumnSize}。
      *  - 该行的属性列的个数是否超过{@link com.aliyun.openservices.ots.internal.writer.WriterConfig#maxColumnsCount}。
      *  - 该行的大小是否超过{@link com.aliyun.openservices.ots.internal.writer.WriterConfig#maxBatchSize}。
      *  - 属性列中是否有列名与主键列相同。
      *
-     * 若在写入缓冲区之前被判定为脏数据，该部分数据不会触发CallBack的调用。<br/>
+     * 若在写入缓冲区之前被判定为脏数据，该部分数据不会触发CallBack的调用。
      *
      * 以上检查会在SDK端带来额外的CPU消耗，但是这些检查是必要的，为了减少不必要的RPC开销，以及避免脏数据污染同一批次Batch写入的行。
-     * <p/>
+     *
      * 注意：若缓冲区满，则该操作会被block。
-     * <p/>
+     *
      * 若判断该行为脏数据，该接口会抛出{@link com.aliyun.openservices.ots.ClientException}。
      *
      * @param rowChange 要写入的行
@@ -61,9 +61,9 @@ public interface OTSWriter {
 
     /**
      * 向本地缓冲区批量写入行。
-     * <p/>
+     *
      * 批量写入的每一行会做与{@link #addRowChange(RowChange)}一样的检查，若批量写入的行中存在脏数据，则该函数会抛{@link ClientException}，
-     * 且所有的脏数据会写入{@param dirtyRows}。
+     * 且所有的脏数据会写入dirtyRows。
 
      * @param rowChanges 批量写入的行
      * @param dirtyRows 用于传出脏数据的列表
@@ -73,7 +73,7 @@ public interface OTSWriter {
 
     /**
      * 设置Callback，数据写入成功或者失败均会通过Callback来反馈。
-     * <br/>
+     *
      * 注意：callback会被写入OTSWriter的所有行共享，会被并发的调用。
      * 这与{@link com.aliyun.openservices.ots.OTSAsync}中每个接口的Callback不同，其callback会与每个请求一一对应，且可以是独立的。
      * 但是这里的Callback是与RowChange对应，且所有RowChange都共享该callback。
@@ -98,14 +98,14 @@ public interface OTSWriter {
 
     /**
      * 主动flush缓冲区中的数据，该函数会等待缓冲区中的所有数据被flush完毕。
-     * <p/>
+     *
      * 注意：若在调用flush之后继续向缓冲区中写入数据，flush不会等待这部分新数据的写入，新数据的flush需要重新调用一次flush。
      */
     public void flush() throws ClientException;
 
     /**
      * 关闭OTSWriter，在关闭之前，会先flush掉缓冲区内的所有数据。
-     * <p/>
+     *
      * 注意：若在close过程中或者close之后仍然调用{@link #addRowChange}向缓冲区写入数据，则该部分数据不保证会写入OTS。
      */
     public void close();

src/main/java/com/aliyun/openservices/ots/auth/ServiceCredentials.java

@@ -73,6 +73,8 @@ public ServiceCredentials(String accessKeyId, String accessKeySecret){
      *          Access Key ID。
      * @param accessKeySecret
      *          Access Key Secret。
+     * @param stsToken
+     *          Aliyun STS token value
      * @exception NullPointerException accessKeyId或accessKeySecret为空指针。
      */
     public ServiceCredentials(String accessKeyId, String accessKeySecret, String stsToken){
@@ -84,7 +86,7 @@ public ServiceCredentials(String accessKeyId, String accessKeySecret, String sts
     /**
      * 获取短期访问凭证。
      * 详细信息请参考阿里云STS (Security Token Service) 服务文档。
-     * @return
+     * @return token value
      */
     public String getStsToken() {
         return stsToken;
@@ -93,7 +95,7 @@ public String getStsToken() {
     /**
      * 设置短期访问凭证。
      * 详细信息请参考阿里云STS (Security Token Service) 服务文档。
-     * @param stsToken
+     * @param stsToken STS的临时token值
      */
     public void setStsToken(String stsToken) {
         this.stsToken = stsToken;

src/main/java/com/aliyun/openservices/ots/comm/ExecutionContext.java

@@ -23,7 +23,7 @@ public ExecutionContext() {
     /**
      * Returns the default encoding (charset). Default: "UTF-8"
      * 
-     * @return
+     * @return 编码类型
      */
     public String getCharset() {
         return charset;
@@ -32,7 +32,7 @@ public String getCharset() {
     /**
      * Sets the default encoding (charset). Default: "UTF-8"
      * 
-     * @param defaultEncoding
+     * @param defaultEncoding 编码类型
      */
     public void setCharset(String defaultEncoding) {
         this.charset = defaultEncoding;

src/main/java/com/aliyun/openservices/ots/comm/RequestHandler.java

@@ -11,6 +11,9 @@ public interface RequestHandler {
 
     /**
      * 预处理需要发送的请求数据
+     * @param message 请求数据
+     * @throws ServiceException
+     * @throws ClientException
      */
     public void handle(RequestMessage message)
             throws ServiceException, ClientException;

src/main/java/com/aliyun/openservices/ots/comm/ResponseHandler.java

@@ -11,6 +11,9 @@ public interface ResponseHandler {
 
     /**
      * 处理返回的结果
+     * @param responseData 服务器返回的数据
+     * @throws ServiceException
+     * @throws ClientException
      */
     public void handle(ResponseMessage responseData)
             throws ServiceException, ClientException;

src/main/java/com/aliyun/openservices/ots/internal/OTSAlwaysRetryStrategy.java

@@ -35,7 +35,7 @@ public void setMaxRetryPauseInMillis(int maxRetryPauseInMillis) {
      *
      * @param action  操作名，比如"ListTable"、"GetRow"、"PutRow"等
      * @param ex      上次访问失败的错误信息、为ClientException或OTSException
-     * @param retries 表示本次判断的为第retries次重试，retries > 0
+     * @param retries 表示本次判断的为第retries次重试，retries 大于 0
      * @return
      */
     @Override
@@ -52,7 +52,7 @@ public boolean shouldRetry(String action, Exception ex, int retries) {
      *
      * @param action  操作名，比如"ListTable"、"GetRow"、"PutRow"等
      * @param ex      上次访问失败的错误信息、为ClientException或OTSException
-     * @param retries 表示将要发起第retries次重试， retries > 0
+     * @param retries 表示将要发起第retries次重试， retries 大于 0
      * @return
      */
     @Override