You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by cz...@apache.org on 2017/10/27 12:17:06 UTC
svn commit: r1813517 - in
/felix/trunk/osgi-r7/scr/src/main/java/org/apache/felix/scr/impl:
logger/ComponentLogger.java logger/Logger.java logger/ScrLogger.java
xml/XmlHandler.java
Author: cziegeler
Date: Fri Oct 27 12:17:06 2017
New Revision: 1813517
URL: http://svn.apache.org/viewvc?rev=1813517&view=rev
Log:
FELIX-5457 : [R7] Logger Support. Clean up logging
Removed:
felix/trunk/osgi-r7/scr/src/main/java/org/apache/felix/scr/impl/logger/Logger.java
Modified:
felix/trunk/osgi-r7/scr/src/main/java/org/apache/felix/scr/impl/logger/ComponentLogger.java
felix/trunk/osgi-r7/scr/src/main/java/org/apache/felix/scr/impl/logger/ScrLogger.java
felix/trunk/osgi-r7/scr/src/main/java/org/apache/felix/scr/impl/xml/XmlHandler.java
Modified: felix/trunk/osgi-r7/scr/src/main/java/org/apache/felix/scr/impl/logger/ComponentLogger.java
URL: http://svn.apache.org/viewvc/felix/trunk/osgi-r7/scr/src/main/java/org/apache/felix/scr/impl/logger/ComponentLogger.java?rev=1813517&r1=1813516&r2=1813517&view=diff
==============================================================================
--- felix/trunk/osgi-r7/scr/src/main/java/org/apache/felix/scr/impl/logger/ComponentLogger.java (original)
+++ felix/trunk/osgi-r7/scr/src/main/java/org/apache/felix/scr/impl/logger/ComponentLogger.java Fri Oct 27 12:17:06 2017
@@ -25,7 +25,7 @@ import org.apache.felix.scr.impl.metadat
* for a component. This avoids avoids that all clients doing logging on behalf of
* a component need to pass in things like {@code ComponentMetadata} or the component Id.
*/
-public class ComponentLogger implements Logger
+public class ComponentLogger
{
private final String name;
@@ -51,6 +51,10 @@ public class ComponentLogger implements
this.setComponentId(-1);
}
+ /**
+ * Update the logger with the correct component id.
+ * @param id The component id
+ */
public void setComponentId(final long id)
{
if ( id > -1 )
@@ -63,7 +67,14 @@ public class ComponentLogger implements
}
}
- @Override
+ /**
+ * Log a message using the {@code BundleLogger} and prefix the message
+ * with information about the component.
+ *
+ * @param level The log level
+ * @param message The message
+ * @param ex Optional exception
+ */
public void log(final int level, final String message, final Throwable ex)
{
if ( parent.isLogEnabled(level) )
@@ -74,7 +85,15 @@ public class ComponentLogger implements
}
}
- @Override
+ /**
+ * Log a message using the {@code BundleLogger} and prefix the message
+ * with information about the component.
+ *
+ * @param level The log level
+ * @param pattern The pattern
+ * @param ex Optional exception
+ * @param arguments Optional arguments for the pattern
+ */
public void log(final int level, final String pattern, final Throwable ex, final Object... arguments)
{
if ( parent.isLogEnabled(level) )
@@ -86,7 +105,10 @@ public class ComponentLogger implements
}
}
- @Override
+ /**
+ * Returns {@code true} if logging for the given level is enabled.
+ * @return If the {@code BundleLogger} returns {@code true}.
+ */
public boolean isLogEnabled(final int level)
{
return parent.isLogEnabled(level);
Modified: felix/trunk/osgi-r7/scr/src/main/java/org/apache/felix/scr/impl/logger/ScrLogger.java
URL: http://svn.apache.org/viewvc/felix/trunk/osgi-r7/scr/src/main/java/org/apache/felix/scr/impl/logger/ScrLogger.java?rev=1813517&r1=1813516&r2=1813517&view=diff
==============================================================================
--- felix/trunk/osgi-r7/scr/src/main/java/org/apache/felix/scr/impl/logger/ScrLogger.java (original)
+++ felix/trunk/osgi-r7/scr/src/main/java/org/apache/felix/scr/impl/logger/ScrLogger.java Fri Oct 27 12:17:06 2017
@@ -30,7 +30,7 @@ import org.osgi.util.tracker.ServiceTrac
* This is the "global" logger used by the implementation.
*
*/
-public class ScrLogger implements Logger
+public class ScrLogger
{
// name of the LogService class (this is a string to not create a reference to the class)
private static final String LOGSERVICE_CLASS = "org.osgi.service.log.LogService";
@@ -60,7 +60,18 @@ public class ScrLogger implements Logger
return logServiceTracker.getService();
}
- @Override
+ /**
+ * Method to actually emit the log message. If the LogService is available,
+ * the message will be logged through the LogService. Otherwise the message
+ * is logged to stdout (or stderr in case of LOG_ERROR level messages),
+ *
+ * @param level The log level to log the message at
+ * @param pattern The {@code java.text.MessageFormat} message format
+ * string for preparing the message
+ * @param ex An optional <code>Throwable</code> whose stack trace is written,
+ * @param arguments The format arguments for the <code>pattern</code>
+ * string.
+ */
public void log(final int level, final String pattern, final Throwable ex, final Object... arguments )
{
if ( isLogEnabled( level ) )
@@ -70,13 +81,24 @@ public class ScrLogger implements Logger
}
}
- @Override
+ /**
+ * Returns {@code true} if logging for the given level is enabled.
+ */
public boolean isLogEnabled(final int level)
{
return config.getLogLevel() >= level;
}
- @Override
+ /**
+ * Method to actually emit the log message. If the LogService is available,
+ * the message will be logged through the LogService. Otherwise the message
+ * is logged to stdout (or stderr in case of LOG_ERROR level messages),
+ *
+ * @param level The log level of the messages. This corresponds to the log
+ * levels defined by the OSGi LogService.
+ * @param message The message to print
+ * @param ex The <code>Throwable</code> causing the message to be logged.
+ */
public void log(final int level, final String message, final Throwable ex)
{
if ( isLogEnabled( level ) )
@@ -111,6 +133,7 @@ public class ScrLogger implements Logger
// bundle information
buf.append( this.bundleId );
buf.append(" : ");
+ buf.append(message);
final String msg = buf.toString();
Modified: felix/trunk/osgi-r7/scr/src/main/java/org/apache/felix/scr/impl/xml/XmlHandler.java
URL: http://svn.apache.org/viewvc/felix/trunk/osgi-r7/scr/src/main/java/org/apache/felix/scr/impl/xml/XmlHandler.java?rev=1813517&r1=1813516&r2=1813517&view=diff
==============================================================================
--- felix/trunk/osgi-r7/scr/src/main/java/org/apache/felix/scr/impl/xml/XmlHandler.java (original)
+++ felix/trunk/osgi-r7/scr/src/main/java/org/apache/felix/scr/impl/xml/XmlHandler.java Fri Oct 27 12:17:06 2017
@@ -27,7 +27,6 @@ import java.util.Map;
import java.util.Properties;
import org.apache.felix.scr.impl.logger.BundleLogger;
-import org.apache.felix.scr.impl.logger.Logger;
import org.apache.felix.scr.impl.metadata.ComponentMetadata;
import org.apache.felix.scr.impl.metadata.DSVersion;
import org.apache.felix.scr.impl.metadata.PropertyMetadata;
@@ -48,7 +47,7 @@ public class XmlHandler implements KXml2
private final Bundle m_bundle;
// logger for any messages
- private final Logger m_logger;
+ private final BundleLogger m_logger;
private final boolean m_globalObsoleteFactoryComponentFactory;