org.codice.ddf.catalog.async.plugin.api.internal

Interface PostProcessPlugin

public interface PostProcessPlugin

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

A PostProcessPlugin represents a process that will be run asynchronously by the ProcessingFramework. The PostProcessPlugins may only be run after the Metacards have been ingested into the catalog. This will allow the PostProcessPlugins to be able to use a copy of the Metacard, and optionally a copy of the associated Resource of the catalog-stored record, in order to perform processing asynchronously.

Method Summary

Modifier and Type	Method and Description
ProcessRequest<ProcessCreateItem>	processCreate(ProcessRequest<ProcessCreateItem> input) Submits a ProcessRequest to be processed by the PostProcessPlugin.
ProcessRequest<ProcessDeleteItem>	processDelete(ProcessRequest<ProcessDeleteItem> input) Submits a ProcessRequest to be processed by the PostProcessPlugin.
ProcessRequest<ProcessUpdateItem>	processUpdate(ProcessRequest<ProcessUpdateItem> input) Submits a ProcessRequest to be processed by the PostProcessPlugin.

Method Detail

processCreate

ProcessRequest<ProcessCreateItem> processCreate(ProcessRequest<ProcessCreateItem> input)
                                         throws PluginExecutionException

Submits a ProcessRequest to be processed by the PostProcessPlugin. The returned ProcessRequest must be the same instance as the .

Parameters:

input - the ProcessRequest to be processed

Returns:

the modified ProcessRequest after processing

Throws:

PluginExecutionException

processUpdate

ProcessRequest<ProcessUpdateItem> processUpdate(ProcessRequest<ProcessUpdateItem> input)
                                         throws PluginExecutionException

Submits a ProcessRequest to be processed by the PostProcessPlugin. The returned ProcessRequest must be the same instance as the .

Parameters:

input - the ProcessRequest to be processed

Returns:

the modified ProcessRequest after processing

Throws:

PluginExecutionException

processDelete

ProcessRequest<ProcessDeleteItem> processDelete(ProcessRequest<ProcessDeleteItem> input)
                                         throws PluginExecutionException

Submits a ProcessRequest to be processed by the PostProcessPlugin. The returned ProcessRequest must be the same instance as the .

Parameters:

input - the ProcessRequest to be processed

Returns:

the modified ProcessRequest after processing

Throws:

PluginExecutionException