Package org.craftercms.deployer.impl.processors.opensearch

Class OpenSearchIndexingProcessor

java.lang.Object

org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

org.craftercms.deployer.impl.processors.AbstractMainDeploymentProcessor

org.craftercms.deployer.impl.processors.AbstractSearchIndexingProcessor

org.craftercms.deployer.impl.processors.opensearch.OpenSearchIndexingProcessor

All Implemented Interfaces:

DeploymentProcessor, InitializableByConfigBean, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class OpenSearchIndexingProcessor
extends AbstractSearchIndexingProcessor

Implementation of AbstractSearchIndexingProcessor for OpenSearch

Since:

3.1.0

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected String	includedDescriptorsFieldName
protected String	inheritsFromFieldName
protected String	localIdFieldName
protected String	metadataPathFieldName
protected org.craftercms.search.opensearch.OpenSearchAdminService	searchAdminService
protected org.craftercms.search.opensearch.OpenSearchService	searchService

Fields inherited from class org.craftercms.deployer.impl.processors.AbstractSearchIndexingProcessor

batchIndexers, cacheService, componentPathPattern, contentStoreService, contextFactory, CREATE_INDEX_IF_MISSING_CONFIG_KEY, createIndexIfMissing, DEFAULT_COMPONENT_PATH_PATTERN, DEFAULT_DESCRIPTOR_PATH_PATTERN, DEFAULT_ITEMS_THAT_INCLUDE_COMPONENT_QUERY_ROWS, descriptorPathPattern, IGNORE_INDEX_ID_CONFIG_KEY, INDEX_ID_CONFIG_KEY, indexId, indexIdFormat, itemsThatIncludeComponentQueryRows, REINDEX_ITEMS_ON_COMPONENT_UPDATES, reindexItemsOnComponentUpdates, xmlFlatteningEnabled

Fields inherited from class org.craftercms.deployer.impl.processors.AbstractMainDeploymentProcessor

FAIL_DEPLOYMENT_CONFIG_KEY, failDeploymentOnFailure

Fields inherited from class org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

alwaysRun, env, excludeFiles, includeFiles, JUMPING_TO_PARAM_NAME, jumpTo, label, name, siteName, targetId

Constructor Summary

Constructors

Constructor	Description
OpenSearchIndexingProcessor(org.craftercms.search.opensearch.OpenSearchService searchService, org.craftercms.search.opensearch.OpenSearchAdminService searchAdminService)

Method Summary

Modifier and Type	Method	Description
protected void	doCommit(String indexId)
protected void	doCreateIndexIfMissing()
protected List<String>	getItemsThatIncludeComponent(String indexId, String componentPath)
protected List<String>	getItemsThatInheritDescriptor(String indexId, String descriptorPath)

Methods inherited from class org.craftercms.deployer.impl.processors.AbstractSearchIndexingProcessor

addAffectedItemsToUpdatedFiles, addItemsThatIncludeComponentToUpdatedFiles, addItemsThatInheritFromDescriptorToUpdatedFiles, doDestroy, doInit, doMainProcess, expandChangeSet, isBeingUpdatedOrDeleted, isComponent, isDescriptor, setBatchIndexer, setBatchIndexers, setCacheService, setComponentPathRegex, setContentStoreService, setContextFactory, setDescriptorPathRegex, setIndexIdFormat, setItemsThatIncludeComponentQueryRows, setXmlFlatteningEnabled, supportsMode

Methods inherited from class org.craftercms.deployer.impl.processors.AbstractMainDeploymentProcessor

doExecute, failDeploymentOnProcessorFailure, init, shouldExecute

Methods inherited from class org.craftercms.deployer.impl.processors.AbstractDeploymentProcessor

destroy, execute, getDeploymentParam, getFilteredChangeSet, isJumpToActive, isPostDeployment, setBeanName, setEnv, setSiteName, setTargetId, shouldIncludeFile, startJumpTo

Methods inherited from class java.lang.Object

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

Field Details

localIdFieldName

protected String localIdFieldName

inheritsFromFieldName

protected String inheritsFromFieldName

includedDescriptorsFieldName

protected String includedDescriptorsFieldName

metadataPathFieldName

protected String metadataPathFieldName

searchService

protected org.craftercms.search.opensearch.OpenSearchService searchService

searchAdminService

protected org.craftercms.search.opensearch.OpenSearchAdminService searchAdminService

Constructor Details

OpenSearchIndexingProcessor

@ConstructorProperties({"searchService","searchAdminService"})
public OpenSearchIndexingProcessor(org.craftercms.search.opensearch.OpenSearchService searchService,
 org.craftercms.search.opensearch.OpenSearchAdminService searchAdminService)

Method Details

doCreateIndexIfMissing

protected void doCreateIndexIfMissing()

Specified by:

doCreateIndexIfMissing in class AbstractSearchIndexingProcessor

doCommit

protected void doCommit(String indexId)

Specified by:

doCommit in class AbstractSearchIndexingProcessor

getItemsThatInheritDescriptor

protected List<String> getItemsThatInheritDescriptor(String indexId,
 String descriptorPath)

Specified by:

getItemsThatInheritDescriptor in class AbstractSearchIndexingProcessor

getItemsThatIncludeComponent

protected List<String> getItemsThatIncludeComponent(String indexId,
 String componentPath)

Specified by:

getItemsThatIncludeComponent in class AbstractSearchIndexingProcessor