Merge pull request #67 from caskdata/merge-release

Merge release

Author: albertshau

src/main/java/co/cask/http/BodyProducer.java

@@ -32,6 +32,8 @@ public abstract class BodyProducer {
    * won't be set and {@code Transfer-Encoding: chunked} will be used.
    * </p>
    * By default, {@code -1L} is returned.
+   *
+   * @return the size of the content in bytes
    */
   public long getContentLength() {
     return -1L;
@@ -41,6 +43,7 @@ public long getContentLength() {
    * Returns a {@link ByteBuf} representing the next chunk of bytes to send. If the returned
    * {@link ByteBuf} is an empty buffer, it signals the end of the streaming.
    *
+   * @return the next chunk of bytes to send
    * @throws Exception if there is any error
    */
   public abstract ByteBuf nextChunk() throws Exception;

src/main/java/co/cask/http/HttpResponder.java

@@ -95,6 +95,7 @@ public interface HttpResponder {
    * using the {@link ChunkResponder} returned.
    *
    * @param status the status code to respond with
+   * @return chunk responder for sending the response
    */
   ChunkResponder sendChunkStart(HttpResponseStatus status);
 
@@ -104,6 +105,7 @@ public interface HttpResponder {
    *
    * @param status the status code to respond with
    * @param headers additional headers to send with the response.
+   * @return chunk responder for sending the response
    */
   ChunkResponder sendChunkStart(HttpResponseStatus status, HttpHeaders headers);
 

src/main/java/co/cask/http/NettyHttpService.java

@@ -144,6 +144,7 @@ private NettyHttpService(String serviceName,
    * Creates a {@link Builder} for creating new instance of {@link NettyHttpService}.
    *
    * @param serviceName name of the http service. The name will be used to name threads created for the service.
+   * @return builder for creating a NettyHttpService
    */
   public static Builder builder(String serviceName) {
     return new Builder(serviceName);
@@ -625,26 +626,44 @@ public Builder setHost(String host) {
       return this;
     }
 
+    /**
+     * Set the HTTP chunk limit.
+     *
+     * @param value the chunk limit
+     * @return instance of {@code Builder}.
+     */
     public Builder setHttpChunkLimit(int value) {
       this.httpChunkLimit = value;
       return this;
     }
 
     /**
      * Enable SSL by using the provided SSL information.
+     *
+     * @param sslConfig the SSL configuration
+     * @return instance of {@code Builder}.
      */
     public Builder enableSSL(SSLConfig sslConfig) {
       return enableSSL(new SSLHandlerFactory(sslConfig));
     }
 
     /**
      * Enable SSL by using the given {@link SSLHandlerFactory} to create {@link SslHandler}.
+     *
+     * @param sslHandlerFactory the factory for creating SslHandlers
+     * @return instance of {@code Builder}.
      */
     public Builder enableSSL(SSLHandlerFactory sslHandlerFactory) {
       this.sslHandlerFactory = sslHandlerFactory;
       return this;
     }
 
+    /**
+     * Set the {@link ExceptionHandler} for the service.
+     *
+     * @param exceptionHandler the exception handler to use
+     * @return instance of {@code Builder}.
+     */
     public Builder setExceptionHandler(ExceptionHandler exceptionHandler) {
       if (exceptionHandler == null) {
         throw new IllegalArgumentException("exceptionHandler cannot be null");

src/main/java/co/cask/http/SSLConfig.java

@@ -73,6 +73,10 @@ public String getTrustKeyStorePassword() {
   }
 
   /**
+   * Creates a builder for the SSLConfig.
+   *
+   * @param keyStore the keystore
+   * @param keyStorePassword the password for the keystore
    * @return instance of {@code Builder}
    */
   public static Builder builder(File keyStore, String keyStorePassword) {

src/main/java/co/cask/http/SSLHandlerFactory.java

@@ -78,6 +78,9 @@ private static KeyStore getKeyStore(File keyStore, String keyStorePassword) thro
   }
 
   /**
+   * Creates an SslHandler
+   *
+   * @param bufferAllocator the buffer allocator
    * @return instance of {@code SslHandler}
    */
   public SslHandler create(ByteBufAllocator bufferAllocator) {

src/main/java/co/cask/http/package-info.java

@@ -19,7 +19,7 @@
  * {@code NettyHttpService} sets up the necessary pipeline and manages starting, stopping,
  * state-management of the web service.
  *
- * <p/>
+ * <p>
  * In-order to handle http requests, {@code HttpHandler} must be implemented. The methods
  * in the classes implemented from {@code HttpHandler} must be annotated with Jersey annotations to
  * specify http uri paths and http methods.