ddf.catalog.plugin

Interface PreIngestPlugin

All Known Implementing Classes:

AbstractMetacardGroomerPlugin, DummyPreIngestPlugin, ExpirationDatePlugin, GeoCoderPlugin, IdentificationPlugin, MetacardValidityMarkerPlugin, SecurityLoggingPlugin, StandardMetacardGroomerPlugin, WorkspacePreIngestPlugin

public interface PreIngestPlugin

Executes business logic prior to an ingest operation executing. For example if Metacards need to be validated prior to CatalogProvider.create(CreateRequest) a PreIngestPlugin can do the validation.

See Also:

Metacard

Method Summary

Modifier and Type	Method and Description
CreateRequest	process(CreateRequest input) Process a CreateRequest prior to CatalogProvider.create(CreateRequest).
DeleteRequest	process(DeleteRequest input) Processes the DeleteRequest prior to the execution of the update operation.
UpdateRequest	process(UpdateRequest input) Process a UpdateRequest prior to CatalogProvider.update(UpdateRequest).

Method Detail

process

CreateRequest process(CreateRequest input)
               throws PluginExecutionException,
                      StopProcessingException

Process a CreateRequest prior to CatalogProvider.create(CreateRequest).

Parameters:

input - the CreateRequest to process

Returns:

the value of the processed CreateRequest to pass to the next PreIngestPlugin, or to the CatalogProvider if this is the last PreIngestPlugin to be called

Throws:

PluginExecutionException - if an error in processing occurs

StopProcessingException

process

UpdateRequest process(UpdateRequest input)
               throws PluginExecutionException,
                      StopProcessingException

Process a UpdateRequest prior to CatalogProvider.update(UpdateRequest).

Parameters:

input - the UpdateRequest to process

Returns:

the value of the processed UpdateRequest to pass to the next PreIngestPlugin, or to the CatalogProvider if this is the last PreIngestPlugin to be called

Throws:

PluginExecutionException - if an error in processing occurs

StopProcessingException

process

DeleteRequest process(DeleteRequest input)
               throws PluginExecutionException,
                      StopProcessingException

Processes the DeleteRequest prior to the execution of the update operation.

Parameters:

input - the DeleteRequest to process

Returns:

the value of the processed DeleteRequest to pass to the next PreIngestPlugin, or if this is the last PreIngestPlugin to be called

Throws:

PluginExecutionException - thrown when an error in processing occurs

StopProcessingException