Package ddf.catalog.plugin

Interface PreDeliveryPlugin

public interface PreDeliveryPlugin

The PreDeliveryPlugin is executed prior to an event being delivered.

Author:

Michael Menousek

Method Summary

Modifier and Type	Method	Description
Metacard	processCreate(Metacard metacard)	Callback invoked when a Metacard has created
Metacard	processDelete(Metacard metacard)	Callback invoked when a Metacard has been deleted
Update	processUpdateHit(Update update)	Callback invoked when a Metacard has been updated and the new version matches a Subscription.
Update	processUpdateMiss(Update update)	Callback invoked when a Metacard has been updated and only the old version matches a Subscription

Method Details

processCreate

Metacard processCreate(Metacard metacard)
                throws PluginExecutionException,
StopProcessingException

Callback invoked when a Metacard has created

Parameters:

metacard - - the newly created Metacard

Returns:

the value of the Metacard to pass to the next PreDeliveryPlugin, or if this is the last PreDeliveryPlugin to be called, the DeliveryMethod

Throws:

PluginExecutionException - if there is a problem evaluating the update but processing should continue

StopProcessingException - if this Catalog Plugin will not allow the current notification to occur

processUpdateMiss

Update processUpdateMiss(Update update)
                  throws PluginExecutionException,
StopProcessingException

Callback invoked when a Metacard has been updated and only the old version matches a Subscription

Parameters:

update -

Returns:

the Update to pass to the next PreDeliveryPlugin, or if this is the last PreDeliveryPlugin to be called, the DeliveryMethod

Throws:

PluginExecutionException - if there is a problem evaluating the update but processing should continue

StopProcessingException - if this Catalog Plugin will not allow the current notification to occur

processUpdateHit

Update processUpdateHit(Update update)
                 throws PluginExecutionException,
StopProcessingException

Callback invoked when a Metacard has been updated and the new version matches a Subscription. The old version may or may not match the Subscription

Parameters:

update -

Returns:

the Update to pass to the next PreDeliveryPlugin, or if this is the last PreDeliveryPlugin to be called, the DeliveryMethod

Throws:

PluginExecutionException - if there is a problem evaluating the update but processing should continue

StopProcessingException - if this Catalog Plugin will not allow the current notification to occur

processDelete

Metacard processDelete(Metacard metacard)
                throws PluginExecutionException,
StopProcessingException

Callback invoked when a Metacard has been deleted

Parameters:

metacard - - the deleted Metacard

Returns:

the Metacard to pass to the next PreDeliveryPlugin, or if this is the last PreDeliveryPlugin to be called, the DeliveryMethod

Throws:

PluginExecutionException - if there is a problem evaluating the update but processing should continue

StopProcessingException - if this Catalog Plugin will not allow the current notification to occur