Interface TransformerConfigMBean

  • All Known Implementing Classes:
    TransformerConfigMBeanImpl

    @Deprecated
    public interface TransformerConfigMBean
    Deprecated.
    The transformations code is being moved out of the codebase and replaced by the new async RenditionService2 or other external libraries.
    A management interface for monitoring Content Transformer configuration and statistics.
    Author:
    Alan Davis
    • Method Detail

      • getTransformerNames

        String[] getTransformerNames()
        Deprecated.
        Lists the names of all top level transformers.
      • getExtensionsAndMimetypes

        String[] getExtensionsAndMimetypes()
        Deprecated.
        Lists all configured mimetypes, proceeded by its primary file extension.
      • getTransformationsByTransformer

        @Deprecated
        String getTransformationsByTransformer​(String transformerName,
                                               String use)
        Deprecated.
        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

        String getTransformationsByExtension​(String sourceExtension,
                                             String targetExtension,
                                             String use)
        Deprecated.
        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

        @Deprecated
        String getTransformationStatistics​(String transformerName,
                                           String sourceExtension,
                                           String targetExtension)
        Deprecated.
        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

        String[] getTransformationLog​(int n)
        Deprecated.
        Returns the last n entries in the transformation log.
      • getTransformationDebugLog

        String[] getTransformationDebugLog​(int n)
        Deprecated.
        Returns the last n entries in the transformation debug log.
      • getProperties

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

        @Deprecated
        String setProperties​(String propertyNamesAndValues)
        Deprecated.
        Adds or replaces new transformer properties.
        Parameters:
        propertyNamesAndValues -
        Returns:
        a confirmation or failure message
      • removeProperties

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

        String testTransform​(String transformerName,
                             String sourceExtension,
                             String targetExtension,
                             String use)
        Deprecated.
        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

        String[] getContextNames()
        Deprecated.
        Lists the names of the contexts or uses.
      • getCustomePropertyNames

        String[] getCustomePropertyNames()
        Deprecated.
        Lists custom (non default) property names.
      • getTestFileExtensionsAndMimetypes

        String[] getTestFileExtensionsAndMimetypes()
        Deprecated.
        Lists the extensions of available test files.
      • help

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