Package org.ametys.runtime.log

Class StaticExternalLog

java.lang.Object

org.ametys.runtime.log.StaticExternalLog

All Implemented Interfaces:

ExternalLog, PluginAware, Configurable

public class StaticExternalLog
extends Object
implements ExternalLog, Configurable, PluginAware

Default static implementation of ExternalLog For implementing the ExternalLog interface (while being Configurable), extends this class and implements the getAppender() and/or getCategory() methods. Example of XML

 
 <extension id="runtime.core.externalLogger.myTest"
         class="org.ametys.runtime.log.StaticExternalLog"
         point="org.ametys.runtime.log.ExternalLogExtensionPoint">
     <appender-name>my-logger</appender-name>
     <category-name>com.example.mylog</category-name>
     <file-prefix>my-file-name</file-prefix>
     <additive>false</additive>
     <rolling-file>true</rolling-file>
     <log-level>INFO</log-level>
 </extension>
 
 

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	_additive
private Appender	_appender
private String	_appenderName
private String	_categoryName
private String	_filePrefix
private Level	_level
private boolean	_rollingFileAppender
protected static Level	DEFAULT_LEVEL	Default log level
protected static String	PATTERN_LAYOUT	default layout pattern

Constructor Summary

Constructors

Constructor	Description
StaticExternalLog()

Method Summary

Modifier and Type	Method	Description
private FileAppender	_createFileAppender()
private org.apache.log4j.rolling.RollingFileAppender	_createRollingFileAppender()
void	configure(Configuration configuration)
Appender	getAppender()	Get the appender
Logger	getCategory()	Get or Create a category
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PATTERN_LAYOUT

protected static final String PATTERN_LAYOUT

default layout pattern

See Also:

Constant Field Values

DEFAULT_LEVEL

protected static final Level DEFAULT_LEVEL

Default log level

_appenderName

private String _appenderName

_categoryName

private String _categoryName

_filePrefix

private String _filePrefix

_additive

private boolean _additive

_level

private Level _level

_rollingFileAppender

private boolean _rollingFileAppender

_appender

private Appender _appender

Constructor Detail

StaticExternalLog

public StaticExternalLog()

Method Detail

getAppender

public Appender getAppender()
                     throws IOException

Description copied from interface: ExternalLog

Get the appender

Specified by:

getAppender in interface ExternalLog

Returns:

an appender that can be added to a category

Throws:

IOException

_createRollingFileAppender

private org.apache.log4j.rolling.RollingFileAppender _createRollingFileAppender()

_createFileAppender

private FileAppender _createFileAppender()
                                  throws IOException

Throws:

IOException

getCategory

public Logger getCategory()

Description copied from interface: ExternalLog

Get or Create a category

Specified by:

getCategory in interface ExternalLog

Returns:

a category from logManager

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component