Added some javadoc

Marcus Linke · Marcus Linke · commit d5dbb5de4598 · 2015-12-14T21:04:01.000+01:00
diff --git a/src/main/java/com/github/dockerjava/netty/DockerCmdExecFactoryImpl.java b/src/main/java/com/github/dockerjava/netty/DockerCmdExecFactoryImpl.java
@@ -27,8 +27,6 @@
 import javax.net.ssl.SSLParameters;
 
 import org.bouncycastle.jce.provider.BouncyCastleProvider;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 import com.github.dockerjava.api.command.AttachContainerCmd;
 import com.github.dockerjava.api.command.AuthCmd;
@@ -70,6 +68,7 @@
 import com.github.dockerjava.api.command.VersionCmd;
 import com.github.dockerjava.api.command.WaitContainerCmd;
 import com.github.dockerjava.core.DockerClientConfig;
+import com.github.dockerjava.core.DockerClientImpl;
 import com.github.dockerjava.netty.exec.AttachContainerCmdExec;
 import com.github.dockerjava.netty.exec.AuthCmdExec;
 import com.github.dockerjava.netty.exec.BuildImageCmdExec;
@@ -110,17 +109,27 @@
 import com.github.dockerjava.netty.exec.WaitContainerCmdExec;
 
 /**
- * http://stackoverflow.com/questions/33296749/netty-connect-to-unix-domain-socket-failed
- * http://netty.io/wiki/native-transports.html
- * https://github.com/netty/netty/blob/master/example/src/main/java/io/netty/example/http/snoop/HttpSnoopClient.java
- * https://github.com/slandelle/netty-request-chunking/blob/master/src/test/java/slandelle/ChunkingTest.java
+ * Experimental implementation of {@link DockerCmdExecFactory} that supports http connection hijacking that is needed to
+ * pass STDIN to the container.
  *
- * @author Marcus Linke
+ * To use it just pass an instance via {@link DockerClientImpl#withDockerCmdExecFactory(DockerCmdExecFactory)}
+ *
+ * @see https://docs.docker.com/engine/reference/api/docker_remote_api_v1.21/#attach-to-a-container
+ * @see https://docs.docker.com/engine/reference/api/docker_remote_api_v1.21/#exec-start
  *
+ *
+ * @author Marcus Linke
  */
 public class DockerCmdExecFactoryImpl implements DockerCmdExecFactory {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(DockerCmdExecFactoryImpl.class.getName());
+    /*
+     * useful links:
+     *
+     * http://stackoverflow.com/questions/33296749/netty-connect-to-unix-domain-socket-failed
+     * http://netty.io/wiki/native-transports.html
+     * https://github.com/netty/netty/blob/master/example/src/main/java/io/netty/example/http/snoop/HttpSnoopClient.java
+     * https://github.com/slandelle/netty-request-chunking/blob/master/src/test/java/slandelle/ChunkingTest.java
+     */
 
     private DockerClientConfig dockerClientConfig;
 
diff --git a/src/main/java/com/github/dockerjava/netty/InvocationBuilder.java b/src/main/java/com/github/dockerjava/netty/InvocationBuilder.java
@@ -45,6 +45,12 @@
 import com.github.dockerjava.netty.handler.HttpResponseStreamHandler;
 import com.github.dockerjava.netty.handler.JsonResponseCallbackHandler;
 
+/**
+ * This class is basically a replacement of javax.ws.rs.client.Invocation.Builder to allow simpler
+ * migration of JAX-RS code to a netty based implementation.
+ *
+ * @author Marcus Linke
+ */
 public class InvocationBuilder {
 
     public class ResponseCallback<T> extends ResultCallbackTemplate<ResponseCallback<T>, T> {
diff --git a/src/main/java/com/github/dockerjava/netty/MediaType.java b/src/main/java/com/github/dockerjava/netty/MediaType.java
@@ -1,5 +1,11 @@
 package com.github.dockerjava.netty;
 
+/**
+ * This class is basically a replacement of javax.ws.rs.core.MediaType to allow simpler
+ * migration of JAX-RS code to a netty based implementation.
+ *
+ * @author Marcus Linke
+ */
 public enum MediaType {
 
 	APPLICATION_JSON("application/json"),
diff --git a/src/main/java/com/github/dockerjava/netty/WebTarget.java b/src/main/java/com/github/dockerjava/netty/WebTarget.java
@@ -8,6 +8,12 @@
 
 import org.apache.commons.lang.StringUtils;
 
+/**
+ * This class is basically a replacement of javax.ws.rs.client.WebTarget to allow simpler
+ * migration of JAX-RS code to a netty based implementation.
+ *
+ * @author Marcus Linke
+ */
 public class WebTarget {
 
     private ChannelProvider channelProvider;
diff --git a/src/main/java/com/github/dockerjava/netty/handler/FramedResponseStreamHandler.java b/src/main/java/com/github/dockerjava/netty/handler/FramedResponseStreamHandler.java
@@ -9,6 +9,15 @@
 import com.github.dockerjava.api.model.Frame;
 import com.github.dockerjava.api.model.StreamType;
 
+/**
+ * Handler that decodes a docker-raw-stream as described here:
+ *
+ * https://docs.docker.com/engine/reference/api/docker_remote_api_v1.21/#attach-to-a-container
+ *
+ * It drives the {@link ResultCallback#onNext(Object)} method of the passed {@link ResultCallback}.
+ *
+ * @author Marcus Linke
+ */
 public class FramedResponseStreamHandler extends SimpleChannelInboundHandler<ByteBuf> {
 
     private static final int HEADER_SIZE = 8;
diff --git a/src/main/java/com/github/dockerjava/netty/handler/HttpResponseHandler.java b/src/main/java/com/github/dockerjava/netty/handler/HttpResponseHandler.java
@@ -23,6 +23,12 @@
 import com.github.dockerjava.api.exception.NotModifiedException;
 import com.github.dockerjava.api.exception.UnauthorizedException;
 
+/**
+ * Handler that is responsible to handle an incoming {@link HttpResponse}. It evaluates the status code and
+ * triggers the appropriate lifecycle methods at the passed {@link ResultCallback}.
+ *
+ * @author Marcus Linke
+ */
 public class HttpResponseHandler extends SimpleChannelInboundHandler<HttpObject> {
 
     private HttpResponse response;
diff --git a/src/main/java/com/github/dockerjava/netty/handler/HttpResponseStreamHandler.java b/src/main/java/com/github/dockerjava/netty/handler/HttpResponseStreamHandler.java
@@ -12,6 +12,11 @@
 
 import com.github.dockerjava.api.async.ResultCallback;
 
+/**
+ * Handler that converts an incoming byte stream to an {@link InputStream}.
+ *
+ * @author marcus
+ */
 public class HttpResponseStreamHandler extends SimpleChannelInboundHandler<ByteBuf> {
 
     private HttpResponseInputStream stream = new HttpResponseInputStream();
diff --git a/src/main/java/com/github/dockerjava/netty/handler/JsonRequestHandler.java b/src/main/java/com/github/dockerjava/netty/handler/JsonRequestHandler.java
@@ -6,6 +6,11 @@
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 
+/**
+ * Handler that encodes an outgoing object to JSON.
+ *
+ * @author Marcus Linke
+ */
 public class JsonRequestHandler extends MessageToByteEncoder<Object>{
 
 	private ObjectMapper mapper = new ObjectMapper();
diff --git a/src/main/java/com/github/dockerjava/netty/handler/JsonResponseCallbackHandler.java b/src/main/java/com/github/dockerjava/netty/handler/JsonResponseCallbackHandler.java
@@ -8,6 +8,11 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.github.dockerjava.api.async.ResultCallback;
 
+/**
+ * Handler that decodes an incoming byte stream into objects of T and calls {@link ResultCallback#onNext(Object)}
+ *
+ * @author Marcus Linke
+ */
 public class JsonResponseCallbackHandler<T> extends SimpleChannelInboundHandler<ByteBuf> {
 
     private static ObjectMapper objectMapper = new ObjectMapper();
diff --git a/src/main/java/com/github/dockerjava/netty/handler/JsonResponseHandler.java b/src/main/java/com/github/dockerjava/netty/handler/JsonResponseHandler.java
