ddf.catalog.plugin

Interface PostFederatedQueryPlugin

All Known Subinterfaces:

QueryMonitorPlugin

All Known Implementing Classes:

QueryMonitorPluginImpl, SecurityLoggingPlugin, SourceMetricsImpl

public interface PostFederatedQueryPlugin

A PostFederatedQueryPlugin is used to execute functionality after a federated query has been executed. For example if metrics need to be recorded on the query, a PostFederatedQueryPlugin could be implemented to do this prior to the query response being returned to the CatalogFramework.

Author:

rodgersh

Method Summary

Modifier and Type	Method and Description
QueryResponse	process(QueryResponse input) Processes a QueryResponse after the execution of the Federated Query.

Method Detail

process

QueryResponse process(QueryResponse input)
               throws PluginExecutionException,
                      StopProcessingException

Processes a QueryResponse after the execution of the Federated Query.

Parameters:

input - the Federated QueryResponse to process

Returns:

the value of the processed QueryResponse to pass to the next PostFederatedQueryPlugin, or if this is the last PostFederatedQueryPlugin to be called

Throws:

PluginExecutionException - thrown when an error occurs while processing the QueryResponse

StopProcessingException - thrown to halt processing when a critical issue occurs during processing. This is intended to prevent other plugins from processing as well.