org.alfresco.repo.content.transform

Class TransformerDebug

java.lang.Object

org.alfresco.repo.content.transform.TransformerDebug

public class TransformerDebug
extends java.lang.Object

Debugs transformers selection and activity.

As transformations are frequently composed of lower level transformations, log messages include a prefix to identify the transformation. A numeric dot notation is used (such as 123.1.2 indicating the second third level transformation of the 123rd top level transformation).

In order to track of the nesting of transforms, this class has a stack to represent the Transformers. Each Transformer calls TransformerDebug.pushTransform(org.alfresco.repo.content.transform.ContentTransformer, java.lang.String, java.lang.String, java.lang.String, long, org.alfresco.service.cmr.repository.TransformationOptions) at the start of a transform and TransformerDebug.popTransform() at the end. However the top level transform may be selected from a list of available transformers. To record this activity, TransformerDebug.pushAvailable(java.lang.String, java.lang.String, java.lang.String, org.alfresco.service.cmr.repository.TransformationOptions), TransformerDebug.unavailableTransformer(org.alfresco.repo.content.transform.ContentTransformer, long) (to record the reason a transformer is rejected), TransformerDebug.availableTransformers(java.util.List, long, java.lang.String) (to record the available transformers) and TransformerDebug.popAvailable() are called.

Constructor Summary

Constructors

Constructor and Description
TransformerDebug(org.alfresco.service.cmr.repository.NodeService nodeService, org.alfresco.service.cmr.repository.MimetypeService mimetypeService) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	activeTransformer(int mimetypePairCount, ContentTransformer transformer, java.lang.String sourceMimetype, java.lang.String targetMimetype, long maxSourceSizeKBytes, java.lang.Boolean explicit, boolean firstMimetypePair)
void	activeTransformer(java.lang.String sourceMimetype, java.lang.String targetMimetype, int transformerCount, ContentTransformer transformer, long maxSourceSizeKBytes, java.lang.Boolean explicit, boolean firstTransformer)
void	availableTransformers(java.util.List transformers, long sourceSize, java.lang.String calledFrom) Called once all available transformers have been identified.
void	debug(java.lang.String message) Log a message prefixed with the current transformation reference.
void	debug(java.lang.String message, java.lang.Throwable t) Log a message prefixed with the current transformation reference and include a exception, suppressing the stack trace if repeated as we return up the stack of transformers.
java.lang.String	fileSize(long size)
java.lang.String	getFileName(TransformationOptions options, boolean firstLevel, long sourceSize)
java.lang.String	getName(ContentTransformer transformer)
void	inactiveTransformer(ContentTransformer transformer)
boolean	isEnabled() Indicates if any logging is required.
java.lang.String	ms(long time)
void	popAvailable() Called after working out what transformers are available and any resulting transform has been called.
void	popIsTransformableSize() Called after returning from a nested isTransformable.
void	popMisc() Removes a frame from the stack.
void	popTransform() Called after performing a transform.
void	pushAvailable(java.lang.String fromUrl, java.lang.String sourceMimetype, java.lang.String targetMimetype, TransformationOptions options) Called prior to working out what transformers are available.
void	pushIsTransformableSize(ContentTransformer transformer) Called prior to calling a nested isTransformable.
void	pushMisc() Adds a new level to the stack to get a new request number or nesting number.
void	pushTransform(ContentTransformer transformer, java.lang.String fromUrl, java.lang.String sourceMimetype, java.lang.String targetMimetype, long sourceSize, TransformationOptions options) Called prior to performing a transform.
java.lang.Throwable	setCause(java.lang.Throwable t) Sets the cause of a transformation failure, so that only the message of the Throwable is reported later rather than the full stack trace over and over.
static boolean	setDebugOutput(boolean debugOutput) Enable or disable debug log output.
void	unavailableTransformer(ContentTransformer transformer, long maxSourceSizeKBytes) Called to identify a transformer that cannot be used during working out available transformers.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformerDebug

public TransformerDebug(org.alfresco.service.cmr.repository.NodeService nodeService,
                org.alfresco.service.cmr.repository.MimetypeService mimetypeService)

Constructor

Method Detail

pushAvailable

public void pushAvailable(java.lang.String fromUrl,
                 java.lang.String sourceMimetype,
                 java.lang.String targetMimetype,
                 TransformationOptions options)

Called prior to working out what transformers are available.

pushTransform

public void pushTransform(ContentTransformer transformer,
                 java.lang.String fromUrl,
                 java.lang.String sourceMimetype,
                 java.lang.String targetMimetype,
                 long sourceSize,
                 TransformationOptions options)

Called prior to performing a transform.

pushMisc

public void pushMisc()

Adds a new level to the stack to get a new request number or nesting number. Called prior to working out what transformers are active and prior to listing the supported mimetypes for an active transformer.

pushIsTransformableSize

public void pushIsTransformableSize(ContentTransformer transformer)

Called prior to calling a nested isTransformable.

unavailableTransformer

public void unavailableTransformer(ContentTransformer transformer,
                          long maxSourceSizeKBytes)

Called to identify a transformer that cannot be used during working out available transformers.

availableTransformers

public void availableTransformers(java.util.List transformers,
                         long sourceSize,
                         java.lang.String calledFrom)

Called once all available transformers have been identified.

inactiveTransformer

public void inactiveTransformer(ContentTransformer transformer)

activeTransformer

public void activeTransformer(int mimetypePairCount,
                     ContentTransformer transformer,
                     java.lang.String sourceMimetype,
                     java.lang.String targetMimetype,
                     long maxSourceSizeKBytes,
                     java.lang.Boolean explicit,
                     boolean firstMimetypePair)

activeTransformer

public void activeTransformer(java.lang.String sourceMimetype,
                     java.lang.String targetMimetype,
                     int transformerCount,
                     ContentTransformer transformer,
                     long maxSourceSizeKBytes,
                     java.lang.Boolean explicit,
                     boolean firstTransformer)

popAvailable

public void popAvailable()

Called after working out what transformers are available and any resulting transform has been called.

popTransform

public void popTransform()

Called after performing a transform.

popMisc

public void popMisc()

Removes a frame from the stack. Called prior to working out what transformers are active and prior to listing the supported mimetypes for an active transformer.

popIsTransformableSize

public void popIsTransformableSize()

Called after returning from a nested isTransformable.

isEnabled

public boolean isEnabled()

Indicates if any logging is required.

setDebugOutput

public static boolean setDebugOutput(boolean debugOutput)

Enable or disable debug log output. Normally used to hide calls to getTransformer as trace rather than debug level log messages. There are lots of these and it makes it hard to see what is going on.

Parameters:

debugOutput - if true both debug and trace is generated. Otherwise all output is trace.

Returns:

the original value.

debug

public void debug(java.lang.String message)

Log a message prefixed with the current transformation reference.

Parameters:

message -

debug

public void debug(java.lang.String message,
         java.lang.Throwable t)

Log a message prefixed with the current transformation reference and include a exception, suppressing the stack trace if repeated as we return up the stack of transformers.

Parameters:

message -

setCause

public java.lang.Throwable setCause(java.lang.Throwable t)

Sets the cause of a transformation failure, so that only the message of the Throwable is reported later rather than the full stack trace over and over.

getName

public java.lang.String getName(ContentTransformer transformer)

getFileName

public java.lang.String getFileName(TransformationOptions options,
                           boolean firstLevel,
                           long sourceSize)

ms

public java.lang.String ms(long time)

fileSize

public java.lang.String fileSize(long size)