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.

Version:

$Revision: 49380 $

Nested Class Summary

static class

FileActionComponent.Operation Possible operation detected on a file

Field Summary

static String	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 :
static String	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 :
static char	FILE_SEPARATOR
static String	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 :
static String	REVISION

Method Summary

String	getDescription() More detailed description of the Parser.
String	getName() Name of the Parser.
int	getOrder() Used to schedule the FileProcessors while treating a file.
boolean	isAvailable() A processor or parser may be unavailable (for instance because of a network connection down).

Field Detail

REVISION

static final String REVISION

See Also:

Constant Field Values

FILE_SEPARATOR

static final char FILE_SEPARATOR

CURRENT_OPERATION

static final String 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:

Constant Field Values

PROCESSING_TYPE

static final String 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:

Constant Field Values

CURRENT_FILE_DOCUMENT

static final String 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:

Constant Field Values

Method Detail

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