org.codice.ddf.resourcemanagement.query.plugin

Interface QueryMonitorPlugin

All Superinterfaces:

PostFederatedQueryPlugin, PreFederatedQueryPlugin

All Known Implementing Classes:

QueryMonitorPluginImpl

public interface QueryMonitorPlugin
extends PreFederatedQueryPlugin, PostFederatedQueryPlugin

A QueryMonitorPlugin monitors ActiveSearches by maintaining a Map with a key of UUID and a value of ActiveSearch. QueryMonitorPlugin extends both PreFederatedQueryPlugin and PostFederatedQueryPlugin in order to process each search for every source. The PreFederatedQueryPlugin should be implemented to add the ActiveSearch to the Map and the PostFederatedQueryPlugin should be implemented to remove the ActiveSearch from the Map.

Method Summary

Modifier and Type	Method and Description
boolean	addActiveSearch(ActiveSearch as) Adds an ActiveSearch to the ActiveSearch Map
Map<UUID,ActiveSearch>	getActiveSearches() Returns a copy of the ActiveSearch Map
boolean	removeActiveSearch(UUID id) Removes an ActiveSearch from the ActiveSearch Map using it's UUID as a key
void	setRemoveSearchAfterComplete(boolean b) Sets a boolean which determines whether or not searches will be removed from the ActiveSearch Map upon search completion.

Methods inherited from interface ddf.catalog.plugin.PreFederatedQueryPlugin

process

Methods inherited from interface ddf.catalog.plugin.PostFederatedQueryPlugin

process

Method Detail

getActiveSearches

Map<UUID,ActiveSearch> getActiveSearches()

Returns a copy of the ActiveSearch Map

Returns:

Map <UUID, ActiveSearch> copy of the ActiveSearch Map

setRemoveSearchAfterComplete

void setRemoveSearchAfterComplete(boolean b)

Sets a boolean which determines whether or not searches will be removed from the ActiveSearch Map upon search completion. A value of true will remove searches from the Map as the searches finish and a value of false will keep the searches in the Map after they complete.

Parameters:

b - boolean value. A value of false will keep ActiveSearch's in the Map even after they finish (are no longer active). True will remove the ActiveSearches from the Map as the searches complete (default behavior is true)

removeActiveSearch

boolean removeActiveSearch(UUID id)

Removes an ActiveSearch from the ActiveSearch Map using it's UUID as a key

Parameters:

id - java.util.UUID that corresponds to the ActiveSearch to be removed from the Map

Returns:

boolean indicating if removing the ActiveSearch from the Map was successful

addActiveSearch

boolean addActiveSearch(ActiveSearch as)

Adds an ActiveSearch to the ActiveSearch Map

Parameters:

as - ActiveSearch that will be added to the Map

Returns:

boolean indicating if adding the ActiveSearch was successful