request/access log #492

* javadoc fixes
* fix #492

Author: jknack

jooby-archetype/src/main/resources/archetype-resources/conf/logback.xml

@@ -6,6 +6,34 @@
     </encoder>
   </appender>
 
+  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
+    <file>log/app.log</file>
+    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+      <fileNamePattern>logs/app.%d{yyyy-MM-dd}.log</fileNamePattern>
+      <totalSizeCap>1mb</totalSizeCap>
+    </rollingPolicy>
+
+    <encoder>
+      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>
+    </encoder>
+  </appender>
+
+  <appender name="ACCESS" class="ch.qos.logback.core.rolling.RollingFileAppender">
+    <file>log/access.log</file>
+    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+      <fileNamePattern>log/access.%d{yyyy-MM-dd}.log</fileNamePattern>
+      <totalSizeCap>1mb</totalSizeCap>
+    </rollingPolicy>
+
+    <encoder>
+      <pattern>%msg%n</pattern>
+    </encoder>
+  </appender>
+
+  <logger name="org.jooby.RequestLogger" additivity="false">
+    <appender-ref ref="ACCESS" />
+  </logger>
+
   <root level="info">
     <appender-ref ref="STDOUT" />
   </root>

jooby-pac4j/src/main/java/org/jooby/pac4j/Auth.java

@@ -31,13 +31,22 @@
 import java.util.function.Function;
 import java.util.stream.Collectors;
 
-import com.google.inject.TypeLiteral;
 import org.jooby.Env;
 import org.jooby.Jooby;
 import org.jooby.Route;
 import org.jooby.Routes;
 import org.jooby.Session;
-import org.jooby.internal.pac4j.*;
+import org.jooby.internal.pac4j.AuthCallback;
+import org.jooby.internal.pac4j.AuthContext;
+import org.jooby.internal.pac4j.AuthFilter;
+import org.jooby.internal.pac4j.AuthLogout;
+import org.jooby.internal.pac4j.AuthorizerFilter;
+import org.jooby.internal.pac4j.BasicAuth;
+import org.jooby.internal.pac4j.ClientType;
+import org.jooby.internal.pac4j.ClientsProvider;
+import org.jooby.internal.pac4j.ConfigProvider;
+import org.jooby.internal.pac4j.FormAuth;
+import org.jooby.internal.pac4j.FormFilter;
 import org.jooby.scope.Providers;
 import org.jooby.scope.RequestScoped;
 import org.pac4j.core.authorization.authorizer.Authorizer;
@@ -60,6 +69,7 @@
 import com.google.common.collect.Maps;
 import com.google.common.collect.Multimap;
 import com.google.inject.Binder;
+import com.google.inject.TypeLiteral;
 import com.google.inject.multibindings.MapBinder;
 import com.google.inject.multibindings.Multibinder;
 import com.google.inject.multibindings.OptionalBinder;
@@ -117,10 +127,9 @@
  * </pre>
  *
  * <p>
- * A {@link IndirectBasicAuthClient} depends on {@link Authenticator<UsernamePasswordCredentials>}, default is
+ * A {@link IndirectBasicAuthClient} depends on {@link Authenticator}, default is
  * {@link SimpleTestUsernamePasswordAuthenticator} which is great for development, but nothing good
- * for other environments. Next example setup a basic auth with a custom:
- * {@link Authenticator<UsernamePasswordCredentials>}:
+ * for other environments. Next example setup a basic auth with a custom {@link Authenticator}:
  * </p>
  *
  * <pre>
@@ -151,7 +160,7 @@
  * </pre>
  *
  * <p>
- * Like basic auth, form auth depends on a {@link Authenticator<UsernamePasswordCredentials>}.
+ * Like basic auth, form auth depends on a {@link Authenticator}.
  * </p>
  *
  * <p>

jooby/src/main/java/org/jooby/Env.java

@@ -449,6 +449,7 @@ default <T> Option<T> when(final Predicate<String> predicate, final T result) {
   /**
    * Get or chain the required xss functions.
    *
+   * @param xss XSS to combine.
    * @return Chain of required xss functions.
    */
   default Function<String, String> xss(final String... xss) {

jooby/src/main/java/org/jooby/Jooby.java

@@ -4017,6 +4017,7 @@ public Jooby executor(final ExecutorService executor) {
    *
    * The {@link ExecutorService} will automatically shutdown.
    *
+   * @param name Name of the executor.
    * @param executor Executor to use.
    * @return This jooby instance.
    */

jooby/src/main/java/org/jooby/Request.java

@@ -383,6 +383,11 @@ public Request push(final String path, final Map<String, Object> headers) {
       return this;
     }
 
+    @Override
+    public long timestamp() {
+      return req.timestamp();
+    }
+
     @Override
     public String toString() {
       return req.toString();
@@ -427,6 +432,7 @@ default String path() {
    *  http://domain.com/404<h1>X</h1> {@literal ->} /404%3Ch1%3EX%3C/h1%3E
    * }</pre>
    *
+   * @param escape True if we want to escape this path.
    * @return The request URL pathname.
    */
   default String path(final boolean escape) {
@@ -1108,4 +1114,12 @@ default Request push(final String path) {
    * @return This request.
    */
   Request push(final String path, final Map<String, Object> headers);
+
+  /**
+   * Request timestamp.
+   *
+   * @return The time that the request was received.
+   */
+  long timestamp();
+
 }