Logging docs (and moved some logging classes), security notes and thr…

…eading notes
eclipse-vertx · Jun 6, 2015 · 5e6874e · 5e6874e
1 parent ca89226
commit 5e6874e
Show file tree

Hide file tree

Showing 45 changed files with 152 additions and 60 deletions.
diff --git a/src/main/java/examples/CoreExamples.java b/src/main/java/examples/CoreExamples.java
@@ -18,10 +18,11 @@
 
 import io.vertx.core.*;
 import io.vertx.core.http.HttpServer;
-import io.vertx.core.http.HttpServerOptions;
 import io.vertx.core.http.HttpServerRequest;
 import io.vertx.core.http.HttpServerResponse;
 import io.vertx.core.json.JsonObject;
+import io.vertx.core.logging.Logger;
+import io.vertx.core.logging.LoggerFactory;
 
 import java.util.Arrays;
 
@@ -172,6 +173,18 @@ public void example17(Vertx vertx, long timerID) {
     vertx.cancelTimer(timerID);
   }
 
+  public void example18(String className, Exception exception) {
+
+    // Note -these classes are Java only
+
+    // You would normally maintain one static instance of Logger per Java class:
+
+    Logger logger = LoggerFactory.getLogger(className);
+
+    logger.info("something happened");
+    logger.error("oops!", exception);
+  }
+
 
 
 

diff --git a/src/main/java/io/vertx/core/Starter.java b/src/main/java/io/vertx/core/Starter.java
@@ -21,7 +21,7 @@
 import io.vertx.core.json.DecodeException;
 import io.vertx.core.json.JsonObject;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 import io.vertx.core.metrics.MetricsOptions;
 import io.vertx.core.spi.VertxMetricsFactory;
 

diff --git a/src/main/java/io/vertx/core/eventbus/impl/EventBusImpl.java b/src/main/java/io/vertx/core/eventbus/impl/EventBusImpl.java
@@ -24,7 +24,7 @@
 import io.vertx.core.json.JsonArray;
 import io.vertx.core.json.JsonObject;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 import io.vertx.core.net.NetClient;
 import io.vertx.core.net.NetClientOptions;
 import io.vertx.core.net.NetServer;

diff --git a/src/main/java/io/vertx/core/eventbus/impl/MessageImpl.java b/src/main/java/io/vertx/core/eventbus/impl/MessageImpl.java
@@ -28,7 +28,7 @@
 import io.vertx.core.eventbus.ReplyFailure;
 import io.vertx.core.http.CaseInsensitiveHeaders;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 import io.vertx.core.net.NetSocket;
 import io.vertx.core.net.impl.ServerID;
 

diff --git a/src/main/java/io/vertx/core/file/impl/AsyncFileImpl.java b/src/main/java/io/vertx/core/file/impl/AsyncFileImpl.java
@@ -28,7 +28,7 @@
 import io.vertx.core.impl.ContextImpl;
 import io.vertx.core.impl.VertxInternal;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 
 import java.io.IOException;
 import java.nio.ByteBuffer;

diff --git a/src/main/java/io/vertx/core/file/impl/WindowsFileSystem.java b/src/main/java/io/vertx/core/file/impl/WindowsFileSystem.java
@@ -23,7 +23,7 @@
 import io.vertx.core.impl.ContextImpl;
 import io.vertx.core.impl.VertxInternal;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 
 import java.util.Objects;
 

diff --git a/src/main/java/io/vertx/core/http/impl/ClientConnection.java b/src/main/java/io/vertx/core/http/impl/ClientConnection.java
@@ -45,7 +45,7 @@
 import io.vertx.core.impl.ContextImpl;
 import io.vertx.core.impl.VertxInternal;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 import io.vertx.core.spi.metrics.HttpClientMetrics;
 import io.vertx.core.net.NetSocket;
 import io.vertx.core.net.impl.ConnectionBase;

diff --git a/src/main/java/io/vertx/core/http/impl/ConnectionManager.java b/src/main/java/io/vertx/core/http/impl/ConnectionManager.java
@@ -19,7 +19,7 @@
 import io.vertx.core.Handler;
 import io.vertx.core.impl.ContextImpl;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 
 import java.util.ArrayDeque;
 import java.util.HashSet;

diff --git a/src/main/java/io/vertx/core/http/impl/HttpClientImpl.java b/src/main/java/io/vertx/core/http/impl/HttpClientImpl.java
@@ -52,7 +52,7 @@
 import io.vertx.core.impl.ContextImpl;
 import io.vertx.core.impl.VertxInternal;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 import io.vertx.core.spi.metrics.Metrics;
 import io.vertx.core.spi.metrics.HttpClientMetrics;
 import io.vertx.core.net.impl.KeyStoreHelper;

diff --git a/src/main/java/io/vertx/core/http/impl/HttpClientRequestImpl.java b/src/main/java/io/vertx/core/http/impl/HttpClientRequestImpl.java
@@ -34,7 +34,7 @@
 import io.vertx.core.http.HttpClientResponse;
 import io.vertx.core.impl.VertxInternal;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 import io.vertx.core.net.NetSocket;
 import io.vertx.core.spi.metrics.HttpClientMetrics;
 

diff --git a/src/main/java/io/vertx/core/http/impl/HttpServerImpl.java b/src/main/java/io/vertx/core/http/impl/HttpServerImpl.java
@@ -46,7 +46,7 @@
 import io.vertx.core.impl.ContextImpl;
 import io.vertx.core.impl.VertxInternal;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 import io.vertx.core.net.impl.*;
 import io.vertx.core.spi.metrics.HttpServerMetrics;
 import io.vertx.core.spi.metrics.Metrics;

diff --git a/src/main/java/io/vertx/core/http/impl/HttpServerRequestImpl.java b/src/main/java/io/vertx/core/http/impl/HttpServerRequestImpl.java
@@ -39,7 +39,7 @@
 import io.vertx.core.http.HttpVersion;
 import io.vertx.core.http.ServerWebSocket;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 import io.vertx.core.net.NetSocket;
 import io.vertx.core.net.SocketAddress;
 

diff --git a/src/main/java/io/vertx/core/http/impl/HttpServerResponseImpl.java b/src/main/java/io/vertx/core/http/impl/HttpServerResponseImpl.java
@@ -30,7 +30,7 @@
 import io.vertx.core.impl.ContextImpl;
 import io.vertx.core.impl.VertxInternal;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 
 import java.io.File;
 import java.io.IOException;

diff --git a/src/main/java/io/vertx/core/http/impl/ServerConnection.java b/src/main/java/io/vertx/core/http/impl/ServerConnection.java
@@ -46,7 +46,7 @@
 import io.vertx.core.impl.ContextImpl;
 import io.vertx.core.impl.VertxInternal;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 import io.vertx.core.spi.metrics.HttpServerMetrics;
 import io.vertx.core.net.NetSocket;
 import io.vertx.core.net.impl.ConnectionBase;

diff --git a/src/main/java/io/vertx/core/impl/BlockedThreadChecker.java b/src/main/java/io/vertx/core/impl/BlockedThreadChecker.java
@@ -18,7 +18,7 @@
 
 import io.vertx.core.VertxException;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 
 import java.util.Map;
 import java.util.Timer;

diff --git a/src/main/java/io/vertx/core/impl/ContextImpl.java b/src/main/java/io/vertx/core/impl/ContextImpl.java
@@ -21,7 +21,7 @@
 import io.vertx.core.*;
 import io.vertx.core.json.JsonObject;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 
 import java.util.HashSet;
 import java.util.List;

diff --git a/src/main/java/io/vertx/core/impl/DeploymentManager.java b/src/main/java/io/vertx/core/impl/DeploymentManager.java
@@ -24,7 +24,7 @@
 import io.vertx.core.Verticle;
 import io.vertx.core.json.JsonObject;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 import io.vertx.core.spi.VerticleFactory;
 
 import java.io.File;

diff --git a/src/main/java/io/vertx/core/impl/EventLoopContext.java b/src/main/java/io/vertx/core/impl/EventLoopContext.java
@@ -19,7 +19,7 @@
 import io.vertx.core.Handler;
 import io.vertx.core.json.JsonObject;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 
 import java.util.concurrent.Executor;
 

diff --git a/src/main/java/io/vertx/core/impl/HAManager.java b/src/main/java/io/vertx/core/impl/HAManager.java
@@ -20,7 +20,7 @@
 import io.vertx.core.json.JsonArray;
 import io.vertx.core.json.JsonObject;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 import io.vertx.core.net.impl.ServerID;
 import io.vertx.core.spi.cluster.ClusterManager;
 import io.vertx.core.spi.cluster.NodeListener;

diff --git a/src/main/java/io/vertx/core/impl/OrderedExecutorFactory.java b/src/main/java/io/vertx/core/impl/OrderedExecutorFactory.java
@@ -18,7 +18,7 @@
 package io.vertx.core.impl;
 
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 
 import java.util.LinkedList;
 import java.util.concurrent.Executor;

diff --git a/src/main/java/io/vertx/core/impl/Redeployer.java b/src/main/java/io/vertx/core/impl/Redeployer.java
@@ -17,7 +17,7 @@
 package io.vertx.core.impl;
 
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 
 import java.io.File;
 import java.util.HashMap;

diff --git a/src/main/java/io/vertx/core/impl/VertxImpl.java b/src/main/java/io/vertx/core/impl/VertxImpl.java
@@ -47,7 +47,7 @@
 import io.vertx.core.http.impl.HttpServerImpl;
 import io.vertx.core.json.JsonObject;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 import io.vertx.core.metrics.impl.DummyVertxMetrics;
 import io.vertx.core.spi.metrics.Metrics;
 import io.vertx.core.spi.metrics.MetricsProvider;

diff --git a/src/main/java/io/vertx/core/impl/verticle/CompilingClassLoader.java b/src/main/java/io/vertx/core/impl/verticle/CompilingClassLoader.java
@@ -17,7 +17,7 @@
 package io.vertx.core.impl.verticle;
 
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 
 import javax.tools.Diagnostic;
 import javax.tools.DiagnosticCollector;

diff --git a/...rtx/core/logging/impl/JULLogDelegate.java → ...io/vertx/core/logging/JULLogDelegate.java b/...rtx/core/logging/impl/JULLogDelegate.java → ...io/vertx/core/logging/JULLogDelegate.java
@@ -14,13 +14,15 @@
  * You may elect to redistribute this code under either of these licenses.
  */
 
-package io.vertx.core.logging.impl;
+package io.vertx.core.logging;
+
+import io.vertx.core.spi.logging.LogDelegate;
 
 import java.util.logging.Level;
 import java.util.logging.LogRecord;
 
 /**
- * A {@link LogDelegate} which delegates to java.util.logging
+ * A {@link io.vertx.core.spi.logging.LogDelegate} which delegates to java.util.logging
  *
  * @author <a href="kenny.macleod@kizoom.com">Kenny MacLeod</a>
  */

diff --git a/...e/logging/impl/JULLogDelegateFactory.java → ...x/core/logging/JULLogDelegateFactory.java b/...e/logging/impl/JULLogDelegateFactory.java → ...x/core/logging/JULLogDelegateFactory.java
@@ -14,14 +14,17 @@
  * You may elect to redistribute this code under either of these licenses.
  */
 
-package io.vertx.core.logging.impl;
+package io.vertx.core.logging;
+
+import io.vertx.core.spi.logging.LogDelegate;
+import io.vertx.core.spi.logging.LogDelegateFactory;
 
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.logging.LogManager;
 
 /**
- * A {@link LogDelegateFactory} which creates {@link JULLogDelegate} instances.
+ * A {@link io.vertx.core.spi.logging.LogDelegateFactory} which creates {@link JULLogDelegate} instances.
  *
  * @author <a href="kenny.macleod@kizoom.com">Kenny MacLeod</a>
  * @author <a href="http://tfox.org">Tim Fox</a>

diff --git a/...x/core/logging/impl/Log4jLogDelegate.java → .../vertx/core/logging/Log4jLogDelegate.java b/...x/core/logging/impl/Log4jLogDelegate.java → .../vertx/core/logging/Log4jLogDelegate.java
@@ -14,13 +14,14 @@
  * You may elect to redistribute this code under either of these licenses.
  */
 
-package io.vertx.core.logging.impl;
+package io.vertx.core.logging;
 
 import io.vertx.core.logging.Logger;
+import io.vertx.core.spi.logging.LogDelegate;
 import org.apache.log4j.Level;
 
 /**
- * A {@link LogDelegate} which delegates to Apache Log4j
+ * A {@link io.vertx.core.spi.logging.LogDelegate} which delegates to Apache Log4j
  *
  * @author <a href="kenny.macleod@kizoom.com">Kenny MacLeod</a>
  */

diff --git a/...logging/impl/Log4jLogDelegateFactory.java → ...core/logging/Log4jLogDelegateFactory.java b/...logging/impl/Log4jLogDelegateFactory.java → ...core/logging/Log4jLogDelegateFactory.java
@@ -14,10 +14,13 @@
  * You may elect to redistribute this code under either of these licenses.
  */
 
-package io.vertx.core.logging.impl;
+package io.vertx.core.logging;
+
+import io.vertx.core.spi.logging.LogDelegate;
+import io.vertx.core.spi.logging.LogDelegateFactory;
 
 /**
- * A {@link LogDelegateFactory} which creates {@link Log4jLogDelegate} instances.
+ * A {@link io.vertx.core.spi.logging.LogDelegateFactory} which creates {@link Log4jLogDelegate} instances.
  *
  * @author <a href="kenny.macleod@kizoom.com">Kenny MacLeod</a>
  *

diff --git a/src/main/java/io/vertx/core/logging/Logger.java b/src/main/java/io/vertx/core/logging/Logger.java
@@ -16,7 +16,7 @@
 
 package io.vertx.core.logging;
 
-import io.vertx.core.logging.impl.LogDelegate;
+import io.vertx.core.spi.logging.LogDelegate;
 
 /**
  * This class allows us to isolate all our logging dependencies in one place. It also allows us to have zero runtime
@@ -29,7 +29,7 @@
  * If you would prefer to use Log4J or SLF4J instead of JUL then you can set a system property called
  * {@code vertx.logger-delegate-factory-class-name} to the class name of the delegate for your logging system.
  * For Log4J the value is {@code io.vertx.core.logging.impl.Log4JLogDelegateFactory}, for SLF4J the value
- * is {@code io.vertx.core.logging.impl.SLF4JLogDelegateFactory}. You will need to ensure whatever jar files
+ * is {@code io.vertx.core.logging.SLF4JLogDelegateFactory}. You will need to ensure whatever jar files
  * required by your favourite log framework are on your classpath.
  *
  * @author <a href="mailto:tim.fox@jboss.com">Tim Fox</a>

diff --git a/...ertx/core/logging/impl/LoggerFactory.java → .../io/vertx/core/logging/LoggerFactory.java b/...ertx/core/logging/impl/LoggerFactory.java → .../io/vertx/core/logging/LoggerFactory.java
@@ -14,9 +14,10 @@
  * You may elect to redistribute this code under either of these licenses.
  */
 
-package io.vertx.core.logging.impl;
+package io.vertx.core.logging;
 
-import io.vertx.core.logging.Logger;
+import io.vertx.core.spi.logging.LogDelegate;
+import io.vertx.core.spi.logging.LogDelegateFactory;
 
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;

diff --git a/...x/core/logging/impl/SLF4JLogDelegate.java → .../vertx/core/logging/SLF4JLogDelegate.java b/...x/core/logging/impl/SLF4JLogDelegate.java → .../vertx/core/logging/SLF4JLogDelegate.java
@@ -14,9 +14,10 @@
  * You may elect to redistribute this code under either of these licenses.
  */
 
-package io.vertx.core.logging.impl;
+package io.vertx.core.logging;
 
 
+import io.vertx.core.spi.logging.LogDelegate;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.slf4j.spi.LocationAwareLogger;
@@ -26,7 +27,7 @@
 /**
  * @author <a href="http://tfox.org">Tim Fox</a>
  */
-public class SLF4JLogDelegate implements LogDelegate{
+public class SLF4JLogDelegate implements LogDelegate {
   private static final String FQCN = io.vertx.core.logging.Logger.class.getCanonicalName();
 
   private final Logger logger;

diff --git a/...logging/impl/SLF4JLogDelegateFactory.java → ...core/logging/SLF4JLogDelegateFactory.java b/...logging/impl/SLF4JLogDelegateFactory.java → ...core/logging/SLF4JLogDelegateFactory.java
@@ -14,7 +14,10 @@
  * You may elect to redistribute this code under either of these licenses.
  */
 
-package io.vertx.core.logging.impl;
+package io.vertx.core.logging;
+
+import io.vertx.core.spi.logging.LogDelegate;
+import io.vertx.core.spi.logging.LogDelegateFactory;
 
 /*
  * @author <a href="http://tfox.org">Tim Fox</a>

diff --git a/...re/logging/impl/VertxLoggerFormatter.java → ...tx/core/logging/VertxLoggerFormatter.java b/...re/logging/impl/VertxLoggerFormatter.java → ...tx/core/logging/VertxLoggerFormatter.java
@@ -14,7 +14,7 @@
  * You may elect to redistribute this code under either of these licenses.
  */
 
-package io.vertx.core.logging.impl;
+package io.vertx.core.logging;
 
 import io.vertx.core.impl.Utils;
 

diff --git a/src/main/java/io/vertx/core/net/impl/ConnectionBase.java b/src/main/java/io/vertx/core/net/impl/ConnectionBase.java
@@ -29,7 +29,7 @@
 import io.vertx.core.impl.ContextImpl;
 import io.vertx.core.impl.VertxInternal;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 import io.vertx.core.spi.metrics.NetworkMetrics;
 import io.vertx.core.spi.metrics.TCPMetrics;
 import io.vertx.core.net.SocketAddress;

diff --git a/src/main/java/io/vertx/core/net/impl/HandlerManager.java b/src/main/java/io/vertx/core/net/impl/HandlerManager.java
@@ -20,7 +20,7 @@
 import io.vertx.core.Handler;
 import io.vertx.core.impl.ContextImpl;
 import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.impl.LoggerFactory;
+import io.vertx.core.logging.LoggerFactory;
 
 import java.util.List;
 import java.util.concurrent.ConcurrentHashMap;