ddf.catalog.cache.solr.impl

Class CachingFederationStrategy

java.lang.Object

ddf.catalog.cache.solr.impl.CachingFederationStrategy

All Implemented Interfaces:

FederationStrategy, PostIngestPlugin

public class CachingFederationStrategy
extends Object
implements FederationStrategy, PostIngestPlugin

This class represents a FederationStrategy based on sorting Metacards. The sorting is based on the Query's SortBy propertyName. The possible sorting values are

• Metacard.EFFECTIVE
• Result.TEMPORAL
• Result.DISTANCE
• Result.RELEVANCE

The supported ordering includes SortOrder.DESCENDING and SortOrder.ASCENDING. For this class to function properly a sort value and sort order must be provided.

See Also:

Metacard, Query, SortBy

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CACHE_QUERY_MODE Query the cache
protected static Comparator<Result>	DEFAULT_COMPARATOR The default comparator for sorting by Result.RELEVANCE, SortOrder.DESCENDING
protected static String	INDEX_QUERY_MODE Query and update the cache but block until done indexing
protected static String	NATIVE_QUERY_MODE Query without updating the cache
protected List<PostFederatedQueryPlugin>	postQuery The List of post-federated query plugins to execute on the query request after the query is executed on the Source.
protected List<PreFederatedQueryPlugin>	preQuery The List of pre-federated query plugins to execute on the query request before the query is executed on the Source.
protected static String	QUERY_MODE
protected static String	UPDATE_QUERY_MODE Query and update the cache without blocking

Constructor Summary

Constructors

Constructor and Description
CachingFederationStrategy(ExecutorService queryExecutorService, List<PreFederatedQueryPlugin> preQuery, List<PostFederatedQueryPlugin> postQuery, SolrCache cache, ExecutorService cacheExecutorService, ValidationQueryFactory validationQueryFactory, CacheQueryFactory cacheQueryFactory) Instantiates an AbstractFederationStrategy with the provided ExecutorService.

Method Summary

Modifier and Type	Method and Description
QueryResponse	federate(List<Source> sources, QueryRequest queryRequest) Federate the given query to the List of Sources, returning a QueryResponse back to the user that will include the matching Results.
boolean	getShowErrors()
boolean	getShowWarnings()
boolean	isCacheRemoteIngests()
CreateResponse	process(CreateResponse input) Processes the CreateResponse.
DeleteResponse	process(DeleteResponse input) Processes the DeleteResponse.
UpdateResponse	process(UpdateResponse input) Processes the UpdateResponse.
void	setCacheRemoteIngests(boolean cacheRemoteIngests)
void	setCacheStrategy(String cacheStrategy) Phaser that forces all added metacards to commit to the cache on phase advance
void	setCachingEverything(boolean cachingEverything)
void	setExpirationAgeInMinutes(long expirationAgeInMinutes)
void	setExpirationIntervalInMinutes(long expirationIntervalInMinutes)
void	setMaxStartIndex(int maxStartIndex) To be set via Spring/Blueprint
void	setShowErrors(boolean showErrors)
void	setShowWarnings(boolean showWarnings)
void	shutdown()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COMPARATOR

protected static final Comparator<Result> DEFAULT_COMPARATOR

The default comparator for sorting by Result.RELEVANCE, SortOrder.DESCENDING

QUERY_MODE

protected static final String QUERY_MODE

See Also:

Constant Field Values

CACHE_QUERY_MODE

protected static final String CACHE_QUERY_MODE

Query the cache

See Also:

Constant Field Values

NATIVE_QUERY_MODE

protected static final String NATIVE_QUERY_MODE

Query without updating the cache

See Also:

Constant Field Values

INDEX_QUERY_MODE

protected static final String INDEX_QUERY_MODE

Query and update the cache but block until done indexing

See Also:

Constant Field Values

UPDATE_QUERY_MODE

protected static final String UPDATE_QUERY_MODE

Query and update the cache without blocking

See Also:

Constant Field Values

preQuery

protected List<PreFederatedQueryPlugin> preQuery

The List of pre-federated query plugins to execute on the query request before the query is executed on the Source.

postQuery

protected List<PostFederatedQueryPlugin> postQuery

The List of post-federated query plugins to execute on the query request after the query is executed on the Source.

Constructor Detail

CachingFederationStrategy

public CachingFederationStrategy(ExecutorService queryExecutorService,
                                 List<PreFederatedQueryPlugin> preQuery,
                                 List<PostFederatedQueryPlugin> postQuery,
                                 SolrCache cache,
                                 ExecutorService cacheExecutorService,
                                 ValidationQueryFactory validationQueryFactory,
                                 CacheQueryFactory cacheQueryFactory)

Instantiates an AbstractFederationStrategy with the provided ExecutorService.

Parameters:

queryExecutorService - the ExecutorService for queries

Method Detail

federate

public QueryResponse federate(List<Source> sources,
                              QueryRequest queryRequest)

Description copied from interface: FederationStrategy

Federate the given query to the List of Sources, returning a QueryResponse back to the user that will include the matching Results.

Specified by:

federate in interface FederationStrategy

Parameters:

sources - the List of Sources to be queried. Cannot be null or empty.

queryRequest - the QueryRequest to execute. Cannot be null.

Returns:

QueryResponse which contains the list of Results.

process

public CreateResponse process(CreateResponse input)
                       throws PluginExecutionException

Description copied from interface: PostIngestPlugin

Processes the CreateResponse.

Specified by:

process in interface PostIngestPlugin

Parameters:

input - 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 input)
                       throws PluginExecutionException

Description copied from interface: PostIngestPlugin

Processes the UpdateResponse.

Specified by:

process in interface PostIngestPlugin

Parameters:

input - 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 input)
                       throws PluginExecutionException

Description copied from interface: PostIngestPlugin

Processes the DeleteResponse.

Specified by:

process in interface PostIngestPlugin

Parameters:

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

setMaxStartIndex

public void setMaxStartIndex(int maxStartIndex)

To be set via Spring/Blueprint

Parameters:

maxStartIndex - the new default max start index value

setExpirationIntervalInMinutes

public void setExpirationIntervalInMinutes(long expirationIntervalInMinutes)

setExpirationAgeInMinutes

public void setExpirationAgeInMinutes(long expirationAgeInMinutes)

setCachingEverything

public void setCachingEverything(boolean cachingEverything)

isCacheRemoteIngests

public boolean isCacheRemoteIngests()

setCacheRemoteIngests

public void setCacheRemoteIngests(boolean cacheRemoteIngests)

shutdown

public void shutdown()

getShowErrors

public boolean getShowErrors()

setShowErrors

public void setShowErrors(boolean showErrors)

getShowWarnings

public boolean getShowWarnings()

setShowWarnings

public void setShowWarnings(boolean showWarnings)

setCacheStrategy

public void setCacheStrategy(String cacheStrategy)

Phaser that forces all added metacards to commit to the cache on phase advance