Package de.hybris.platform.searchprovidercssearchservices.spi.service.impl

Class CSSearchSnSearchProvider

java.lang.Object

de.hybris.platform.searchservices.spi.service.impl.AbstractSnSearchProvider<CSSearchSnSearchProviderConfiguration>

de.hybris.platform.searchprovidercssearchservices.spi.service.impl.CSSearchSnSearchProvider

All Implemented Interfaces:

SnSearchProvider<CSSearchSnSearchProviderConfiguration>, org.springframework.beans.factory.InitializingBean

public class CSSearchSnSearchProvider
extends AbstractSnSearchProvider<CSSearchSnSearchProviderConfiguration>
implements org.springframework.beans.factory.InitializingBean

Implementation of SnSearchProvider for the search core service.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CSSearchSnSearchProvider.ConverterContext
protected static class	CSSearchSnSearchProvider.ListCustomMapper
protected static class	CSSearchSnSearchProvider.LocaleConverter
protected static class	CSSearchSnSearchProvider.MapCustomMapper

Constructor Summary

Constructors

Constructor	Description
CSSearchSnSearchProvider()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected java.util.Map<java.util.Locale,java.lang.String>	buildLocalizedName(CSSearchSnSearchProvider.ConverterContext converterContext, java.util.Map<java.util.Locale,java.lang.String> source)
protected java.lang.String	buildQualifierHeader(java.util.Map.Entry<java.lang.String,java.util.List<SnQualifier>> entry)
protected java.lang.String	buildRequestExceptionMessage(java.lang.String message, com.hybris.charon.exp.HttpException exception)
void	commit(SnContext context, java.lang.String indexId)	Makes sure that documents are stored on the index storage and are visible for queries.
protected QualifierDTO	convertCurrencyQualifier(CSSearchSnSearchProvider.ConverterContext converterContext, SnCurrency source)
protected QualifierTypeDTO	convertCurrencyQualifierType(CSSearchSnSearchProvider.ConverterContext converterContext, SnIndexConfiguration indexConfiguration)
protected DocumentBatchOperationRequestDTO	convertDocumenBatchOperationRequest(SnDocumentBatchOperationRequest source)
protected SnDocumentBatchOperationResponse	convertDocumenBatchOperationResponse(DocumentBatchOperationResponseDTO source)
protected DocumentBatchRequestDTO	convertDocumenBatchRequest(SnDocumentBatchRequest source, java.lang.String indexerOperationId)
protected SnDocumentBatchResponse	convertDocumenBatchResponse(DocumentBatchResponseDTO source)
protected SnDocumentOperationStatus	convertDocumenOperationStatus(java.lang.Integer statusCode)
protected java.lang.String	convertDocumenOperationType(SnDocumentOperationType source)
protected DocumentDTO	convertDocument(SnDocument source)
protected FieldDTO	convertField(CSSearchSnSearchProvider.ConverterContext converterContext, SnField source)
protected FieldTypeDTO	convertFieldType(SnFieldType source)
protected SnIndex	convertIndex(IndexDTO source)
protected IndexConfigurationDTO	convertIndexConfiguration(CSSearchSnSearchProvider.ConverterContext converterContext, SnIndexConfiguration source)
protected SnIndexerOperation	convertIndexerOperation(IndexerOperationDTO source)
protected SnIndexerOperationStatus	convertIndexerOperationStatus(IndexerOperationStatusDTO source)
protected IndexerOperationStatusDTO	convertIndexerOperationStatus(SnIndexerOperationStatus source)
protected SnIndexerOperationType	convertIndexerOperationType(IndexerOperationTypeDTO source)
protected IndexerOperationTypeDTO	convertIndexerOperationType(SnIndexerOperationType source)
protected IndexTypeDTO	convertIndexType(CSSearchSnSearchProvider.ConverterContext converterContext, SnIndexType source)
protected LanguageDTO	convertLanguage(CSSearchSnSearchProvider.ConverterContext converterContext, SnLanguage source)
protected SearchQueryDTO	convertSearchQuery(SnSearchQuery source)
protected SnSearchResult	convertSearchResult(SearchResultDTO source)
protected SuggestQueryDTO	convertSuggestQuery(SnSuggestQuery source)
protected SnSuggestResult	convertSuggestResult(SuggestResultDTO source)
protected SynonymDictionaryDTO	convertSynonymDictionary(CSSearchSnSearchProvider.ConverterContext converterContext, SnSynonymDictionary source)
protected SynonymEntryDTO	convertSynonymEntry(SnSynonymEntry source)
protected CSSearchClient	createClient(SnIndexConfiguration indexConfiguration)
SnIndex	createIndex(SnContext context)	Creates an index.
SnIndexerOperation	createIndexerOperation(SnContext context, SnIndexerOperationType indexerOperationType, int totalItems)	Creates a new indexer operation.
protected java.lang.String	createLanguageHeader(SnContext context)
protected java.lang.String	createQualifierHeader(SnContext context)
void	deleteIndex(SnContext context, java.lang.String indexId)	Deletes an index (if it exists).
SnDocumentBatchResponse	executeDocumentBatch(SnContext context, java.lang.String indexId, SnDocumentBatchRequest documentBatchRequest, java.lang.String indexerOperationId)	Executes a document batch.
void	exportConfiguration(SnExportConfiguration exportConfiguration, java.util.List<java.util.Locale> locales)	Exports the configuration to the search provider.
protected void	exportIndexConfiguration(CSSearchSnSearchProvider.ConverterContext converterContext, SnIndexConfiguration indexConfiguration, CSSearchClient client)
protected void	exportIndexTypes(CSSearchSnSearchProvider.ConverterContext converterContext, java.util.List<SnIndexType> indexTypes, CSSearchClient client)
protected void	exportSynonymDictionaries(CSSearchSnSearchProvider.ConverterContext converterContext, java.util.List<SnSynonymDictionary> synonymDictionaries, CSSearchClient client)
protected boolean	filterQualifierHeader(java.util.Map.Entry<java.lang.String,java.util.List<SnQualifier>> entry)
ApiRegistryClientService	getApiRegistryClientService()
ClientFactory	getClientFactory()
CommonI18NService	getCommonI18NService()
DestinationService<ConsumedDestinationModel>	getDestinationService()
protected ma.glasnost.orika.MapperFacade	getMapperFacade()
protected void	handleRequestException(java.lang.String message, java.lang.Runnable handler)
protected <T> T	handleRequestException(java.lang.String message, java.util.function.Supplier<T> handler)
protected void	registerMappings(ma.glasnost.orika.MapperFactory mapperFactory)
SnSearchResult	search(SnContext context, java.lang.String indexId, SnSearchQuery searchQuery)	Executes a search query on a specific index.
void	setApiRegistryClientService(ApiRegistryClientService apiRegistryClientService)
void	setClientFactory(ClientFactory clientFactory)
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setDestinationService(DestinationService<ConsumedDestinationModel> destinationService)
SnSuggestResult	suggest(SnContext context, java.lang.String indexId, SnSuggestQuery suggestQuery)	Executes a suggest query on a specific index.
SnIndexerOperation	updateIndexerOperationStatus(SnContext context, java.lang.String indexerOperationId, SnIndexerOperationStatus status, java.lang.String errorMessage)	Updates the status of an indexer operation.

Methods inherited from class de.hybris.platform.searchservices.spi.service.impl.AbstractSnSearchProvider

createIndex, exportConfiguration, getSearchProviderConfiguration, getSearchProviderConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

CSSearchSnSearchProvider

public CSSearchSnSearchProvider()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

registerMappings

protected void registerMappings(ma.glasnost.orika.MapperFactory mapperFactory)

getMapperFacade

protected ma.glasnost.orika.MapperFacade getMapperFacade()

exportConfiguration

public void exportConfiguration(SnExportConfiguration exportConfiguration,
                                java.util.List<java.util.Locale> locales)
                         throws SnException

Description copied from interface: SnSearchProvider

Exports the configuration to the search provider.

Specified by:

exportConfiguration in interface SnSearchProvider<CSSearchSnSearchProviderConfiguration>

Parameters:

exportConfiguration - - the export configuration

Throws:

SnException - if an error occurs

exportSynonymDictionaries

protected void exportSynonymDictionaries(CSSearchSnSearchProvider.ConverterContext converterContext,
                                         java.util.List<SnSynonymDictionary> synonymDictionaries,
                                         CSSearchClient client)
                                  throws SnException

Throws:

SnException

convertSynonymDictionary

protected SynonymDictionaryDTO convertSynonymDictionary(CSSearchSnSearchProvider.ConverterContext converterContext,
                                                        SnSynonymDictionary source)

convertSynonymEntry

protected SynonymEntryDTO convertSynonymEntry(SnSynonymEntry source)

exportIndexConfiguration

protected void exportIndexConfiguration(CSSearchSnSearchProvider.ConverterContext converterContext,
                                        SnIndexConfiguration indexConfiguration,
                                        CSSearchClient client)
                                 throws SnException

Throws:

SnException

convertIndexConfiguration

protected IndexConfigurationDTO convertIndexConfiguration(CSSearchSnSearchProvider.ConverterContext converterContext,
                                                          SnIndexConfiguration source)

convertLanguage

protected LanguageDTO convertLanguage(CSSearchSnSearchProvider.ConverterContext converterContext,
                                      SnLanguage source)

convertCurrencyQualifierType

protected QualifierTypeDTO convertCurrencyQualifierType(CSSearchSnSearchProvider.ConverterContext converterContext,
                                                        SnIndexConfiguration indexConfiguration)

convertCurrencyQualifier

protected QualifierDTO convertCurrencyQualifier(CSSearchSnSearchProvider.ConverterContext converterContext,
                                                SnCurrency source)

exportIndexTypes

protected void exportIndexTypes(CSSearchSnSearchProvider.ConverterContext converterContext,
                                java.util.List<SnIndexType> indexTypes,
                                CSSearchClient client)
                         throws SnException

Throws:

SnException

convertIndexType

protected IndexTypeDTO convertIndexType(CSSearchSnSearchProvider.ConverterContext converterContext,
                                        SnIndexType source)

convertField

protected FieldDTO convertField(CSSearchSnSearchProvider.ConverterContext converterContext,
                                SnField source)

convertFieldType

protected FieldTypeDTO convertFieldType(SnFieldType source)

createIndex

public SnIndex createIndex(SnContext context)
                    throws SnException

Description copied from interface: SnSearchProvider

Creates an index.

Specified by:

createIndex in interface SnSearchProvider<CSSearchSnSearchProviderConfiguration>

Parameters:

context - - the context

Throws:

SnException - if an error occurs

convertIndex

protected SnIndex convertIndex(IndexDTO source)

deleteIndex

public void deleteIndex(SnContext context,
                        java.lang.String indexId)
                 throws SnException

Description copied from interface: SnSearchProvider

Deletes an index (if it exists).

Specified by:

deleteIndex in interface SnSearchProvider<CSSearchSnSearchProviderConfiguration>

Parameters:

context - - the context

indexId - - the index id

Throws:

SnException - if an error occurs

createIndexerOperation

public SnIndexerOperation createIndexerOperation(SnContext context,
                                                 SnIndexerOperationType indexerOperationType,
                                                 int totalItems)
                                          throws SnException

Description copied from interface: SnSearchProvider

Creates a new indexer operation.

Specified by:

createIndexerOperation in interface SnSearchProvider<CSSearchSnSearchProviderConfiguration>

Parameters:

context - - the context

Throws:

SnException - if an error occurs

updateIndexerOperationStatus

public SnIndexerOperation updateIndexerOperationStatus(SnContext context,
                                                       java.lang.String indexerOperationId,
                                                       SnIndexerOperationStatus status,
                                                       java.lang.String errorMessage)
                                                throws SnException

Description copied from interface: SnSearchProvider

Updates the status of an indexer operation.

Specified by:

updateIndexerOperationStatus in interface SnSearchProvider<CSSearchSnSearchProviderConfiguration>

Parameters:

context - - the context

status - - the status

errorMessage - - the errorMessage

Throws:

SnException - if an error occurs

convertIndexerOperationType

protected IndexerOperationTypeDTO convertIndexerOperationType(SnIndexerOperationType source)

convertIndexerOperationType

protected SnIndexerOperationType convertIndexerOperationType(IndexerOperationTypeDTO source)

convertIndexerOperationStatus

protected IndexerOperationStatusDTO convertIndexerOperationStatus(SnIndexerOperationStatus source)

convertIndexerOperationStatus

protected SnIndexerOperationStatus convertIndexerOperationStatus(IndexerOperationStatusDTO source)

convertIndexerOperation

protected SnIndexerOperation convertIndexerOperation(IndexerOperationDTO source)

executeDocumentBatch

public SnDocumentBatchResponse executeDocumentBatch(SnContext context,
                                                    java.lang.String indexId,
                                                    SnDocumentBatchRequest documentBatchRequest,
                                                    java.lang.String indexerOperationId)
                                             throws SnException

Description copied from interface: SnSearchProvider

Executes a document batch.

Specified by:

executeDocumentBatch in interface SnSearchProvider<CSSearchSnSearchProviderConfiguration>

Parameters:

context - - the context

indexId - - the index id

documentBatchRequest - - the document batch request

indexerOperationId - - the indexer operation id

Returns:

the document batch response

Throws:

SnException - if an error occurs

convertDocument

protected DocumentDTO convertDocument(SnDocument source)

convertDocumenBatchRequest

protected DocumentBatchRequestDTO convertDocumenBatchRequest(SnDocumentBatchRequest source,
                                                             java.lang.String indexerOperationId)

convertDocumenBatchOperationRequest

protected DocumentBatchOperationRequestDTO convertDocumenBatchOperationRequest(SnDocumentBatchOperationRequest source)

convertDocumenOperationType

protected java.lang.String convertDocumenOperationType(SnDocumentOperationType source)

convertDocumenBatchResponse

protected SnDocumentBatchResponse convertDocumenBatchResponse(DocumentBatchResponseDTO source)

convertDocumenBatchOperationResponse

protected SnDocumentBatchOperationResponse convertDocumenBatchOperationResponse(DocumentBatchOperationResponseDTO source)

convertDocumenOperationStatus

protected SnDocumentOperationStatus convertDocumenOperationStatus(java.lang.Integer statusCode)

commit

public void commit(SnContext context,
                   java.lang.String indexId)
            throws SnException

Description copied from interface: SnSearchProvider

Makes sure that documents are stored on the index storage and are visible for queries.

Specified by:

commit in interface SnSearchProvider<CSSearchSnSearchProviderConfiguration>

Parameters:

context - - the context

indexId - - the index id

Throws:

SnException - if an error occurs

search

public SnSearchResult search(SnContext context,
                             java.lang.String indexId,
                             SnSearchQuery searchQuery)
                      throws SnException

Description copied from interface: SnSearchProvider

Executes a search query on a specific index.

Specified by:

search in interface SnSearchProvider<CSSearchSnSearchProviderConfiguration>

Parameters:

context - - the context

indexId - - the index id

searchQuery - - the search query

Returns:

the search result

Throws:

SnException - if an error occurs

convertSearchQuery

protected SearchQueryDTO convertSearchQuery(SnSearchQuery source)

convertSearchResult

protected SnSearchResult convertSearchResult(SearchResultDTO source)

suggest

public SnSuggestResult suggest(SnContext context,
                               java.lang.String indexId,
                               SnSuggestQuery suggestQuery)
                        throws SnException

Description copied from interface: SnSearchProvider

Executes a suggest query on a specific index.

Specified by:

suggest in interface SnSearchProvider<CSSearchSnSearchProviderConfiguration>

Parameters:

context - - the context

indexId - - the index id

suggestQuery - - the suggest query

Returns:

the suggest result

Throws:

SnException - if an error occurs

convertSuggestQuery

protected SuggestQueryDTO convertSuggestQuery(SnSuggestQuery source)

convertSuggestResult

protected SnSuggestResult convertSuggestResult(SuggestResultDTO source)

createLanguageHeader

protected java.lang.String createLanguageHeader(SnContext context)

createQualifierHeader

protected java.lang.String createQualifierHeader(SnContext context)

filterQualifierHeader

protected boolean filterQualifierHeader(java.util.Map.Entry<java.lang.String,java.util.List<SnQualifier>> entry)

buildQualifierHeader

protected java.lang.String buildQualifierHeader(java.util.Map.Entry<java.lang.String,java.util.List<SnQualifier>> entry)

createClient

protected CSSearchClient createClient(SnIndexConfiguration indexConfiguration)
                               throws SnException

Throws:

SnException

buildLocalizedName

protected java.util.Map<java.util.Locale,java.lang.String> buildLocalizedName(CSSearchSnSearchProvider.ConverterContext converterContext,
                                                                                    java.util.Map<java.util.Locale,java.lang.String> source)

handleRequestException

protected void handleRequestException(java.lang.String message,
                                      java.lang.Runnable handler)
                               throws SnException

Throws:

SnException

handleRequestException

protected <T> T handleRequestException(java.lang.String message,
                                       java.util.function.Supplier<T> handler)
                                throws SnException

Throws:

SnException

buildRequestExceptionMessage

protected java.lang.String buildRequestExceptionMessage(java.lang.String message,
                                                        com.hybris.charon.exp.HttpException exception)

getDestinationService

public DestinationService<ConsumedDestinationModel> getDestinationService()

setDestinationService

public void setDestinationService(DestinationService<ConsumedDestinationModel> destinationService)

getApiRegistryClientService

public ApiRegistryClientService getApiRegistryClientService()

setApiRegistryClientService

public void setApiRegistryClientService(ApiRegistryClientService apiRegistryClientService)

getCommonI18NService

public CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getClientFactory

public ClientFactory getClientFactory()

setClientFactory

public void setClientFactory(ClientFactory clientFactory)