org.codice.ddf.catalog.plugin.expiration

Class ExpirationDatePlugin

java.lang.Object

org.codice.ddf.catalog.plugin.expiration.ExpirationDatePlugin

All Implemented Interfaces:

PreIngestPlugin

public class ExpirationDatePlugin
extends Object
implements PreIngestPlugin

Pre-Ingest Plugin to overwrite Metacard expiration dates.

Constructor Summary

Constructors

Constructor and Description
ExpirationDatePlugin()

Method Summary

Modifier and Type	Method and Description
CreateRequest	process(CreateRequest createRequest) Modify metacard expiration dates (pre-ingest).
DeleteRequest	process(DeleteRequest deleteRequest) Processes the DeleteRequest prior to the execution of the update operation.
UpdateRequest	process(UpdateRequest updateRequest) Process a UpdateRequest prior to CatalogProvider.update(UpdateRequest).
void	setOffsetFromCreatedDate(int days)
void	setOverwriteIfBlank(boolean overwriteIfBlank)
void	setOverwriteIfExists(boolean overwriteIfExists)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExpirationDatePlugin

public ExpirationDatePlugin()

Method Detail

process

public CreateRequest process(CreateRequest createRequest)
                      throws PluginExecutionException,
                             StopProcessingException

Modify metacard expiration dates (pre-ingest).

Specified by:

process in interface PreIngestPlugin

Parameters:

createRequest - 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

public UpdateRequest process(UpdateRequest updateRequest)
                      throws PluginExecutionException,
                             StopProcessingException

Description copied from interface: PreIngestPlugin

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

Specified by:

process in interface PreIngestPlugin

Parameters:

updateRequest - 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

public DeleteRequest process(DeleteRequest deleteRequest)
                      throws PluginExecutionException,
                             StopProcessingException

Description copied from interface: PreIngestPlugin

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

Specified by:

process in interface PreIngestPlugin

Parameters:

deleteRequest - 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

setOffsetFromCreatedDate

public void setOffsetFromCreatedDate(int days)

setOverwriteIfBlank

public void setOverwriteIfBlank(boolean overwriteIfBlank)

setOverwriteIfExists

public void setOverwriteIfExists(boolean overwriteIfExists)