Package org.alfresco.repo.content.transform

Class TransformerDebug

    • Constructor Detail

      • TransformerDebug

        public TransformerDebug()

    • Method Detail

      • setTransformerLog

        public void setTransformerLog​(org.apache.commons.logging.Log transformerLog)

      • setTransformerDebugLog

        public void setTransformerDebugLog​(org.apache.commons.logging.Log transformerDebugLog)

      • setNodeService

        public void setNodeService​(org.alfresco.service.cmr.repository.NodeService nodeService)

      • setMimetypeService

        public void setMimetypeService​(org.alfresco.service.cmr.repository.MimetypeService mimetypeService)

      • setTransformerConfig

        public void setTransformerConfig​(TransformerConfig transformerConfig)

      • setApplicationContext

        public void setApplicationContext​(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException
        Specified by:
        setApplicationContext in interface org.springframework.context.ApplicationContextAware
        Throws:
        org.springframework.beans.BeansException

      • setContentService

        public void setContentService​(ContentService contentService)

      • setTransformClient

        public void setTransformClient​(TransformClient transformClient)

      • getRepositoryHelper

        public Repository getRepositoryHelper()

      • setRepositoryHelper

        public void setRepositoryHelper​(Repository repositoryHelper)

      • setTransactionService

        public void setTransactionService​(TransactionService transactionService)

      • afterPropertiesSet

        public void afterPropertiesSet()
                        throws Exception
        Throws:
        Exception

      • pushAvailable

        @Deprecated
public void pushAvailable​(String fromUrl,
                          String sourceMimetype,
                          String targetMimetype,
                          String renditionName,
                          org.alfresco.service.cmr.repository.NodeRef sourceNodeRef)
        Deprecated.
        Called prior to working out what transformers are available.

      • pushTransform

        @Deprecated
public void pushTransform​(ContentTransformer transformer,
                          String fromUrl,
                          String sourceMimetype,
                          String targetMimetype,
                          long sourceSize,
                          String renditionName,
                          org.alfresco.service.cmr.repository.NodeRef sourceNodeRef)
        Deprecated.
        Called prior to performing a transform.

      • pushTransform

        public void pushTransform​(String transformerName,
                          String fromUrl,
                          String sourceMimetype,
                          String targetMimetype,
                          long sourceSize,
                          String renditionName,
                          org.alfresco.service.cmr.repository.NodeRef sourceNodeRef)

      • 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

        @Deprecated
public void pushIsTransformableSize​(ContentTransformer transformer)
        Deprecated.
        Called prior to calling a nested isTransformable.

      • unavailableTransformer

        @Deprecated
public void unavailableTransformer​(ContentTransformer transformer,
                                   String sourceMimetype,
                                   String targetMimetype,
                                   long maxSourceSizeKBytes)
        Deprecated.
        Called to identify a transformer that cannot be used during working out available transformers.

      • availableTransformers

        @Deprecated
public void availableTransformers​(List<ContentTransformer> transformers,
                                  long sourceSize,
                                  String renditionName,
                                  org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
                                  String calledFrom)
        Deprecated.
        Called once all available transformers have been identified.

      • activeTransformer

        @Deprecated
public void activeTransformer​(int mimetypePairCount,
                              ContentTransformer transformer,
                              String sourceMimetype,
                              String targetMimetype,
                              long maxSourceSizeKBytes,
                              boolean firstMimetypePair)
        Deprecated.

      • activeTransformer

        @Deprecated
public void activeTransformer​(String sourceMimetype,
                              String targetMimetype,
                              int transformerCount,
                              ContentTransformer transformer,
                              long maxSourceSizeKBytes,
                              boolean firstTransformer)
        Deprecated.

      • 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​(String message)
        Log a message prefixed with the current transformation reference.
        Parameters:
        message -

      • debug

        public void debug​(String message,
                  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 <T extends Throwable> T setCause​(T 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.

      • getStringBuilder

        public StringBuilder getStringBuilder()
        Returns the current StringBuilder (if any) being used to capture debug information for the current Thread.

      • setStringBuilder

        public void setStringBuilder​(StringBuilder sb)
        Sets the StringBuilder to be used to capture debug information for the current Thread.

      • transformationsByTransformer

        @Deprecated
public String transformationsByTransformer​(String transformerName,
                                           boolean toString,
                                           boolean format42,
                                           String renditionName)
        Deprecated.
        The transformations code is being moved out of the codebase and replaced by the new async RenditionService2 or other external libraries.
        Returns a String and /or debug that provides a list of supported transformations for each transformer.
        Parameters:
        transformerName - restricts the list to one transformer. Unrestricted if null.
        toString - indicates that a String value should be returned in addition to any debug.
        format42 - indicates the old 4.1.4 format should be used which did not order the transformers and only included top level transformers.
        renditionName - to which the transformation will be put (such as "Index", "Preview", null).

      • transformationsByExtension

        @Deprecated
public String transformationsByExtension​(String sourceExtension,
                                         String targetExtension,
                                         boolean toString,
                                         boolean format42,
                                         boolean onlyNonDeterministic,
                                         String renditionName)
        Deprecated.
        The transformations code is being moved out of the codebase and replaced by the new async RenditionService2 or other external libraries.
        Returns a String and /or debug that provides a list of supported transformations sorted by source and target mimetype extension.
        Parameters:
        sourceExtension - restricts the list to one source extension. Unrestricted if null.
        targetExtension - restricts the list to one target extension. Unrestricted if null.
        toString - indicates that a String value should be returned in addition to any debug.
        format42 - indicates the new 4.2 rather than older 4.1.4 format should be used. The 4.1.4 format did not order the transformers or mimetypes and only included top level transformers.
        onlyNonDeterministic - if true only report transformations where there is more than one transformer available with the same priority.
        renditionName - to which the transformation will be put (such as "Index", "Preview", null).

      • getSourceMimetypes

        public Collection<String> getSourceMimetypes​(String sourceExtension)
        Returns a collection of mimetypes ordered by extension, but unlike the version in MimetypeService throws an exception if the sourceExtension is supplied but does not match a mimetype.
        Parameters:
        sourceExtension - to restrict the collection to one entry
        Throws:
        IllegalArgumentException - if there is no match. The message indicates this.

      • getTargetMimetypes

        public Collection<String> getTargetMimetypes​(String sourceExtension,
                                             String targetExtension,
                                             Collection<String> sourceMimetypes)
        Identical to getSourceMimetypes for the target, but avoids doing the look up if the sourceExtension is the same as the tragetExtension, so will have the same result.
        Parameters:
        sourceExtension - used to restrict the sourceMimetypes
        targetExtension - to restrict the collection to one entry
        sourceMimetypes - that match the sourceExtension
        Throws:
        IllegalArgumentException - if there is no match. The message indicates this.

      • getFileName

        public String getFileName​(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
                          boolean firstLevel,
                          long sourceSize)

      • ms

        public String ms​(long time)

      • fileSize

        public String fileSize​(long size)

      • sortTransformersByName

        @Deprecated
public Collection<ContentTransformer> sortTransformersByName​(String transformerName)
        Deprecated.
        The transformations code is being moved out of the codebase and replaced by the new async RenditionService2 or other external libraries.
        Returns a sorted list of all transformers sorted by name.
        Parameters:
        transformerName - to restrict the collection to one entry
        Returns:
        a new Collection of sorted transformers
        Throws:
        IllegalArgumentException - if transformerName is not found.

      • debugTransformServiceRequest

        public int debugTransformServiceRequest​(String sourceMimetype,
                                        long sourceSize,
                                        org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
                                        int contentHashcode,
                                        String fileName,
                                        String targetMimetype,
                                        String renditionName)
        Debugs a request to the Transform Service

      • debugTransformServiceResponse

        public void debugTransformServiceResponse​(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
                                          int contentHashcode,
                                          long requested,
                                          int seq,
                                          String sourceExt,
                                          String targetExt,
                                          String msg)
        Debugs a response to the Transform Service

      • testTransform

        public String testTransform​(String sourceExtension,
                            String targetExtension,
                            String renditionName)

      • testTransform

        @Deprecated
public String testTransform​(String transformerName,
                            String sourceExtension,
                            String targetExtension,
                            String renditionName)
        Deprecated.
        The transformations code is being moved out of the codebase and replaced by the new async RenditionService2 or other external libraries.

      • getTestFileExtensionsAndMimetypes

        public String[] getTestFileExtensionsAndMimetypes()