ddf.sdk.plugin.predelivery

Class DummyPreDeliveryPlugin

java.lang.Object

ddf.sdk.plugin.predelivery.DummyPreDeliveryPlugin

All Implemented Interfaces:

PreDeliveryPlugin

public class DummyPreDeliveryPlugin
extends Object
implements PreDeliveryPlugin

Constructor Summary

Constructors

Constructor and Description
DummyPreDeliveryPlugin()

Method Summary

Modifier and Type	Method and 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

Methods inherited from class java.lang.Object

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

Constructor Detail

DummyPreDeliveryPlugin

public DummyPreDeliveryPlugin()

Method Detail

processCreate

public Metacard processCreate(Metacard metacard)
                       throws PluginExecutionException,
                              StopProcessingException

Description copied from interface: PreDeliveryPlugin

Callback invoked when a Metacard has created

Specified by:

processCreate in interface PreDeliveryPlugin

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

public Update processUpdateMiss(Update update)
                         throws PluginExecutionException,
                                StopProcessingException

Description copied from interface: PreDeliveryPlugin

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

Specified by:

processUpdateMiss in interface PreDeliveryPlugin

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

public Update processUpdateHit(Update update)
                        throws PluginExecutionException,
                               StopProcessingException

Description copied from interface: PreDeliveryPlugin

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

Specified by:

processUpdateHit in interface PreDeliveryPlugin

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

public Metacard processDelete(Metacard metacard)
                       throws PluginExecutionException,
                              StopProcessingException

Description copied from interface: PreDeliveryPlugin

Callback invoked when a Metacard has been deleted

Specified by:

processDelete in interface PreDeliveryPlugin

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