Package org.alfresco.repo.content.transform

Interface TransformerConfigMBean

  • All Known Implementing Classes:
    TransformerConfigMBeanImpl
    public interface TransformerConfigMBean
    A management interface for monitoring Content Transformer configuration and statistics.
    Author:
    Alan Davis

    • Method Summary

      All Methods Instance Methods Abstract 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 transformerName, java.lang.String use)
      Lists all possible transformations sorted by Transformer name.
      java.lang.String getTransformationStatistics​(java.lang.String transformerName, 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.
      java.lang.String setProperties​(java.lang.String propertyNamesAndValues)
      Adds or replaces new transformer properties.
      java.lang.String testTransform​(java.lang.String transformerName, 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.

    • Method Detail

      • getTransformerNames

        java.lang.String[] getTransformerNames()
        Lists the names of all top level transformers.

      • getExtensionsAndMimetypes

        java.lang.String[] getExtensionsAndMimetypes()
        Lists all configured mimetypes, proceeded by its primary file extension.

      • getTransformationsByTransformer

        java.lang.String getTransformationsByTransformer​(java.lang.String transformerName,
                                                 java.lang.String use)
        Lists all possible transformations sorted by Transformer name.
        Parameters:
        transformerName - 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

        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.
        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

        java.lang.String getTransformationStatistics​(java.lang.String transformerName,
                                             java.lang.String sourceExtension,
                                             java.lang.String targetExtension)
        Lists the transformation statistics for the current node.
        Parameters:
        transformerName - 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.

      • getTransformationLog

        java.lang.String[] getTransformationLog​(int n)
        Returns the last n entries in the transformation log.

      • getTransformationDebugLog

        java.lang.String[] getTransformationDebugLog​(int n)
        Returns the last n entries in the transformation debug log.

      • getProperties

        java.lang.String getProperties​(boolean listAll)
        Returns custom and default transformer propertiest.
        Parameters:
        listAll - list both default and custom values, otherwise includes only custom values.

      • setProperties

        java.lang.String setProperties​(java.lang.String propertyNamesAndValues)
        Adds or replaces new transformer properties.
        Parameters:
        propertyNamesAndValues -
        Returns:
        a confirmation or failure message

      • removeProperties

        java.lang.String removeProperties​(java.lang.String propertyNames)
        Removes transformer properties.
        Parameters:
        propertyNames - to be removed. Any values after the property name are ignored.
        Returns:
        a confirmation or failure message

      • testTransform

        java.lang.String testTransform​(java.lang.String transformerName,
                               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.
        Parameters:
        transformerName - 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

      • getContextNames

        java.lang.String[] getContextNames()
        Lists the names of the contexts or uses.

      • getCustomePropertyNames

        java.lang.String[] getCustomePropertyNames()
        Lists custom (non default) property names.

      • getTestFileExtensionsAndMimetypes

        java.lang.String[] getTestFileExtensionsAndMimetypes()
        Lists the extensions of available test files.

      • help

        java.lang.String help()
        Returns a description of each method and its parameters.