Package com.jalios.jcms.fileprocessor
Interface FileActionComponent
- All Known Subinterfaces:
FileParser,FileProcessor
- All Known Implementing Classes:
SampleProcessor
public interface FileActionComponent
This interface defines the way a Parser or a Processor must be implemented.
Belongs to the core of the FileProcessor.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enumPossible operation detected on a file -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringWhen a FileActionComponent (FileProcessor or FileParser) is invoked on the JCMS Upload repository, the FileDocument for which it is invoked is available through the processing context using this attribute :static final StringWhen a FileActionComponent (FileProcessor or FileParser) is invoked, the operation for which it is invoked is available through the processing context using this attribute :static final charstatic final StringWhen a FileActionComponent (FileProcessor or FileParser) is invoked, the type of processing for which it is invoked is available through the processing context using this attribute : -
Method Summary
-
Field Details
-
FILE_SEPARATOR
static final char FILE_SEPARATOR -
CURRENT_OPERATION
When a FileActionComponent (FileProcessor or FileParser) is invoked, the operation for which it is invoked is available through the processing context using this attribute :FileActionComponent.Operation operation = (FileActionComponent.Operation) ctxt.get(FileActionComponent.CURRENT_OPERATION);
- See Also:
-
PROCESSING_TYPE
When a FileActionComponent (FileProcessor or FileParser) is invoked, the type of processing for which it is invoked is available through the processing context using this attribute :ProcessingData.Type processingType = (ProcessingData.Type) ctxt.get(FileActionComponent.PROCESSING_TYPE);
- Since:
- jcms-7.1.1
- See Also:
-
CURRENT_FILE_DOCUMENT
When a FileActionComponent (FileProcessor or FileParser) is invoked on the JCMS Upload repository, the FileDocument for which it is invoked is available through the processing context using this attribute :FileDocument doc = (FileDocument) ctxt.get(FileActionComponent.CURRENT_FILE_DOCUMENT);
Beware that this value might be null.- Since:
- jcms-8.0.0
- See Also:
-
-
Method Details
-
getName
String getName()Name of the Parser. Used in the logs, to identify the FileActionComponent.- Returns:
- The description.
-
getDescription
String getDescription()More detailed description of the Parser.- Returns:
- The description.
-
getOrder
int getOrder()Used to schedule the FileProcessors while treating a file. Default is 0. FileActionComponent are called in the same order as their order values.- Returns:
- order
-
isAvailable
boolean isAvailable()A processor or parser may be unavailable (for instance because of a network connection down).- Returns:
- true is the processor or parser is available
-