com.jalios.jcms.fileprocessor
Interface FileProcessor

All Superinterfaces:
FileActionComponent
All Known Implementing Classes:
SampleProcessor

public interface FileProcessor
extends FileActionComponent

A class that implements this interface is a processor for at least one kind of files.

Version:
$Revision: 26572 $

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.jalios.jcms.fileprocessor.FileActionComponent
FileActionComponent.Operation
 
Field Summary
 
Fields inherited from interface com.jalios.jcms.fileprocessor.FileActionComponent
CURRENT_FILE_DOCUMENT, CURRENT_OPERATION, FILE_SEPARATOR, PROCESSING_TYPE, REVISION
 
Method Summary
 boolean process(File file, Map<String,Object> ctxt)
          Method invoked to process a file.
 
Methods inherited from interface com.jalios.jcms.fileprocessor.FileActionComponent
getDescription, getName, getOrder, isAvailable
 

Method Detail

process

boolean process(File file,
                Map<String,Object> ctxt)
                throws ProcessingException
Method invoked to process a file.

Parameters:
file - the file to process
ctxt - a Map to share informations between processings.
Returns:
true if the process was successfully performed, false if no action was processed (do not return false in case of error, instead throw a ProcessingException).
Throws:
ProcessingException - if the processing operation failed or if the file should be blacklisted (for this or all processors)


Copyright © 2001-2010 Jalios SA. All Rights Reserved.