Add file documentation and project source of log4j2.

log4j2/docs/log4j2-tutorial.md

@@ -0,0 +1,116 @@
+# Log4J 2
+## 1 Características
+### 1.1 Introducción
+* Log4j2 compatible y seguro ya que usa las mismas funcionalidades de slf4j.
+* Log4j2 más extenso que slf4j.
+* Log4j2 escalable porque puede soportar otras implementaciones. 
+* Log4j2 incluye integración mediante el módulo o puente "log4j-to-slf4j" para cambiar a slf4j cuando se requiera.
+* No permite multiples implementaciones.
+* Algunas de las funcionalidades de Log4j2:
+	* Message API
+	* Java 8 lambda support
+	* Mixing {}-style
+	*  CloseableThreadContext 
+	* Log4j2's ThreadContext
+	* SLF4J does not support the FATAL log level.
+	* Log4j2 has support for custom log levels.
+	* The Log4j2 API accepts any Object, not just Strings
+	* The above you get for free just by using the Log4j2 API directly. 
+	* SLF4J Markers'
+## 2 Configuración de Log4j2
+### 2.1 Archivo de configuración o implementación
+* Existen 4 diversos tipo de configuración o implementación, tales como:
+	 1. Json
+	 2. Yaml
+	 3. Xml
+	 4. Archivo de propiedades. "fileName.properties".
+	* Para configurar cada una de las implementaciones visitar la liga correspondiente.
+		1. `Json` https://logging.apache.org/log4j/2.x/manual/configuration.html#JSON
+		2. `Yaml`https://logging.apache.org/log4j/2.x/manual/configuration.html#YAML
+		3. `Xml` https://logging.apache.org/log4j/2.x/manual/configuration.html#XML
+
+* Log4J2 cuenta con una configuración por default si no encuentra archivo a cargar.
+* Log4j2 tiene una clase llamada: `ConfigurationFactory` la cual se encarga de la configuración de las diversas implementaciones.
+* `ConfigurationFactory` contiene lógica para encontrar la implementación a cargar, el orden de busqueda es el siguiente :
+	1. Primero buscará el archivo especificado en la propiedad: "log4j.configurationFile".
+	2. Si no existe el archivo `log4j.configurationFile` la clase `ConfigurationFactory` buscará `log4j2-test.properties`.
+	3. Si no existe el archivo anterior la clase `ConfigurationFactory` buscará `log4j2-test.yaml` o `log4j2-test.yml`.
+	4. Si no existe el archivo anterior la clase `ConfigurationFactory` buscará `log4j2-test.json` o `log4j2-test.jsn`.
+	5. Si no existe el archivo anterior la clase `ConfigurationFactory` buscará `log4j2-test.xml` 
+	6. Sí el archivo de prueba anterior no existe `ConfigurationFactory` buscará `log4j2.properties`
+	7. Sí el archivo de propiedades anterior no existe `ConfigurationFactory` buscará `log4j2.yaml` o `log4j2.yml`.
+	8. Sí el archivo anterior no existe  `ConfigurationFactory` buscará `log4j2.json` o `log4j2.jsn`.
+	9. Sí el archivo anterior no existe, `ConfigurationFactory` buscará `log4j2.xml`.
+	10. Sí no encuentra ningún archivo de configuración, se cargará el default y la salida de la traza de errores será en la consola 
+### 2.1.1 Configurando log4j2 con archivo de propiedades
+A continuación se muestra la configuración clásica estandar de un aplicativo, si se desea cualquier otra implementación, retomar la sección 2.1.
+* Agregar archivo log42.properties en la ruta: `/src/main/resources` 
+
+Datos de archivo de propiedades
+```bash
+status = error
+name = PropertiesConfig
+
+filters = threshold
+
+filter.threshold.type = ThresholdFilter
+filter.threshold.level = debug
+
+appenders = console
+
+appender.console.type = Console
+appender.console.name = STDOUT
+appender.console.layout.type = PatternLayout
+appender.console.layout.pattern = %d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n
+
+rootLogger.level = debug
+rootLogger.appenderRefs = stdout
+rootLogger.appenderRef.stdout.ref = STDOUT
+```
+* Agregar la configuración correspondiente "anexar dependencia", para este caso de prueba usaremos la herramienta gradle.
+
+Agregar dependencia log42:
+```
+dependencies {
+	compile group:  'org.apache.logging.log4j', name:  'log4j-api', version:  '2.6.1'
+    compile group: 'org.apache.logging.log4j', name: 'log4j-core', version: '2.6.1'
+}
+```
+#
+### 2.2 Descripción LogManager
+* Es una clase java con características especiales para log4j2.
+* Esta clase es usada por el cliente de la aplicación para solicitar las instancias de logger.
+* Gestiona la configuración de logging framework, este se encarga de leer la configuración inicial que se tendra en las bitácoras de la aplicación.
+* Contiene configuración default, sí no se especifica alguna en particular.
+* Se puede especificar el nivel de logeo `info, debug, fatal, etc`.
+* Se carga durante el inicio del aplicativo pero no se puede modificar subsecuentemente cargado.
+* La configurarción se puede realizar mediante una clase java.
+#
+### 2.3 Comprobación de configuración
+* Ejecutar la siguiente clase para confirmar que la configuración anterior sea correcta.
+```bash
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+
+public class HelloWorld {
+
+  private static final Logger LOGGER = LogManager.getLogger(HelloWorld.class.getName());
+
+  public static void main(String[] args) {
+    LOGGER.debug("Debug Message Logged !!!");
+    LOGGER.info("Info Message Logged !!!");
+    LOGGER.error("Error Message Logged !!!", new NullPointerException("NullError"));
+  }
+}
+```
+* Se debe mostrar una salida en consola, como la siguiente.
+```bash
+2019-05-18 18:39:56 DEBUG HelloWorld:21 - Debug Message Logged !!!
+2019-05-18 18:39:56 INFO  HelloWorld:22 - Info Message Logged !!!
+2019-05-18 18:39:56 ERROR HelloWorld:23 - Error Message Logged !!!
+java.lang.NullPointerException: NullError
+	at log4j2.HelloWorld.main(HelloWorld.java:23) [main/:?]
+```
+
+
+

log4j2/example-log4j2/.gitignore

@@ -0,0 +1,5 @@
+# Ignore Gradle project-specific cache directory
+.gradle
+.project
+# Ignore Gradle build output directory
+build

log4j2/example-log4j2/build.gradle

@@ -0,0 +1,16 @@
+
+plugins {
+    id 'java-library'
+}
+
+repositories {
+    jcenter()
+}
+
+dependencies {
+    compile group:  'org.apache.logging.log4j', name:  'log4j-api', version:  '2.6.1'
+    compile group: 'org.apache.logging.log4j', name: 'log4j-core', version: '2.6.1'
+}
+
+sourceCompatibility = 1.8
+targetCompatibility = 1.8

log4j2/example-log4j2/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.4.1-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

log4j2/example-log4j2/gradlew

@@ -0,0 +1,188 @@
+#!/usr/bin/env sh
+
+#
+# Copyright 2015 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+##############################################################################
+##
+##  Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+    echo "$*"
+}
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MINGW* )
+    msys=true
+    ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+        JAVACMD="$JAVA_HOME/bin/java"
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin, switch paths to Windows format before running java
+if $cygwin ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    JAVACMD=`cygpath --unix "$JAVACMD"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=$((i+1))
+    done
+    case $i in
+        (0) set -- ;;
+        (1) set -- "$args0" ;;
+        (2) set -- "$args0" "$args1" ;;
+        (3) set -- "$args0" "$args1" "$args2" ;;
+        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
+}
+APP_ARGS=$(save "$@")
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
+if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
+  cd "$(dirname "$0")"
+fi
+
+exec "$JAVACMD" "$@"