com.adobe.aemfd.watchfolder.service.api

Interface ProcessorContext

All Known Subinterfaces:

WorkflowContext

public interface ProcessorContext

Context for service-based file processing, which supplies the watch-folder inputs and configuration parameters, and acts as a placeholder for the outputs to be written out to the results sub-folder of the watch-folder.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getConfigParameters() Returns an immutable map representing the watch-folder configuration parameters.
Map<String,Document>	getInputMap() Returns an immutable map representing the watch-folder input.
String	getWatchFolderId() Returns the ID of the watch-folder whose inputs are being processed.
void	setResult(String fileName, Document contents) Adds a result which will be written out as a physical file into the results folder of the watch-folder.

Method Detail

getWatchFolderId

String getWatchFolderId()

Returns the ID of the watch-folder whose inputs are being processed.

Returns:

The ID of the watch-folder whose inputs are being processed.

getInputMap

Map<String,Document> getInputMap()

Returns an immutable map representing the watch-folder input. The key is the name of the physical file, while the value is a Document representing the file contents.
If the input placed into the top-level inputs folder of the watch-folder was a file, the input map will contain at most one entry (provided the file passed the watch-folder filter checks). If the input was a sub-folder, the map may contain multiple entries, one for each file within the sub-folder which passed the filter checks.

Returns:

An immutable map representing the watch-folder input.

getConfigParameters

Map<String,Object> getConfigParameters()

Returns an immutable map representing the watch-folder configuration parameters. The key is the name of the parameter, while the value is the parameter value of the correct type. For multi-valued parameters, the value is an array of the correct type.

Returns:

An immutable map representing the watch-folder configuration parameters.

setResult

void setResult(String fileName,
               Document contents)

Adds a result which will be written out as a physical file into the results folder of the watch-folder.

Parameters:

fileName - The name of the output file. This is used as the name of the physical output file only if the output-file-pattern of the watch-folder is a folder pattern. If the output-file-pattern is a file pattern, this is ignored.

contents - The contents of the output file. Must not be null.