Package org.alfresco.repo.content.transform

Class TransformerConfigMBeanImpl

  • All Implemented Interfaces:
    TransformerConfigMBean
    public class TransformerConfigMBeanImpl
extends java.lang.Object
implements TransformerConfigMBean
    Implements the JMX interface for monitoring Content Transformer configuration and statistics.
    Author:
    Alan Davis

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String[] getContextNames()
      Lists the names of the contexts or uses.
      java.lang.String[] getCustomePropertyNames()
      Lists custom (non default) property names.
      java.lang.String[] getExtensionsAndMimetypes()
      Lists all configured mimetypes, proceeded by its primary file extension.
      java.lang.String getProperties​(boolean listAll)
      Returns custom and default transformer propertiest.
      java.lang.String[] getTestFileExtensionsAndMimetypes()
      Lists the extensions of available test files.
      java.lang.String[] getTransformationDebugLog​(int n)
      Returns the last n entries in the transformation debug log.
      java.lang.String[] getTransformationLog​(int n)
      Returns the last n entries in the transformation log.
      java.lang.String getTransformationsByExtension​(java.lang.String sourceExtension, java.lang.String targetExtension, java.lang.String use)
      Lists all possible transformations sorted by source and then target mimetype extension.
      java.lang.String getTransformationsByTransformer​(java.lang.String simpleTransformerName, java.lang.String use)
      Lists all possible transformations sorted by Transformer name.
      java.lang.String getTransformationStatistics​(java.lang.String simpleTransformerName, java.lang.String sourceExtension, java.lang.String targetExtension)
      Lists the transformation statistics for the current node.
      java.lang.String[] getTransformerNames()
      Lists the names of all top level transformers.
      java.lang.String help()
      Returns a description of each method and its parameters.
      java.lang.String removeProperties​(java.lang.String propertyNames)
      Removes transformer properties.
      void setContentTransformerRegistry​(ContentTransformerRegistry transformerRegistry)  
      void setMimetypeService​(org.alfresco.service.cmr.repository.MimetypeService mimetypeService)  
      java.lang.String setProperties​(java.lang.String propertyNamesAndValues)
      Adds or replaces new transformer properties.
      void setTransformerConfig​(TransformerConfig transformerConfig)  
      void setTransformerDebug​(TransformerDebug transformerDebug)  
      void setTransformerDebugLog​(org.alfresco.repo.content.transform.LogEntries transformerDebugLog)  
      void setTransformerLog​(org.alfresco.repo.content.transform.LogEntries transformerLog)  
      java.lang.String testTransform​(java.lang.String simpleTransformerName, java.lang.String sourceExtension, java.lang.String targetExtension, java.lang.String use)
      Transforms a small test file from one mimetype to another and then shows the debug of the transform, which would indicate if it was successful or even if it was possible.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • TransformerConfigMBeanImpl

        public TransformerConfigMBeanImpl()

    • Method Detail

      • setTransformerDebug

        public void setTransformerDebug​(TransformerDebug transformerDebug)

      • setTransformerConfig

        public void setTransformerConfig​(TransformerConfig transformerConfig)

      • setMimetypeService

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

      • setTransformerLog

        public void setTransformerLog​(org.alfresco.repo.content.transform.LogEntries transformerLog)

      • setTransformerDebugLog

        public void setTransformerDebugLog​(org.alfresco.repo.content.transform.LogEntries transformerDebugLog)

      • getTransformationsByTransformer

        public java.lang.String getTransformationsByTransformer​(java.lang.String simpleTransformerName,
                                                        java.lang.String use)
        Description copied from interface: TransformerConfigMBean
        Lists all possible transformations sorted by Transformer name.
        Specified by:
        getTransformationsByTransformer in interface TransformerConfigMBean
        Parameters:
        simpleTransformerName - to be checked. If null all transformers are included.
        use - or context in which the transformation will be used ("doclib", "index", "webpreview", "syncRule", "asyncRule"...) or null for the default.

      • getTransformationsByExtension

        public java.lang.String getTransformationsByExtension​(java.lang.String sourceExtension,
                                                      java.lang.String targetExtension,
                                                      java.lang.String use)
        Description copied from interface: TransformerConfigMBean
        Lists all possible transformations sorted by source and then target mimetype extension.
        Specified by:
        getTransformationsByExtension in interface TransformerConfigMBean
        Parameters:
        sourceExtension - to be checked. If null all source mimetypes are included.
        targetExtension - to be checked. If null all target mimetypes are included.
        use - or context in which the transformation will be used ("doclib", "index", "webpreview", "syncRule", "asyncRule"...) or null for the default.

      • getTransformationStatistics

        public java.lang.String getTransformationStatistics​(java.lang.String simpleTransformerName,
                                                    java.lang.String sourceExtension,
                                                    java.lang.String targetExtension)
        Description copied from interface: TransformerConfigMBean
        Lists the transformation statistics for the current node.
        Specified by:
        getTransformationStatistics in interface TransformerConfigMBean
        Parameters:
        simpleTransformerName - to be checked. If null all transformers are included.
        sourceExtension - to be checked. If null all source mimetypes are included.
        targetExtension - to be checked. If null all target mimetypes are included.

      • getProperties

        public java.lang.String getProperties​(boolean listAll)
        Description copied from interface: TransformerConfigMBean
        Returns custom and default transformer propertiest.
        Specified by:
        getProperties in interface TransformerConfigMBean
        Parameters:
        listAll - list both default and custom values, otherwise includes only custom values.

      • setProperties

        public java.lang.String setProperties​(java.lang.String propertyNamesAndValues)
        Description copied from interface: TransformerConfigMBean
        Adds or replaces new transformer properties.
        Specified by:
        setProperties in interface TransformerConfigMBean
        Returns:
        a confirmation or failure message

      • removeProperties

        public java.lang.String removeProperties​(java.lang.String propertyNames)
        Description copied from interface: TransformerConfigMBean
        Removes transformer properties.
        Specified by:
        removeProperties in interface TransformerConfigMBean
        Parameters:
        propertyNames - to be removed. Any values after the property name are ignored.
        Returns:
        a confirmation or failure message

      • testTransform

        public java.lang.String testTransform​(java.lang.String simpleTransformerName,
                                      java.lang.String sourceExtension,
                                      java.lang.String targetExtension,
                                      java.lang.String use)
        Description copied from interface: TransformerConfigMBean
        Transforms a small test file from one mimetype to another and then shows the debug of the transform, which would indicate if it was successful or even if it was possible.
        Specified by:
        testTransform in interface TransformerConfigMBean
        Parameters:
        simpleTransformerName - to be used. If not specified the ContentService is used to select one.
        sourceExtension - used to identify the mimetype
        targetExtension - used to identify the mimetype
        use - or context in which to test the transformation ("doclib", "index", "webpreview", "syncRule", "asyncRule"...) or blank for the default.";
        Returns:
        Text indicating if the transform was possible and any debug