Package org.nuxeo.ecm.platform.convert.plugins

Class CommandLineConverter

java.lang.Object

org.nuxeo.ecm.platform.convert.plugins.CommandLineBasedConverter

org.nuxeo.ecm.platform.convert.plugins.CommandLineConverter

All Implemented Interfaces:

Converter, ExternalConverter

Direct Known Subclasses:

LibreOfficeConverter

public class CommandLineConverter
extends CommandLineBasedConverter

Generic converter executing a contributed command line.

The command line to call is stored in the CommandLineName parameter.

The target file name is in the targetFileName parameter. If it's null, a temporary one will be created.

All the converter parameters are passed to the command line.

A sample contribution using this converter:

 
     <converter name="pdf2image" class="org.nuxeo.ecm.platform.convert.plugins.CommandLineConverter">
       <sourceMimeType>application/pdf</sourceMimeType>
       <destinationMimeType>image/jpeg</destinationMimeType>
       <destinationMimeType>image/png</destinationMimeType>
       <destinationMimeType>image/gif</destinationMimeType>
       <parameters>
         <parameter name="CommandLineName">pdftoimage</parameter>
       </parameters>
     </converter>
 
 

Since:

7.1

Nested Class Summary

Nested classes/interfaces inherited from class org.nuxeo.ecm.platform.convert.plugins.CommandLineBasedConverter

CommandLineBasedConverter.CmdReturn

Field Summary

Fields

Modifier and Type	Field	Description
static String	OUT_DIR_PATH_KEY
static List<String>	RESERVED_PARAMETERS
static String	SOURCE_FILE_PATH_KEY
static String	TARGET_FILE_NAME_KEY
static String	TARGET_FILE_PATH_KEY

Fields inherited from class org.nuxeo.ecm.platform.convert.plugins.CommandLineBasedConverter

CMD_NAME_PARAMETER, initParameters, TMP_PATH_PARAMETER

Constructor Summary

Constructors

Constructor	Description
CommandLineConverter()

Method Summary

Modifier and Type	Method	Description
protected BlobHolder	buildResult(List<String> cmdOutput, CmdParameters cmdParams)	Builds result from commandLine output buffer.
protected Map<String,Blob>	getCmdBlobParameters(BlobHolder blobHolder, Map<String,Serializable> parameters)	Extracts BlobParameters.
protected Map<String,String>	getCmdStringParameters(BlobHolder blobHolder, Map<String,Serializable> parameters)	Extracts String parameters.

Methods inherited from class org.nuxeo.ecm.platform.convert.plugins.CommandLineBasedConverter

convert, execOnBlob, getCommandLineService, getCommandName, getTmpDirectory, init, isConverterAvailable

Methods inherited from class java.lang.Object

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

Field Detail

SOURCE_FILE_PATH_KEY

public static final String SOURCE_FILE_PATH_KEY

See Also:

Constant Field Values

OUT_DIR_PATH_KEY

public static final String OUT_DIR_PATH_KEY

See Also:

Constant Field Values

TARGET_FILE_NAME_KEY

public static final String TARGET_FILE_NAME_KEY

See Also:

Constant Field Values

TARGET_FILE_PATH_KEY

public static final String TARGET_FILE_PATH_KEY

See Also:

Constant Field Values

RESERVED_PARAMETERS

public static final List<String> RESERVED_PARAMETERS

Constructor Detail

CommandLineConverter

public CommandLineConverter()

Method Detail

getCmdBlobParameters

protected Map<String,Blob> getCmdBlobParameters(BlobHolder blobHolder,
                                                      Map<String,Serializable> parameters)
                                               throws ConversionException

Description copied from class: CommandLineBasedConverter

Extracts BlobParameters.

Specified by:

getCmdBlobParameters in class CommandLineBasedConverter

Throws:

ConversionException

getCmdStringParameters

protected Map<String,String> getCmdStringParameters(BlobHolder blobHolder,
                                                          Map<String,Serializable> parameters)
                                                   throws ConversionException

Description copied from class: CommandLineBasedConverter

Extracts String parameters.

Specified by:

getCmdStringParameters in class CommandLineBasedConverter

Throws:

ConversionException

buildResult

protected BlobHolder buildResult(List<String> cmdOutput,
                                 CmdParameters cmdParams)
                          throws ConversionException

Description copied from class: CommandLineBasedConverter

Builds result from commandLine output buffer.

Specified by:

buildResult in class CommandLineBasedConverter

Throws:

ConversionException