org.sakaiproject.search.elasticsearch

Class BaseElasticSearchIndexBuilder

java.lang.Object

org.sakaiproject.search.elasticsearch.BaseElasticSearchIndexBuilder

All Implemented Interfaces:

SearchIndexBuilder, ElasticSearchIndexBuilder

Direct Known Subclasses:

SiteElasticSearchIndexBuilder

public abstract class BaseElasticSearchIndexBuilder
extends Object
implements ElasticSearchIndexBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BaseElasticSearchIndexBuilder.BulkContentIndexerTask This is the task that searches for any docs in the search index that do not have content yet, digests the content and loads it into the index.
static class	BaseElasticSearchIndexBuilder.IndexAction
protected static class	BaseElasticSearchIndexBuilder.NoOpTask
protected class	BaseElasticSearchIndexBuilder.RebuildIndexTask

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ADD_RESOURCE_VALIDATION_KEY_CONTENT_PRODUCER
protected static String	ADD_RESOURCE_VALIDATION_KEY_ENTITY_ID
protected static String	ADD_RESOURCE_VALIDATION_KEY_INDEX_ACTION
protected static String	ADD_RESOURCE_VALIDATION_KEY_RESOURCE_NAME Key in the "validation map" built up by validateAddResourceEvent(Event) (specifically validateResourceName(Event, Map).
protected static SecurityAdvisor	allowAllAdvisor
protected Timer	backgroundScheduler indexing thread that performs loading the actual content into the index.
protected int	bulkRequestSize Number of actions to send in one elasticsearch bulk index call defaults to 10.
protected org.elasticsearch.client.Client	client ES Client, with access to any indexes in the cluster.
protected int	contentIndexBatchSize Number of documents to index at a time for each run of the context indexing task (defaults to 500).
protected static String	DEFAULT_FACET_NAME
protected static String	DEFAULT_SUGGESTION_MATCHING_FIELD_NAME
protected String	defaultIndexSettingsResource
protected String	defaultMappingResource
protected int	delay number seconds of wait after startup before starting the BulkContentIndexerTask (defaults to 3 minutes)
protected static String	DELETE_RESOURCE_KEY_DOCUMENT_ID
protected static String	DELETE_RESOURCE_KEY_ENTITY_REFERENCE
protected ElasticSearchIndexBuilderEventRegistrar	eventRegistrar
protected EventTrackingService	eventTrackingService
protected String	facetName
protected int	facetTermSize N most frequent terms
protected SearchItemFilter	filter
protected String	indexedDocumentType
protected String	indexName the ES indexname
protected String	indexSettings Expects a JSON string of ElasticSearch index settings.
protected Map<String,String>	indexSettingsMerged Combination of indexSettings, its fallback read from defaultIndexSettingsResource and overrides read in from ServerConfigurationService.
protected long	lastLoad
protected String	mapping by default the mapping in configured in the mapping.json file.
protected String	mappingMerged Combination of mapping, its fallback read from defaultMappingResource, and any overrides implemented in initializeElasticSearchMapping(String).
protected int	maxNumberOfSuggestions max number of suggestions to return when looking for suggestions (this populates the autocomplete drop down in the UI)
protected String	name Logical, well-known name, possibly distinct from the physical ES indexName
protected int	period how often the BulkContentIndexerTask runs in seconds (defaults to 1 minute)
protected Set<EntityContentProducer>	producers
protected boolean	rebuildIndexOnStartup set to true to force an index rebuild at startup time, defaults to false.
protected String[]	searchResultFieldNames
protected SecurityService	securityService
protected ServerConfigurationService	serverConfigurationService
protected long	startTime
protected String	suggestionMatchingFieldName
protected String[]	suggestionResultFieldNames
protected boolean	testMode this turns off the threads and does indexing inline.
protected Set<String>	triggerFunctions
protected boolean	useFacetting
protected boolean	useSuggestions

Fields inherited from interface org.sakaiproject.search.api.SearchIndexBuilder

DEFAULT_INDEX_BUILDER_NAME, DEFAULT_INDEX_NAME

Constructor Summary

Constructors

Constructor and Description
BaseElasticSearchIndexBuilder()

Method Summary

Modifier and Type	Method and Description
protected org.elasticsearch.common.xcontent.XContentBuilder	addContent(org.elasticsearch.common.xcontent.XContentBuilder contentSourceBuilder, String resourceName, EntityContentProducer ecp, boolean includeContent)
protected org.elasticsearch.common.xcontent.XContentBuilder	addCustomProperties(org.elasticsearch.common.xcontent.XContentBuilder contentSourceBuilder, String resourceName, EntityContentProducer ecp, boolean includeContent)
protected abstract org.elasticsearch.common.xcontent.XContentBuilder	addFields(org.elasticsearch.common.xcontent.XContentBuilder contentSourceBuilder, String resourceName, EntityContentProducer ecp, boolean includeContent)
protected org.elasticsearch.action.search.SearchRequestBuilder	addFindContentQueueRequestParams(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder)
void	addResource(Notification notification, Event event)
protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder>	addSearchCoreParams(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders, String searchTerms, List<String> references, List<String> siteIds)
protected org.elasticsearch.action.search.SearchRequestBuilder	addSearchFacetting(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder)
protected org.elasticsearch.action.search.SearchRequestBuilder	addSearchPagination(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder, int start, int end)
protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder>	addSearchQuery(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders, String searchTerms, List<String> references, List<String> siteIds)
protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder>	addSearchReferences(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders, List<String> references)
protected org.elasticsearch.action.search.SearchRequestBuilder	addSearchResultFields(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder)
protected abstract org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder>	addSearchSiteIds(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders, List<String> siteIds)
protected org.elasticsearch.action.search.SearchRequestBuilder	addSearchSuggestionResultFields(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder)
protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder>	addSearchSuggestionsCoreParams(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders, String searchString, String currentSite, boolean allMySites)
protected org.elasticsearch.action.search.SearchRequestBuilder	addSearchSuggestionsPagination(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder)
protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder>	addSearchSuggestionsQuery(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders, String searchString, String currentSite, boolean allMySites)
protected abstract org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder>	addSearchSuggestionsSites(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders, String currentSite, boolean allMySites)
protected abstract org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder>	addSearchSuggestionsTerms(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders, String searchString)
protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder>	addSearchTerms(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders, String searchTerms)
protected void	assureIndex() creates a new index if one does not exist
protected abstract void	beforeBackgroundSchedulerInitialization() Called after all ES config has been processed but before the background scheduler has been set up and before any index startup ops have been invoked (initializeIndex().
protected abstract void	beforeElasticSearchConfigInitialization() Gives subclasses a chance to initialize configuration prior to reading/processing any ES configs.
protected org.elasticsearch.common.xcontent.XContentBuilder	buildIndexRequestContentSource(String resourceName, EntityContentProducer ecp, boolean includeContent)
protected abstract void	completeAddResourceEventValidations(Event event, Map<String,Object> validationContext)
protected abstract org.elasticsearch.action.delete.DeleteRequestBuilder	completeDeleteRequestBuilder(org.elasticsearch.action.delete.DeleteRequestBuilder deleteRequestBuilder, Map<String,Object> deleteParams)
protected abstract org.elasticsearch.action.search.SearchRequestBuilder	completeFindContentQueueRequestBuilder(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder)
protected abstract org.elasticsearch.action.index.IndexRequestBuilder	completeIndexRequestBuilder(org.elasticsearch.action.index.IndexRequestBuilder requestBuilder, String resourceName, EntityContentProducer ecp, boolean includeContent)
protected org.elasticsearch.common.xcontent.XContentBuilder	completeIndexRequestContentSourceBuilder(org.elasticsearch.common.xcontent.XContentBuilder contentSourceBuilder, String resourceName, EntityContentProducer ecp, boolean includeContent)
protected abstract org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder>	completeSearchRequestBuilders(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders, String searchTerms, List<String> references, List<String> siteIds)
protected abstract org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder>	completeSearchSuggestionsRequestBuilders(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders, String searchString, String currentSite, boolean allMySites)
protected void	createIndex() creates a new index, does not check if the exist exists
protected void	deleteDocument(NoContentException noContentException)
protected void	deleteDocument(org.elasticsearch.search.SearchHit searchHit)
protected void	deleteDocumentWithParams(Map<String,Object> deleteParams)
protected org.elasticsearch.action.delete.DeleteResponse	deleteDocumentWithRequest(org.elasticsearch.action.delete.DeleteRequestBuilder deleteRequestBuilder)
void	destroy()
protected void	disableAzgSecurityAdvisor() Disable the security advisor.
protected void	dispatchValidatedAddResource(Map<String,Object> validationContext)
protected void	enableAzgSecurityAdvisor() Establish a security advisor to allow the "embedded" work to occur with no need for additional security permissions.
protected void	executeBulkRequest(org.elasticsearch.action.bulk.BulkRequestBuilder bulkRequest)
protected Map<String,Collection<String>>	extractCustomProperties(String resourceName, EntityContentProducer contentProducer) Extract properties from the given EntityContentProducer The EntityContentProducer.getCustomProperties(String) method returns a map of different kind of elements.
protected Map<String,Object>	extractDeleteDocumentParams(Map<String,Object> validationContext)
protected Map<String,Object>	extractDeleteDocumentParams(NoContentException noContentException)
protected Map<String,Object>	extractDeleteDocumentParams(org.elasticsearch.search.SearchHit searchHit)
protected org.elasticsearch.action.search.SearchResponse	findContentQueue()
protected org.elasticsearch.action.search.SearchResponse	findContentQueueWithRequest(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder)
List<SearchBuilderItem>	getAllSearchItems()
Set<String>	getContentFunctions()
List<EntityContentProducer>	getContentProducers() get all the producers registered, as a clone to avoid concurrent modification exceptions
String	getFacetName()
String	getFieldFromSearchHit(String field, org.elasticsearch.search.SearchHit hit) loads the field from the SearchHit.
SearchItemFilter	getFilter()
List<SearchBuilderItem>	getGlobalMasterSearchItems()
protected abstract org.slf4j.Logger	getLog()
String	getName()
int	getNDocs()
int	getPendingDocuments()
SearchStatus	getSearchStatus()
StringBuilder	getStatus(StringBuilder into)
Set<String>	getTriggerFunctions()
boolean	getUseFacetting()
protected void	indexAdd(String resourceName, EntityContentProducer ecp) schedules content for indexing.
void	initialize(ElasticSearchIndexBuilderEventRegistrar eventRegistrar, org.elasticsearch.client.Client client)
protected Timer	initializeBackgroundScheduler()
protected TimerTask	initializeContentQueueProcessingTask()
protected Map<String,String>	initializeElasticSearchIndexSettings(String injectedConfig)
protected String	initializeElasticSearchMapping(String injectedConfig)
protected void	initializeIndex()
boolean	isBuildQueueEmpty()
boolean	isEnabled()
protected boolean	isSupportedIndexAction(BaseElasticSearchIndexBuilder.IndexAction action)
protected Optional<EntityContentProducer>	matchEntityContentProducer(Predicate<EntityContentProducer> matcher)
protected TimerTask	newBulkContentIndexerTask()
protected org.elasticsearch.action.bulk.BulkRequestBuilder	newContentQueueBulkUpdateRequestBuilder()
EntityContentProducer	newEntityContentProducer(Event event) Find a EntityContentProducer capable of handling the given Event, or null if no such producer has been registered.
EntityContentProducer	newEntityContentProducer(String ref) Find a EntityContentProducer capable of handling the given entity reference, or null if no such producer has been registered.
protected org.elasticsearch.action.search.SearchRequestBuilder	newFindContentQueueRequestBuilder()
protected org.elasticsearch.action.index.IndexRequestBuilder	newIndexRequestBuilder(String resourceName, EntityContentProducer ecp, boolean includeContent)
protected org.elasticsearch.common.xcontent.XContentBuilder	newIndexRequestContentSourceBuilder(String resourceName, EntityContentProducer ecp, boolean includeContent)
protected TimerTask	newRebuildIndexTask()
protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder>	newSearchRequestAndQueryBuilders(String searchTerms, List<String> references, List<String> siteIds)
protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder>	newSearchSuggestionsRequestAndQueryBuilders(String searchString, String currentSite, boolean allMySites)
protected abstract org.elasticsearch.common.xcontent.XContentBuilder	noContentForIndexRequest(org.elasticsearch.common.xcontent.XContentBuilder contentSourceBuilder, String resourceName, EntityContentProducer ecp, boolean includeContent)
protected void	noContentProducerForContentQueueEntry(org.elasticsearch.search.SearchHit hit, String reference)
protected <L,R> org.elasticsearch.common.lang3.tuple.Pair<L,R>	pairOf(L left, R right)
protected org.elasticsearch.action.delete.DeleteRequestBuilder	prepareDeleteDocument(Map<String,Object> deleteParams)
protected org.elasticsearch.action.search.SearchRequestBuilder	prepareFindContentQueue()
protected org.elasticsearch.action.index.IndexRequestBuilder	prepareIndex(String resourceName, EntityContentProducer ecp, boolean includeContent)
protected void	prepareIndexAdd(String resourceName, EntityContentProducer ecp, boolean includeContent)
protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder>	prepareSearchRequest(String searchTerms, List<String> references, List<String> siteIds, int start, int end)
protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder>	prepareSearchSuggestionsRequest(String searchString, String currentSite, boolean allMySites)
protected void	processContentQueue() Searches for any docs in the search index that have not been indexed yet, digests the content and loads it into the index.
protected void	processContentQueueEntry(org.elasticsearch.search.SearchHit hit, org.elasticsearch.action.bulk.BulkRequestBuilder bulkRequest)
void	rebuildIndex() Removes any existing index, creates a new index, and rebuilds the index from the entities own stored state
protected abstract void	rebuildIndexImmediately()
protected void	recreateIndex() removes any existing index and creates a new one
void	refreshIndex() refresh the index from the current stored state
void	registerEntityContentProducer(EntityContentProducer ecp) register an entity content producer to provide content to the search engine
protected void	requireConfiguration()
protected double	roundTwoDecimals(double d)
org.elasticsearch.action.search.SearchResponse	search(String searchTerms, List<String> references, List<String> siteIds, int start, int end)
org.elasticsearch.action.search.SearchResponse	search(String searchTerms, List<String> references, List<String> siteIds, int start, int end, Map<String,String> additionalSearchInformation)
String[]	searchSuggestions(String searchString, String currentSite, boolean allMySites)
void	setBulkRequestSize(int bulkRequestSize)
void	setContentIndexBatchSize(int contentIndexBatchSize)
void	setDefaultIndexSettingsResource(String defaultIndexSettingsResource)
void	setDefaultMappingResource(String defaultMappingResource)
void	setDelay(int delay)
void	setEventTrackingService(EventTrackingService eventTrackingService)
void	setFacetName(String facetName)
void	setFacetTermSize(int facetTermSize)
void	setFilter(SearchItemFilter filter)
void	setIndexedDocumentType(String indexedDocumentType)
void	setIndexName(String indexName)
void	setIndexSettings(String indexSettings)
void	setMapping(String mapping)
void	setMaxNumberOfSuggestions(int maxNumberOfSuggestions)
void	setName(String name)
void	setPeriod(int period)
void	setRebuildIndexOnStartup(boolean rebuildIndexOnStartup)
void	setSearchResultFieldNames(String[] searchResultFieldNames)
void	setSecurityService(SecurityService securityService)
void	setServerConfigurationService(ServerConfigurationService serverConfigurationService)
void	setSuggestionMatchingFieldName(String suggestionMatchingFieldName)
void	setSuggestionResultFieldNames(String[] suggestionResultFieldNames)
void	setTestMode(boolean testMode)
void	setTriggerFunctions(Collection<String> triggerFunctions)
void	setUseFacetting(boolean useFacetting)
void	setUseSuggestions(boolean useSuggestions)
protected Map<String,Object>	validateAddResourceEvent(Event event)
protected void	validateContentProducer(Event event, Map<String,Object> validationContext)
protected void	validateIndexable(Event event, Map<String,Object> validationContext)
protected void	validateIndexAction(Event event, Map<String,Object> validationContext)
protected void	validateResourceName(Event event, Map<String,Object> validationContext)
protected void	validateServiceEnabled(Event event, Map<String,Object> validationContext)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sakaiproject.search.elasticsearch.ElasticSearchIndexBuilder

getEventResourceFilter

Field Detail

DEFAULT_FACET_NAME

protected static final String DEFAULT_FACET_NAME

See Also:

Constant Field Values

DEFAULT_SUGGESTION_MATCHING_FIELD_NAME

protected static final String DEFAULT_SUGGESTION_MATCHING_FIELD_NAME

See Also:

Constant Field Values

ADD_RESOURCE_VALIDATION_KEY_RESOURCE_NAME

protected static final String ADD_RESOURCE_VALIDATION_KEY_RESOURCE_NAME

Key in the "validation map" built up by validateAddResourceEvent(Event) (specifically validateResourceName(Event, Map).

See Also:

Constant Field Values

ADD_RESOURCE_VALIDATION_KEY_CONTENT_PRODUCER

protected static final String ADD_RESOURCE_VALIDATION_KEY_CONTENT_PRODUCER

See Also:

Constant Field Values

ADD_RESOURCE_VALIDATION_KEY_INDEX_ACTION

protected static final String ADD_RESOURCE_VALIDATION_KEY_INDEX_ACTION

See Also:

Constant Field Values

ADD_RESOURCE_VALIDATION_KEY_ENTITY_ID

protected static final String ADD_RESOURCE_VALIDATION_KEY_ENTITY_ID

See Also:

Constant Field Values

DELETE_RESOURCE_KEY_DOCUMENT_ID

protected static final String DELETE_RESOURCE_KEY_DOCUMENT_ID

See Also:

Constant Field Values

DELETE_RESOURCE_KEY_ENTITY_REFERENCE

protected static final String DELETE_RESOURCE_KEY_ENTITY_REFERENCE

See Also:

Constant Field Values

allowAllAdvisor

protected static final SecurityAdvisor allowAllAdvisor

securityService

protected SecurityService securityService

serverConfigurationService

protected ServerConfigurationService serverConfigurationService

eventTrackingService

protected EventTrackingService eventTrackingService

client

protected org.elasticsearch.client.Client client

ES Client, with access to any indexes in the cluster.

indexName

protected String indexName

the ES indexname

name

protected String name

Logical, well-known name, possibly distinct from the physical ES indexName

rebuildIndexOnStartup

protected boolean rebuildIndexOnStartup

set to true to force an index rebuild at startup time, defaults to false. This is probably something you never want to use, other than in development or testing

useSuggestions

protected boolean useSuggestions

maxNumberOfSuggestions

protected int maxNumberOfSuggestions

max number of suggestions to return when looking for suggestions (this populates the autocomplete drop down in the UI)

suggestionMatchingFieldName

protected String suggestionMatchingFieldName

suggestionResultFieldNames

protected String[] suggestionResultFieldNames

searchResultFieldNames

protected String[] searchResultFieldNames

filter

protected SearchItemFilter filter

useFacetting

protected boolean useFacetting

facetName

protected String facetName

facetTermSize

protected int facetTermSize

N most frequent terms

contentIndexBatchSize

protected int contentIndexBatchSize

Number of documents to index at a time for each run of the context indexing task (defaults to 500). Setting this too low will slow things down, setting it to high won't allow all nodes in the cluster to share the load.

bulkRequestSize

protected int bulkRequestSize

Number of actions to send in one elasticsearch bulk index call defaults to 10. Setting this to too high a number will have memory implications as you'll be keeping more content in memory until the request is executed.

delay

protected int delay

number seconds of wait after startup before starting the BulkContentIndexerTask (defaults to 3 minutes)

period

protected int period

how often the BulkContentIndexerTask runs in seconds (defaults to 1 minute)

startTime

protected long startTime

lastLoad

protected long lastLoad

testMode

protected boolean testMode

this turns off the threads and does indexing inline. DO NOT enable this in prod. It is meant for testing, especially unit tests only.

defaultMappingResource

protected String defaultMappingResource

mapping

protected String mapping

by default the mapping in configured in the mapping.json file. This can be overridden by injecting json into this property. See elasticsearch mapping reference for more information on configuration that is available. For example, if you want to change the analyzer config for a particular field this is the place to do it.

mappingMerged

protected String mappingMerged

Combination of mapping, its fallback read from defaultMappingResource, and any overrides implemented in initializeElasticSearchMapping(String). (Currently there are no such overrides in that method... just the fallback resource lookup. And historically the mapping config was stored exclusively in mapping. This new mappingMerged field was added for symmetry with indexSettingsMerged).

defaultIndexSettingsResource

protected String defaultIndexSettingsResource

indexSettings

protected String indexSettings

Expects a JSON string of ElasticSearch index settings. You can set this in your sakai.properties files and inject a value using the indexSettings@org.sakaiproject.search.api.SearchIndexBuilder property. By default this value is configured by the indexSettings.json files. See elasticsearch index modules for more information on configuration that is available.

indexSettingsMerged

protected Map<String,String> indexSettingsMerged

Combination of indexSettings, its fallback read from defaultIndexSettingsResource and overrides read in from ServerConfigurationService. This is the operational set of index configs. indexSettings is just preserved for reference.

indexedDocumentType

protected String indexedDocumentType

backgroundScheduler

protected Timer backgroundScheduler

indexing thread that performs loading the actual content into the index.

producers

protected Set<EntityContentProducer> producers

triggerFunctions

protected Set<String> triggerFunctions

eventRegistrar

protected ElasticSearchIndexBuilderEventRegistrar eventRegistrar

Constructor Detail

BaseElasticSearchIndexBuilder

public BaseElasticSearchIndexBuilder()

Method Detail

isEnabled

public boolean isEnabled()

destroy

public void destroy()

Specified by:

destroy in interface SearchIndexBuilder

initialize

public void initialize(ElasticSearchIndexBuilderEventRegistrar eventRegistrar,
                       org.elasticsearch.client.Client client)

Specified by:

initialize in interface ElasticSearchIndexBuilder

beforeElasticSearchConfigInitialization

protected abstract void beforeElasticSearchConfigInitialization()

Gives subclasses a chance to initialize configuration prior to reading/processing any ES configs. May be important for setting up defaults, for example, or for ensuring subclass-specific configs are in place before any background tasks are in place. (Though the latter would be better factored into beforeBackgroundSchedulerInitialization()

requireConfiguration

protected void requireConfiguration()

beforeBackgroundSchedulerInitialization

protected abstract void beforeBackgroundSchedulerInitialization()

Called after all ES config has been processed but before the background scheduler has been set up and before any index startup ops have been invoked (initializeIndex(). I.e. this is a subclass's last chance to set up any configs on which background jobs and/or index maintenance in general might depend.

initializeElasticSearchMapping

protected String initializeElasticSearchMapping(String injectedConfig)

initializeElasticSearchIndexSettings

protected Map<String,String> initializeElasticSearchIndexSettings(String injectedConfig)

initializeBackgroundScheduler

protected Timer initializeBackgroundScheduler()

initializeContentQueueProcessingTask

protected TimerTask initializeContentQueueProcessingTask()

newBulkContentIndexerTask

protected TimerTask newBulkContentIndexerTask()

newRebuildIndexTask

protected TimerTask newRebuildIndexTask()

processContentQueue

protected void processContentQueue()

Searches for any docs in the search index that have not been indexed yet, digests the content and loads it into the index. Any docs with empty content will be removed from the index.

processContentQueueEntry

protected void processContentQueueEntry(org.elasticsearch.search.SearchHit hit,
                                        org.elasticsearch.action.bulk.BulkRequestBuilder bulkRequest)
                                 throws NoContentException

Throws:

NoContentException

executeBulkRequest

protected void executeBulkRequest(org.elasticsearch.action.bulk.BulkRequestBuilder bulkRequest)

noContentProducerForContentQueueEntry

protected void noContentProducerForContentQueueEntry(org.elasticsearch.search.SearchHit hit,
                                                     String reference)
                                              throws NoContentException

Throws:

NoContentException

newContentQueueBulkUpdateRequestBuilder

protected org.elasticsearch.action.bulk.BulkRequestBuilder newContentQueueBulkUpdateRequestBuilder()

findContentQueue

protected org.elasticsearch.action.search.SearchResponse findContentQueue()

prepareFindContentQueue

protected org.elasticsearch.action.search.SearchRequestBuilder prepareFindContentQueue()

newFindContentQueueRequestBuilder

protected org.elasticsearch.action.search.SearchRequestBuilder newFindContentQueueRequestBuilder()

addFindContentQueueRequestParams

protected org.elasticsearch.action.search.SearchRequestBuilder addFindContentQueueRequestParams(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder)

completeFindContentQueueRequestBuilder

protected abstract org.elasticsearch.action.search.SearchRequestBuilder completeFindContentQueueRequestBuilder(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder)

findContentQueueWithRequest

protected org.elasticsearch.action.search.SearchResponse findContentQueueWithRequest(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder)

deleteDocument

protected void deleteDocument(org.elasticsearch.search.SearchHit searchHit)

deleteDocument

protected void deleteDocument(NoContentException noContentException)

deleteDocumentWithParams

protected void deleteDocumentWithParams(Map<String,Object> deleteParams)

prepareDeleteDocument

protected org.elasticsearch.action.delete.DeleteRequestBuilder prepareDeleteDocument(Map<String,Object> deleteParams)

completeDeleteRequestBuilder

protected abstract org.elasticsearch.action.delete.DeleteRequestBuilder completeDeleteRequestBuilder(org.elasticsearch.action.delete.DeleteRequestBuilder deleteRequestBuilder,
                                                                                                     Map<String,Object> deleteParams)

deleteDocumentWithRequest

protected org.elasticsearch.action.delete.DeleteResponse deleteDocumentWithRequest(org.elasticsearch.action.delete.DeleteRequestBuilder deleteRequestBuilder)

extractDeleteDocumentParams

protected Map<String,Object> extractDeleteDocumentParams(org.elasticsearch.search.SearchHit searchHit)

extractDeleteDocumentParams

protected Map<String,Object> extractDeleteDocumentParams(NoContentException noContentException)

initializeIndex

protected void initializeIndex()

assureIndex

protected void assureIndex()

creates a new index if one does not exist

createIndex

protected void createIndex()

creates a new index, does not check if the exist exists

recreateIndex

protected void recreateIndex()

removes any existing index and creates a new one

rebuildIndex

public void rebuildIndex()

Removes any existing index, creates a new index, and rebuilds the index from the entities own stored state

Specified by:

rebuildIndex in interface SearchIndexBuilder

rebuildIndexImmediately

protected abstract void rebuildIndexImmediately()

refreshIndex

public void refreshIndex()

refresh the index from the current stored state

Specified by:

refreshIndex in interface SearchIndexBuilder

prepareIndex

protected org.elasticsearch.action.index.IndexRequestBuilder prepareIndex(String resourceName,
                                                                          EntityContentProducer ecp,
                                                                          boolean includeContent)
                                                                   throws IOException,
                                                                          NoContentException

Parameters:

resourceName -

ecp -

Returns:

Throws:

IOException

NoContentException

newIndexRequestBuilder

protected org.elasticsearch.action.index.IndexRequestBuilder newIndexRequestBuilder(String resourceName,
                                                                                    EntityContentProducer ecp,
                                                                                    boolean includeContent)
                                                                             throws IOException

Throws:

IOException

completeIndexRequestBuilder

protected abstract org.elasticsearch.action.index.IndexRequestBuilder completeIndexRequestBuilder(org.elasticsearch.action.index.IndexRequestBuilder requestBuilder,
                                                                                                  String resourceName,
                                                                                                  EntityContentProducer ecp,
                                                                                                  boolean includeContent)
                                                                                           throws IOException

Throws:

IOException

buildIndexRequestContentSource

protected org.elasticsearch.common.xcontent.XContentBuilder buildIndexRequestContentSource(String resourceName,
                                                                                           EntityContentProducer ecp,
                                                                                           boolean includeContent)
                                                                                    throws NoContentException,
                                                                                           IOException

Throws:

NoContentException

IOException

newIndexRequestContentSourceBuilder

protected org.elasticsearch.common.xcontent.XContentBuilder newIndexRequestContentSourceBuilder(String resourceName,
                                                                                                EntityContentProducer ecp,
                                                                                                boolean includeContent)
                                                                                         throws IOException

Throws:

IOException

addFields

protected abstract org.elasticsearch.common.xcontent.XContentBuilder addFields(org.elasticsearch.common.xcontent.XContentBuilder contentSourceBuilder,
                                                                               String resourceName,
                                                                               EntityContentProducer ecp,
                                                                               boolean includeContent)
                                                                        throws IOException

Throws:

IOException

addCustomProperties

protected org.elasticsearch.common.xcontent.XContentBuilder addCustomProperties(org.elasticsearch.common.xcontent.XContentBuilder contentSourceBuilder,
                                                                                String resourceName,
                                                                                EntityContentProducer ecp,
                                                                                boolean includeContent)
                                                                         throws IOException

Throws:

IOException

addContent

protected org.elasticsearch.common.xcontent.XContentBuilder addContent(org.elasticsearch.common.xcontent.XContentBuilder contentSourceBuilder,
                                                                       String resourceName,
                                                                       EntityContentProducer ecp,
                                                                       boolean includeContent)
                                                                throws NoContentException,
                                                                       IOException

Throws:

NoContentException

IOException

noContentForIndexRequest

protected abstract org.elasticsearch.common.xcontent.XContentBuilder noContentForIndexRequest(org.elasticsearch.common.xcontent.XContentBuilder contentSourceBuilder,
                                                                                              String resourceName,
                                                                                              EntityContentProducer ecp,
                                                                                              boolean includeContent)
                                                                                       throws NoContentException

Throws:

NoContentException

completeIndexRequestContentSourceBuilder

protected org.elasticsearch.common.xcontent.XContentBuilder completeIndexRequestContentSourceBuilder(org.elasticsearch.common.xcontent.XContentBuilder contentSourceBuilder,
                                                                                                     String resourceName,
                                                                                                     EntityContentProducer ecp,
                                                                                                     boolean includeContent)
                                                                                              throws IOException

Throws:

IOException

prepareIndexAdd

protected void prepareIndexAdd(String resourceName,
                               EntityContentProducer ecp,
                               boolean includeContent)
                        throws NoContentException

Parameters:

resourceName -

ecp -

Throws:

NoContentException

indexAdd

protected void indexAdd(String resourceName,
                        EntityContentProducer ecp)

schedules content for indexing.

Parameters:

resourceName -

ecp -

getPendingDocuments

public int getPendingDocuments()

Specified by:

getPendingDocuments in interface SearchIndexBuilder

isBuildQueueEmpty

public boolean isBuildQueueEmpty()

Specified by:

isBuildQueueEmpty in interface SearchIndexBuilder

addResource

public void addResource(Notification notification,
                        Event event)

Specified by:

addResource in interface SearchIndexBuilder

validateAddResourceEvent

protected Map<String,Object> validateAddResourceEvent(Event event)
                                               throws IllegalArgumentException,
                                                      IllegalStateException

Throws:

IllegalArgumentException

IllegalStateException

validateServiceEnabled

protected void validateServiceEnabled(Event event,
                                      Map<String,Object> validationContext)
                               throws IllegalArgumentException,
                                      IllegalStateException

Throws:

IllegalArgumentException

IllegalStateException

validateResourceName

protected void validateResourceName(Event event,
                                    Map<String,Object> validationContext)
                             throws IllegalArgumentException,
                                    IllegalStateException

Throws:

IllegalArgumentException

IllegalStateException

validateContentProducer

protected void validateContentProducer(Event event,
                                       Map<String,Object> validationContext)
                                throws IllegalArgumentException,
                                       IllegalStateException

Throws:

IllegalArgumentException

IllegalStateException

validateIndexable

protected void validateIndexable(Event event,
                                 Map<String,Object> validationContext)
                          throws IllegalArgumentException,
                                 IllegalStateException

Throws:

IllegalArgumentException

IllegalStateException

validateIndexAction

protected void validateIndexAction(Event event,
                                   Map<String,Object> validationContext)
                            throws IllegalArgumentException,
                                   IllegalStateException,
                                   UnsupportedOperationException

Throws:

IllegalArgumentException

IllegalStateException

UnsupportedOperationException

isSupportedIndexAction

protected boolean isSupportedIndexAction(BaseElasticSearchIndexBuilder.IndexAction action)

completeAddResourceEventValidations

protected abstract void completeAddResourceEventValidations(Event event,
                                                            Map<String,Object> validationContext)
                                                     throws IllegalArgumentException,
                                                            IllegalStateException

Throws:

IllegalArgumentException

IllegalStateException

dispatchValidatedAddResource

protected void dispatchValidatedAddResource(Map<String,Object> validationContext)

extractDeleteDocumentParams

protected Map<String,Object> extractDeleteDocumentParams(Map<String,Object> validationContext)

extractCustomProperties

protected Map<String,Collection<String>> extractCustomProperties(String resourceName,
                                                                 EntityContentProducer contentProducer)

Extract properties from the given EntityContentProducer

The EntityContentProducer.getCustomProperties(String) method returns a map of different kind of elements. To avoid casting and calls to instanceof, extractCustomProperties does all the work and returns a formated map containing only Collection.

Parameters:

resourceName - affected resource

contentProducer - producer providing properties for the given resource

Returns:

a formated map of Collection

search

public org.elasticsearch.action.search.SearchResponse search(String searchTerms,
                                                             List<String> references,
                                                             List<String> siteIds,
                                                             int start,
                                                             int end)

Specified by:

search in interface ElasticSearchIndexBuilder

search

public org.elasticsearch.action.search.SearchResponse search(String searchTerms,
                                                             List<String> references,
                                                             List<String> siteIds,
                                                             int start,
                                                             int end,
                                                             Map<String,String> additionalSearchInformation)

Specified by:

search in interface ElasticSearchIndexBuilder

prepareSearchRequest

protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> prepareSearchRequest(String searchTerms,
                                                                                                                                                                          List<String> references,
                                                                                                                                                                          List<String> siteIds,
                                                                                                                                                                          int start,
                                                                                                                                                                          int end)

newSearchRequestAndQueryBuilders

protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> newSearchRequestAndQueryBuilders(String searchTerms,
                                                                                                                                                                                      List<String> references,
                                                                                                                                                                                      List<String> siteIds)

addSearchCoreParams

protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> addSearchCoreParams(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders,
                                                                                                                                                                         String searchTerms,
                                                                                                                                                                         List<String> references,
                                                                                                                                                                         List<String> siteIds)

addSearchQuery

protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> addSearchQuery(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders,
                                                                                                                                                                    String searchTerms,
                                                                                                                                                                    List<String> references,
                                                                                                                                                                    List<String> siteIds)

addSearchTerms

protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> addSearchTerms(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders,
                                                                                                                                                                    String searchTerms)

addSearchReferences

protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> addSearchReferences(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders,
                                                                                                                                                                         List<String> references)

addSearchSiteIds

protected abstract org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> addSearchSiteIds(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders,
                                                                                                                                                                               List<String> siteIds)

addSearchResultFields

protected org.elasticsearch.action.search.SearchRequestBuilder addSearchResultFields(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder)

addSearchPagination

protected org.elasticsearch.action.search.SearchRequestBuilder addSearchPagination(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder,
                                                                                   int start,
                                                                                   int end)

addSearchFacetting

protected org.elasticsearch.action.search.SearchRequestBuilder addSearchFacetting(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder)

completeSearchRequestBuilders

protected abstract org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> completeSearchRequestBuilders(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders,
                                                                                                                                                                                            String searchTerms,
                                                                                                                                                                                            List<String> references,
                                                                                                                                                                                            List<String> siteIds)

searchSuggestions

public String[] searchSuggestions(String searchString,
                                  String currentSite,
                                  boolean allMySites)

Specified by:

searchSuggestions in interface ElasticSearchIndexBuilder

prepareSearchSuggestionsRequest

protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> prepareSearchSuggestionsRequest(String searchString,
                                                                                                                                                                                     String currentSite,
                                                                                                                                                                                     boolean allMySites)

completeSearchSuggestionsRequestBuilders

protected abstract org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> completeSearchSuggestionsRequestBuilders(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders,
                                                                                                                                                                                                       String searchString,
                                                                                                                                                                                                       String currentSite,
                                                                                                                                                                                                       boolean allMySites)

newSearchSuggestionsRequestAndQueryBuilders

protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> newSearchSuggestionsRequestAndQueryBuilders(String searchString,
                                                                                                                                                                                                 String currentSite,
                                                                                                                                                                                                 boolean allMySites)

addSearchSuggestionsCoreParams

protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> addSearchSuggestionsCoreParams(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders,
                                                                                                                                                                                    String searchString,
                                                                                                                                                                                    String currentSite,
                                                                                                                                                                                    boolean allMySites)

addSearchSuggestionsQuery

protected org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> addSearchSuggestionsQuery(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders,
                                                                                                                                                                               String searchString,
                                                                                                                                                                               String currentSite,
                                                                                                                                                                               boolean allMySites)

addSearchSuggestionsTerms

protected abstract org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> addSearchSuggestionsTerms(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders,
                                                                                                                                                                                        String searchString)

addSearchSuggestionsSites

protected abstract org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> addSearchSuggestionsSites(org.elasticsearch.common.lang3.tuple.Pair<org.elasticsearch.action.search.SearchRequestBuilder,org.elasticsearch.index.query.QueryBuilder> builders,
                                                                                                                                                                                        String currentSite,
                                                                                                                                                                                        boolean allMySites)

addSearchSuggestionResultFields

protected org.elasticsearch.action.search.SearchRequestBuilder addSearchSuggestionResultFields(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder)

addSearchSuggestionsPagination

protected org.elasticsearch.action.search.SearchRequestBuilder addSearchSuggestionsPagination(org.elasticsearch.action.search.SearchRequestBuilder searchRequestBuilder)

getStatus

public StringBuilder getStatus(StringBuilder into)

Specified by:

getStatus in interface ElasticSearchIndexBuilder

roundTwoDecimals

protected double roundTwoDecimals(double d)

getNDocs

public int getNDocs()

Specified by:

getNDocs in interface ElasticSearchIndexBuilder

getSearchStatus

public SearchStatus getSearchStatus()

Specified by:

getSearchStatus in interface ElasticSearchIndexBuilder

newEntityContentProducer

public EntityContentProducer newEntityContentProducer(String ref)

Find a EntityContentProducer capable of handling the given entity reference, or null if no such producer has been registered.

Specified by:

newEntityContentProducer in interface SearchIndexBuilder

Parameters:

ref - the entity reference

newEntityContentProducer

public EntityContentProducer newEntityContentProducer(Event event)

Find a EntityContentProducer capable of handling the given Event, or null if no such producer has been registered.

Specified by:

newEntityContentProducer in interface SearchIndexBuilder

Parameters:

event -

Returns:

matchEntityContentProducer

protected Optional<EntityContentProducer> matchEntityContentProducer(Predicate<EntityContentProducer> matcher)

getContentProducers

public List<EntityContentProducer> getContentProducers()

get all the producers registered, as a clone to avoid concurrent modification exceptions

Specified by:

getContentProducers in interface SearchIndexBuilder

Returns:

registerEntityContentProducer

public void registerEntityContentProducer(EntityContentProducer ecp)

register an entity content producer to provide content to the search engine

Specified by:

registerEntityContentProducer in interface SearchIndexBuilder

getContentFunctions

public Set<String> getContentFunctions()

Specified by:

getContentFunctions in interface ElasticSearchIndexBuilder

enableAzgSecurityAdvisor

protected void enableAzgSecurityAdvisor()

Establish a security advisor to allow the "embedded" work to occur with no need for additional security permissions.

disableAzgSecurityAdvisor

protected void disableAzgSecurityAdvisor()

Disable the security advisor.

getFieldFromSearchHit

public String getFieldFromSearchHit(String field,
                                    org.elasticsearch.search.SearchHit hit)

loads the field from the SearchHit. Loads from field not from source since we aren't storing the source.

Specified by:

getFieldFromSearchHit in interface ElasticSearchIndexBuilder

Parameters:

field -

hit -

Returns:

pairOf

protected <L,R> org.elasticsearch.common.lang3.tuple.Pair<L,R> pairOf(L left,
                                                                      R right)

getAllSearchItems

public List<SearchBuilderItem> getAllSearchItems()

Specified by:

getAllSearchItems in interface SearchIndexBuilder

setIndexedDocumentType

public void setIndexedDocumentType(String indexedDocumentType)

setTestMode

public void setTestMode(boolean testMode)

setRebuildIndexOnStartup

public void setRebuildIndexOnStartup(boolean rebuildIndexOnStartup)

getUseFacetting

public boolean getUseFacetting()

Specified by:

getUseFacetting in interface ElasticSearchIndexBuilder

setUseFacetting

public void setUseFacetting(boolean useFacetting)

setFacetName

public void setFacetName(String facetName)

setMaxNumberOfSuggestions

public void setMaxNumberOfSuggestions(int maxNumberOfSuggestions)

setUseSuggestions

public void setUseSuggestions(boolean useSuggestions)

setSuggestionResultFieldNames

public void setSuggestionResultFieldNames(String[] suggestionResultFieldNames)

setSuggestionMatchingFieldName

public void setSuggestionMatchingFieldName(String suggestionMatchingFieldName)

setSearchResultFieldNames

public void setSearchResultFieldNames(String[] searchResultFieldNames)

setFilter

public void setFilter(SearchItemFilter filter)

getFilter

public SearchItemFilter getFilter()

Specified by:

getFilter in interface ElasticSearchIndexBuilder

getFacetName

public String getFacetName()

Specified by:

getFacetName in interface ElasticSearchIndexBuilder

setFacetTermSize

public void setFacetTermSize(int facetTermSize)

getName

public String getName()

Specified by:

getName in interface SearchIndexBuilder

setName

public void setName(String name)

setIndexName

public void setIndexName(String indexName)

setDefaultIndexSettingsResource

public void setDefaultIndexSettingsResource(String defaultIndexSettingsResource)

setMapping

public void setMapping(String mapping)

setIndexSettings

public void setIndexSettings(String indexSettings)

setDefaultMappingResource

public void setDefaultMappingResource(String defaultMappingResource)

setDelay

public void setDelay(int delay)

setPeriod

public void setPeriod(int period)

setContentIndexBatchSize

public void setContentIndexBatchSize(int contentIndexBatchSize)

setBulkRequestSize

public void setBulkRequestSize(int bulkRequestSize)

setSecurityService

public void setSecurityService(SecurityService securityService)

setServerConfigurationService

public void setServerConfigurationService(ServerConfigurationService serverConfigurationService)

setEventTrackingService

public void setEventTrackingService(EventTrackingService eventTrackingService)

setTriggerFunctions

public void setTriggerFunctions(Collection<String> triggerFunctions)

getTriggerFunctions

public Set<String> getTriggerFunctions()

Specified by:

getTriggerFunctions in interface ElasticSearchIndexBuilder

getGlobalMasterSearchItems

public List<SearchBuilderItem> getGlobalMasterSearchItems()

Specified by:

getGlobalMasterSearchItems in interface SearchIndexBuilder

getLog

protected abstract org.slf4j.Logger getLog()