You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2012/11/23 08:45:44 UTC
svn commit: r1412766 - in /maven/maven-3/trunk/maven-embedder/src:
main/java/org/apache/maven/cli/logging/Slf4jLogger.java
main/java/org/apache/maven/cli/logging/Slf4jLoggerManager.java
site/apt/logging.apt
Author: hboutemy
Date: Fri Nov 23 07:45:43 2012
New Revision: 1412766
URL: http://svn.apache.org/viewvc?rev=1412766&view=rev
Log:
added notes about logger name, with Plexus Logger API that cannot follow logger name as class name convention :(
Modified:
maven/maven-3/trunk/maven-embedder/src/main/java/org/apache/maven/cli/logging/Slf4jLogger.java
maven/maven-3/trunk/maven-embedder/src/main/java/org/apache/maven/cli/logging/Slf4jLoggerManager.java
maven/maven-3/trunk/maven-embedder/src/site/apt/logging.apt
Modified: maven/maven-3/trunk/maven-embedder/src/main/java/org/apache/maven/cli/logging/Slf4jLogger.java
URL: http://svn.apache.org/viewvc/maven/maven-3/trunk/maven-embedder/src/main/java/org/apache/maven/cli/logging/Slf4jLogger.java?rev=1412766&r1=1412765&r2=1412766&view=diff
==============================================================================
--- maven/maven-3/trunk/maven-embedder/src/main/java/org/apache/maven/cli/logging/Slf4jLogger.java (original)
+++ maven/maven-3/trunk/maven-embedder/src/main/java/org/apache/maven/cli/logging/Slf4jLogger.java Fri Nov 23 07:45:43 2012
@@ -22,7 +22,8 @@ package org.apache.maven.cli.logging;
import org.codehaus.plexus.logging.Logger;
/**
- * Adapt an SLF4J logger to a Plexus logger.
+ * Adapt an SLF4J logger to a Plexus logger, ignoring Plexus logger API parts that are not classical and
+ * probably not really used.
*
* @author Jason van Zyl
*/
@@ -112,15 +113,24 @@ public class Slf4jLogger
return logger.isErrorEnabled();
}
+ /**
+ * <b>Warning</b>: ignored (always return <code>0</code>).
+ */
public int getThreshold()
{
return 0;
}
+ /**
+ * <b>Warning</b>: ignored.
+ */
public void setThreshold( int threshold )
{
}
+ /**
+ * <b>Warning</b>: ignored (always return <code>0</code>).
+ */
public Logger getChildLogger( String name )
{
return null;
Modified: maven/maven-3/trunk/maven-embedder/src/main/java/org/apache/maven/cli/logging/Slf4jLoggerManager.java
URL: http://svn.apache.org/viewvc/maven/maven-3/trunk/maven-embedder/src/main/java/org/apache/maven/cli/logging/Slf4jLoggerManager.java?rev=1412766&r1=1412765&r2=1412766&view=diff
==============================================================================
--- maven/maven-3/trunk/maven-embedder/src/main/java/org/apache/maven/cli/logging/Slf4jLoggerManager.java (original)
+++ maven/maven-3/trunk/maven-embedder/src/main/java/org/apache/maven/cli/logging/Slf4jLoggerManager.java Fri Nov 23 07:45:43 2012
@@ -25,7 +25,8 @@ import org.slf4j.ILoggerFactory;
import org.slf4j.LoggerFactory;
/**
- * Use an SLF4J {@link org.slf4j.ILoggerFactory} as a backing for a Plexus {@link org.codehaus.plexus.logging.LoggerManager}.
+ * Use an SLF4J {@link org.slf4j.ILoggerFactory} as a backing for a Plexus {@link org.codehaus.plexus.logging.LoggerManager},
+ * ignoring Plexus logger API parts that are not classical and probably not really used.
*
* @author Jason van Zyl
* @since 3.1
@@ -46,37 +47,61 @@ public class Slf4jLoggerManager
return new Slf4jLogger( loggerFactory.getLogger( role ) );
}
+ /**
+ * The logger name for a component with a non-null hint is <code>role.hint</code>.
+ * <b>Warning</b>: this does not conform to logger name as class name convention.
+ * (and what about <code>null</code> and <code>default</code> hint equivalence?)
+ */
public Logger getLoggerForComponent( String role, String hint )
{
return ( null == hint
? getLoggerForComponent( role )
- : new Slf4jLogger( loggerFactory.getLogger( role + "." + hint ) ) );
+ : new Slf4jLogger( loggerFactory.getLogger( role + '.' + hint ) ) );
}
//
// Trying to give loggers back is a bad idea. Ceki said so :-)
+ // notice to self: what was this method supposed to do?
//
+ /**
+ * <b>Warning</b>: ignored.
+ */
public void returnComponentLogger( String role )
{
}
+ /**
+ * <b>Warning</b>: ignored.
+ */
public void returnComponentLogger( String role, String hint )
{
}
+ /**
+ * <b>Warning</b>: ignored (always return <code>0</code>).
+ */
public int getThreshold()
{
return 0;
}
+ /**
+ * <b>Warning</b>: ignored.
+ */
public void setThreshold( int threshold )
{
}
+ /**
+ * <b>Warning</b>: ignored.
+ */
public void setThresholds( int threshold )
{
}
+ /**
+ * <b>Warning</b>: ignored (always return <code>0</code>).
+ */
public int getActiveLoggerCount()
{
return 0;
Modified: maven/maven-3/trunk/maven-embedder/src/site/apt/logging.apt
URL: http://svn.apache.org/viewvc/maven/maven-3/trunk/maven-embedder/src/site/apt/logging.apt?rev=1412766&r1=1412765&r2=1412766&view=diff
==============================================================================
--- maven/maven-3/trunk/maven-embedder/src/site/apt/logging.apt (original)
+++ maven/maven-3/trunk/maven-embedder/src/site/apt/logging.apt Fri Nov 23 07:45:43 2012
@@ -50,3 +50,16 @@ public class Wombat
final Logger logger = LoggerFactory.getLogger(Wombat.class);
}
+-----
+
+* Logger Name
+
+ Before Maven 3.1.0, with logging implementation done in Maven, logger name wasn't used: they are as-is, without clear definition.
+
+ Starting with Maven 3.1.0, logging implementation can be of greatest use if logger names are well defined. This definition still
+ needs to be defined and implemented:
+
+ * classical "class name" pattern?
+
+ * Maven-specific name hierarchy?
+
+ * a mix (some with class name, some with Maven-specific hierarchy)?