org.alfresco.repo.content.transform

Class TransformerDebugLog

java.lang.Object

org.alfresco.util.LogAdapter

org.alfresco.repo.content.transform.TransformerDebugLog

All Implemented Interfaces:

org.apache.commons.logging.Log

public class TransformerDebugLog
extends org.alfresco.util.LogAdapter

Implementation of a Log that logs messages to a structure accessible via TransformerConfigMBean#getTransformationDebug(int).

Field Summary

Fields inherited from class org.alfresco.util.LogAdapter

log

Constructor Summary

Constructors

Constructor and Description
TransformerDebugLog()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addOrModify(java.util.Deque entries, java.lang.Object message) Overridden in sub classes to add a new entry or modify and existing one
void	debug(java.lang.Object message, java.lang.Throwable throwable)
java.lang.String[]	getEntries(int n) Returns the log entries.
java.lang.String	getPropertyAndValue(java.util.Properties defaultProperties) The transformer property and value used to set this logger.
protected java.lang.String	getPropertyName() Overridden to specify the property name that specifies the maximum number of entries.
protected int	getUpperMaxEntries() Overridden to specify the maximum value the maxEntries property may set.
boolean	isDebugEnabled() Enabled if number of transformer debug entries is greater than 0 AND there is not a test function generating output.
protected void	remove(java.util.Deque entries) Removes an entry.
void	setTransformerConfig(TransformerConfig transformerConfig)
void	setTransformerDebug(TransformerDebug transformerDebug)

Methods inherited from class org.alfresco.util.LogAdapter

debug, error, error, fatal, fatal, info, info, isErrorEnabled, isFatalEnabled, isInfoEnabled, isTraceEnabled, isWarnEnabled, trace, trace, warn, warn

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.logging.Log

debug, error, error, fatal, fatal, info, info, isErrorEnabled, isFatalEnabled, isInfoEnabled, isTraceEnabled, isWarnEnabled, trace, trace, warn, warn

Constructor Detail

TransformerDebugLog

public TransformerDebugLog()

Method Detail

getUpperMaxEntries

protected int getUpperMaxEntries()

Overridden to specify the maximum value the maxEntries property may set. Generally quite a small number as values are stored in memory.

Returns 20 as this is debug and we must currently walk the whole structure each time an new request id is added.

getPropertyName

protected java.lang.String getPropertyName()

Overridden to specify the property name that specifies the maximum number of entries.

addOrModify

protected void addOrModify(java.util.Deque entries,
               java.lang.Object message)

Overridden in sub classes to add a new entry or modify and existing one

setTransformerDebug

public void setTransformerDebug(TransformerDebug transformerDebug)

setTransformerConfig

public void setTransformerConfig(TransformerConfig transformerConfig)

Parameters:

transformerConfig - used to access the property.

isDebugEnabled

public boolean isDebugEnabled()

Enabled if number of transformer debug entries is greater than 0 AND there is not a test function generating output.

Specified by:

isDebugEnabled in interface org.apache.commons.logging.Log

Overrides:

isDebugEnabled in class org.alfresco.util.LogAdapter

debug

public void debug(java.lang.Object message,
         java.lang.Throwable throwable)

Specified by:

debug in interface org.apache.commons.logging.Log

Overrides:

debug in class org.alfresco.util.LogAdapter

Parameters:

message - to be appended to the log

throwable - ignored

remove

protected void remove(java.util.Deque entries)

Removes an entry. By default removes the first (oldest) entry by may be overridden.

getEntries

public java.lang.String[] getEntries(int n)

Returns the log entries.

Parameters:

n - the maximum number of entries to return. All if n is smaller or equal to zero.

getPropertyAndValue

public java.lang.String getPropertyAndValue(java.util.Properties defaultProperties)

The transformer property and value used to set this logger. This is commented out if the property has not been overridden (default is 0).

Parameters:

defaultProperties - the transformer.properties file values that may be overridden.

Returns:

the transformer property and value.