ddf.catalog.pubsub

Class EventProcessorImpl

java.lang.Object

ddf.catalog.pubsub.EventProcessorImpl

All Implemented Interfaces:

EventProcessor, PostIngestPlugin, org.osgi.service.event.EventHandler

Direct Known Subclasses:

FanoutEventProcessor

public class EventProcessorImpl
extends Object
implements EventProcessor, org.osgi.service.event.EventHandler, PostIngestPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventProcessorImpl.DateType Enumeration of metacard Date attributes that can be used for subscriptions.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.osgi.framework.BundleContext	bundleContext
protected CatalogFramework	catalog
static double	EQUATORIAL_RADIUS_IN_METERS
protected org.osgi.service.event.EventAdmin	eventAdmin
protected List<PreDeliveryPlugin>	preDelivery
protected List<PreSubscriptionPlugin>	preSubscription

Fields inherited from interface ddf.catalog.event.EventProcessor

EVENT_METACARD, EVENT_OLD_METACARD, EVENT_TIME, EVENTS_TOPIC_CREATED, EVENTS_TOPIC_DELETED, EVENTS_TOPIC_UPDATED

Constructor Summary

Constructors

Constructor and Description
EventProcessorImpl()
EventProcessorImpl(org.osgi.framework.BundleContext bundleContext, org.osgi.service.event.EventAdmin eventAdmin, List<PreSubscriptionPlugin> preSubscription, List<PreDeliveryPlugin> preDelivery, CatalogFramework catalog)

Method Summary

Modifier and Type	Method and Description
String	createSubscription(Subscription subscription) Create a Subscription with an automatically-generated id.
void	createSubscription(Subscription subscription, String subscriptionId) Register a Subscription with this CatalogFramework.
void	deleteSubscription(String subscriptionId) Deletes the subscription associated with the given id.
void	destroy()
void	handleEvent(org.osgi.service.event.Event event) By default the Felix EventAdmin implementation has a timeout of 5000 ms.
void	init()
void	notifyCreated(Metacard newMetacard) Notify this EventProcessor that a Metacard (or equivalent) has been created in a RemoteSource.
void	notifyDeleted(Metacard oldMetacard) Notify this EventProcessor that a Metacard (or equivalent) has been deleted in a RemoteSource.
void	notifyUpdated(Metacard newMetacard, Metacard oldMetacard) Notify this EventProcessor that a Metacard (or equivalent) has been updated in a RemoteSource.
protected void	postEvent(String topic, Metacard card, Metacard oldCard) Posts a Metacard to a given topic
CreateResponse	process(CreateResponse createResponse) Processes the CreateResponse.
DeleteResponse	process(DeleteResponse deleteResponse) Processes the DeleteResponse.
UpdateResponse	process(UpdateResponse updateResponse) Processes the UpdateResponse.
static void	processEntry(Metacard metacard, String operation, org.osgi.service.event.EventAdmin eventAdmin) Processes an entry by adding properties from the metacard to the event.
void	updateSubscription(Subscription subscription, String subscriptionId) Updates the subscription associated with the given id.

Methods inherited from class java.lang.Object

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

Field Detail

EQUATORIAL_RADIUS_IN_METERS

public static final double EQUATORIAL_RADIUS_IN_METERS

See Also:

Constant Field Values

eventAdmin

protected org.osgi.service.event.EventAdmin eventAdmin

bundleContext

protected org.osgi.framework.BundleContext bundleContext

preSubscription

protected List<PreSubscriptionPlugin> preSubscription

preDelivery

protected List<PreDeliveryPlugin> preDelivery

catalog

protected CatalogFramework catalog

Constructor Detail

EventProcessorImpl

public EventProcessorImpl()

EventProcessorImpl

public EventProcessorImpl(org.osgi.framework.BundleContext bundleContext,
                          org.osgi.service.event.EventAdmin eventAdmin,
                          List<PreSubscriptionPlugin> preSubscription,
                          List<PreDeliveryPlugin> preDelivery,
                          CatalogFramework catalog)

Method Detail

processEntry

public static void processEntry(Metacard metacard,
                                String operation,
                                org.osgi.service.event.EventAdmin eventAdmin)

Processes an entry by adding properties from the metacard to the event. Then the eventAdmin is used to post the metacard properties as a single event.

Parameters:

metacard - - the metacard to process

operation - - The type of event PubSubConstants

eventAdmin - - OSGi EventAdmin service used post events

init

public void init()

destroy

public void destroy()

handleEvent

public void handleEvent(org.osgi.service.event.Event event)

By default the Felix EventAdmin implementation has a timeout of 5000 ms. Your event handler has to return from the handle event method in this time frame. If it does not, it gets Blacklisted. Therefore, this method processes its events in a separate thread than the EventAdmin who called it.

Specified by:

handleEvent in interface org.osgi.service.event.EventHandler

createSubscription

public String createSubscription(Subscription subscription)
                          throws InvalidSubscriptionException

Description copied from interface: EventProcessor

Create a Subscription with an automatically-generated id.

Specified by:

createSubscription in interface EventProcessor

Parameters:

subscription - the Subscription to register

Returns:

String an id for the registered Subscription that can be used later by calling #unsubscribe(String)

Throws:

InvalidSubscriptionException - if this EventProcessor can not support the Filter of the provided Subscription.

See Also:

EventProcessor.createSubscription(Subscription, String)

createSubscription

public void createSubscription(Subscription subscription,
                               String subscriptionId)
                        throws InvalidSubscriptionException,
                               SubscriptionExistsException

Description copied from interface: EventProcessor

Register a Subscription with this CatalogFramework.

Note: Subscriptions are transient, not durable, i.e., only maintained in memory and will be lost if DDF is shutdown.
Durability must be implemented by the client bundle (typically an endpoint - refer to DurableSubscription for an example).

Note: A Subscription can also be registered using the whiteboard model:
To register a Subscription via the whiteboard model, simply register any implementation of Subscription with OSGi registry under the interface Subscription. To unregister the Subscription, simply unregister the service that was originally registered. Subscriptions registered in this manner do not get a subscription id and cannot be unsubscribed via the EventProcessor Implementations of this method must call the PreSubscriptionPlugin.process(Subscription) method for each

Specified by:

createSubscription in interface EventProcessor

Parameters:

subscription - the Subscription to register

subscriptionId - the desired id

Throws:

InvalidSubscriptionException - if this EventProcessor can not support the Filter of the provided Subscription.

SubscriptionExistsException - if a subscription with this ID already exists

updateSubscription

public void updateSubscription(Subscription subscription,
                               String subscriptionId)
                        throws SubscriptionNotFoundException

Description copied from interface: EventProcessor

Updates the subscription associated with the given id.

Specified by:

updateSubscription in interface EventProcessor

Parameters:

subscription - the subscription to update

subscriptionId - the subscription id to identify the subscription

Throws:

SubscriptionNotFoundException - if the subscription was not found

deleteSubscription

public void deleteSubscription(String subscriptionId)
                        throws SubscriptionNotFoundException

Description copied from interface: EventProcessor

Deletes the subscription associated with the given id.

Specified by:

deleteSubscription in interface EventProcessor

Parameters:

subscriptionId - the subscription id to identify the subscription to delete

Throws:

SubscriptionNotFoundException - if the subscription was not found

notifyCreated

public void notifyCreated(Metacard newMetacard)

Description copied from interface: EventProcessor

Notify this EventProcessor that a Metacard (or equivalent) has been created in a RemoteSource.

Implementations of this method must:

1. Call the PreDeliveryPlugin.processCreate(Metacard) method for all of the registered PreDeliveryPlugins
2. Call the DeliveryMethod.created(Metacard) method of the DeliveryMethod of matching Subscriptions with the new Metacard created.

Specified by:

notifyCreated in interface EventProcessor

Parameters:

newMetacard - the newly created Metacard

See Also:

RemoteSource, FederatedSource, ConnectedSource

notifyUpdated

public void notifyUpdated(Metacard newMetacard,
                          Metacard oldMetacard)

Description copied from interface: EventProcessor

Notify this EventProcessor that a Metacard (or equivalent) has been updated in a RemoteSource.

Implementations of this method must:

1. Call PreDeliveryPlugin.processUpdateHit(ddf.catalog.operation.Update) method of all registered PreDeliveryPlugins when a Metacard has been updated and the new version matches a Subscription
2. Call PreDeliveryPlugin.processUpdateMiss(ddf.catalog.operation.Update) method of all registered PreDeliveryPlugins when a Metacard has been updated and the new version matches a Subscription but the old version does not
3. Call all registered implementations of DeliveryMethod with the updated Metacard.

Specified by:

notifyUpdated in interface EventProcessor

Parameters:

newMetacard - the new version of the Metacard

oldMetacard - the previous version of the Metacard (optional, pass null if not relevant)

See Also:

FederatedSource, RemoteSource, ConnectedSource

notifyDeleted

public void notifyDeleted(Metacard oldMetacard)

Description copied from interface: EventProcessor

Notify this EventProcessor that a Metacard (or equivalent) has been deleted in a RemoteSource.

Implementations of this method must:

If possible (that is, the Metacard is fully populated) call all active matching Subscriptions associated DeliveryMethod.deleted(Metacard) with the Metacard that was deleted. If impossible (this is, the Metacard only has Metacard.getId(), call all active Subscriptions.

Specified by:

notifyDeleted in interface EventProcessor

Parameters:

oldMetacard - the deleted Metacard

See Also:

RemoteSource, FederatedSource, ConnectedSource

postEvent

protected void postEvent(String topic,
                         Metacard card,
                         Metacard oldCard)

Posts a Metacard to a given topic

Parameters:

topic - - The topic to post the event

card - - The Metacard that will be posted to the topic

process

public CreateResponse process(CreateResponse createResponse)
                       throws PluginExecutionException

Description copied from interface: PostIngestPlugin

Processes the CreateResponse.

Specified by:

process in interface PostIngestPlugin

Parameters:

createResponse - the CreateResponse to process

Returns:

the value of the processed CreateResponse to pass to the next PostIngestPlugin, or if this is the last PostIngestPlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs during processing

process

public UpdateResponse process(UpdateResponse updateResponse)
                       throws PluginExecutionException

Description copied from interface: PostIngestPlugin

Processes the UpdateResponse.

Specified by:

process in interface PostIngestPlugin

Parameters:

updateResponse - the UpdateResponse to process

Returns:

the value of the processed UpdateResponse to pass to the next PostIngestPlugin, or if this is the last PostIngestPlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs during processing

process

public DeleteResponse process(DeleteResponse deleteResponse)
                       throws PluginExecutionException

Description copied from interface: PostIngestPlugin

Processes the DeleteResponse.

Specified by:

process in interface PostIngestPlugin

Parameters:

deleteResponse - the DeleteResponse to process

Returns:

the value of the processed DeleteResponse to pass to the next PostIngestPlugin, or if this is the last PostIngestPlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs during processing