org.codice.ddf.resourcemanagement.query.plugin

Class QueryMonitorPluginImpl

java.lang.Object

org.codice.ddf.resourcemanagement.query.plugin.QueryMonitorPluginImpl

All Implemented Interfaces:

PostFederatedQueryPlugin, PreFederatedQueryPlugin, QueryMonitorPlugin

public class QueryMonitorPluginImpl
extends Object
implements QueryMonitorPlugin

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEARCH_ID

Constructor Summary

Constructors

Constructor and Description
QueryMonitorPluginImpl()

Method Summary

Modifier and Type	Method and Description
boolean	addActiveSearch(ActiveSearch activeSearch) Adds an ActiveSearch to the ActiveSearch Map
Map<UUID,ActiveSearch>	getActiveSearches() Returns a copy of the ActiveSearch Map
QueryResponse	process(QueryResponse input) Method that is implemented for PostFederatedQueryPlugin.
QueryRequest	process(Source source, QueryRequest input) Method that is implemented for PreFederatedQueryPlugin.
boolean	removeActiveSearch(UUID uniqueID) Removes an ActiveSearch from the ActiveSearch Map using it's UUID as a key
void	setRemoveSearchAfterComplete(boolean removeSearchAfterComplete) Sets a boolean which determines whether or not searches will be removed from the ActiveSearch Map upon search completion.

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_ID

public static final String SEARCH_ID

See Also:

Constant Field Values

Constructor Detail

QueryMonitorPluginImpl

public QueryMonitorPluginImpl()

Method Detail

getActiveSearches

public Map<UUID,ActiveSearch> getActiveSearches()

Returns a copy of the ActiveSearch Map

Specified by:

getActiveSearches in interface QueryMonitorPlugin

Returns:

Map <UUID, ActiveSearch> copy of the ActiveSearch Map

setRemoveSearchAfterComplete

public void setRemoveSearchAfterComplete(boolean removeSearchAfterComplete)

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.

Specified by:

setRemoveSearchAfterComplete in interface QueryMonitorPlugin

Parameters:

removeSearchAfterComplete - 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)

addActiveSearch

public boolean addActiveSearch(ActiveSearch activeSearch)

Adds an ActiveSearch to the ActiveSearch Map

Specified by:

addActiveSearch in interface QueryMonitorPlugin

Parameters:

activeSearch - ActiveSearch that will be added to the Map

Returns:

boolean indicating if adding the ActiveSearch was successful

removeActiveSearch

public boolean removeActiveSearch(UUID uniqueID)

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

Specified by:

removeActiveSearch in interface QueryMonitorPlugin

Parameters:

uniqueID - 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

process

public QueryRequest process(Source source,
                            QueryRequest input)
                     throws PluginExecutionException,
                            StopProcessingException

Method that is implemented for PreFederatedQueryPlugin. Uses the given Source and QueryRequest information to create a new ActiveSearch to add to the ActiveSearch Map.

Specified by:

process in interface PreFederatedQueryPlugin

Parameters:

source - Source that corresponds to source the search is querying

input - QueryRequest that corresponds to request generated when a user queried the source

Returns:

QueryRequest that was given as a parameter with updated property information corresponding to the ActiveSearch's UUID

Throws:

PluginExecutionException - thrown when an error occurs while processing the QueryRequest

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

process

public QueryResponse process(QueryResponse input)
                      throws PluginExecutionException,
                             StopProcessingException

Method that is implemented for PostFederatedQueryPlugin. Uses the given QueryResponse information to remove the ActiveSearch from the ActiveSearch Map.

Specified by:

process in interface PostFederatedQueryPlugin

Parameters:

input - QueryResponse that corresponds to response from the source that was queried by the user's original QueryRequest

Returns:

QueryResponse that was given as a parameter

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.