org.craftercms.search.service.impl.v2

Class SolrRestClientSearchService

java.lang.Object

org.craftercms.search.service.utils.AccessTokenAware

org.craftercms.search.service.impl.v2.SolrRestClientSearchService

All Implemented Interfaces:

QueryFactory<SolrQuery>, ResourceAwareSearchService<SolrQuery>, SearchService<SolrQuery>

public class SolrRestClientSearchService
extends AccessTokenAware
implements ResourceAwareSearchService<SolrQuery>

Solr based REST client implementation of SearchService for Search REST API v2.

Author:

Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field and Description
protected Charset	charset
static Charset	DEFAULT_CHARSET
protected static String[]	NON_ADDITIONAL_FIELD_NAMES
protected org.springframework.web.client.RestTemplate	restTemplate
protected String	serverUrl

Fields inherited from class org.craftercms.search.service.utils.AccessTokenAware

accessTokenParameter, accessTokenValue

Constructor Summary

Constructors

Constructor and Description
SolrRestClientSearchService()

Method Summary

Modifier and Type	Method and Description
void	commit()
void	commit(String indexId)
protected String	createBaseUrl(String serviceUrl)
protected String	createBaseUrl(String serviceUrl, String indexId)
SolrQuery	createQuery()
SolrQuery	createQuery(Map<String,String[]> params)
void	delete(String site, String id)
void	delete(String indexId, String site, String id)
Map<String,Object>	search(SolrQuery query)
Map<String,Object>	search(String indexId, SolrQuery query)
void	setCharset(String charset)
void	setRestTemplate(org.springframework.web.client.RestTemplate restTemplate)
void	setServerUrl(String serverUrl)
void	update(String site, String id, String xml, boolean ignoreRootInFieldNames)
void	update(String indexId, String site, String id, String xml, boolean ignoreRootInFieldNames)
void	updateContent(String site, String id, org.craftercms.core.service.Content content)
void	updateContent(String site, String id, org.craftercms.core.service.Content content, Map<String,List<String>> additionalFields)
void	updateContent(String site, String id, File file)
void	updateContent(String site, String id, File file, Map<String,List<String>> additionalFields)
void	updateContent(String indexId, String site, String id, org.craftercms.core.service.Content content)
void	updateContent(String indexId, String site, String id, org.craftercms.core.service.Content content, Map<String,List<String>> additionalFields)
void	updateContent(String indexId, String site, String id, File file)
void	updateContent(String indexId, String site, String id, File file, Map<String,List<String>> additionalFields)
void	updateContent(String indexId, String site, String id, org.springframework.core.io.Resource resource, Map<String,List<String>> additionalFields) Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

Methods inherited from class org.craftercms.search.service.utils.AccessTokenAware

addTokenIfNeeded, setAccessTokenParameter, setAccessTokenValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.craftercms.search.service.ResourceAwareSearchService

updateContent, updateContent, updateContent

Field Detail

NON_ADDITIONAL_FIELD_NAMES

protected static final String[] NON_ADDITIONAL_FIELD_NAMES

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET

serverUrl

protected String serverUrl

restTemplate

protected org.springframework.web.client.RestTemplate restTemplate

charset

protected Charset charset

Constructor Detail

SolrRestClientSearchService

public SolrRestClientSearchService()

Method Detail

setServerUrl

public void setServerUrl(String serverUrl)

setRestTemplate

public void setRestTemplate(org.springframework.web.client.RestTemplate restTemplate)

setCharset

public void setCharset(String charset)

createQuery

public SolrQuery createQuery()

Specified by:

createQuery in interface QueryFactory<SolrQuery>

createQuery

public SolrQuery createQuery(Map<String,String[]> params)

Specified by:

createQuery in interface QueryFactory<SolrQuery>

search

public Map<String,Object> search(SolrQuery query)
                          throws SearchException

Specified by:

search in interface SearchService<SolrQuery>

Throws:

SearchException

search

public Map<String,Object> search(String indexId,
                                 SolrQuery query)
                          throws SearchException

Specified by:

search in interface SearchService<SolrQuery>

Throws:

SearchException

update

public void update(String site,
                   String id,
                   String xml,
                   boolean ignoreRootInFieldNames)
            throws SearchException

Specified by:

update in interface SearchService<SolrQuery>

Throws:

SearchException

update

public void update(String indexId,
                   String site,
                   String id,
                   String xml,
                   boolean ignoreRootInFieldNames)
            throws SearchException

Specified by:

update in interface SearchService<SolrQuery>

Throws:

SearchException

delete

public void delete(String site,
                   String id)
            throws SearchException

Specified by:

delete in interface SearchService<SolrQuery>

Throws:

SearchException

delete

public void delete(String indexId,
                   String site,
                   String id)
            throws SearchException

Specified by:

delete in interface SearchService<SolrQuery>

Throws:

SearchException

commit

public void commit()
            throws SearchException

Specified by:

commit in interface SearchService<SolrQuery>

Throws:

SearchException

commit

public void commit(String indexId)
            throws SearchException

Specified by:

commit in interface SearchService<SolrQuery>

Throws:

SearchException

updateContent

public void updateContent(String site,
                          String id,
                          File file)
                   throws SearchException

Specified by:

updateContent in interface SearchService<SolrQuery>

Throws:

SearchException

updateContent

public void updateContent(String indexId,
                          String site,
                          String id,
                          File file)
                   throws SearchException

Specified by:

updateContent in interface SearchService<SolrQuery>

Throws:

SearchException

updateContent

public void updateContent(String site,
                          String id,
                          File file,
                          Map<String,List<String>> additionalFields)
                   throws SearchException

Specified by:

updateContent in interface SearchService<SolrQuery>

Throws:

SearchException

updateContent

public void updateContent(String indexId,
                          String site,
                          String id,
                          File file,
                          Map<String,List<String>> additionalFields)
                   throws SearchException

Specified by:

updateContent in interface SearchService<SolrQuery>

Throws:

SearchException

updateContent

public void updateContent(String site,
                          String id,
                          org.craftercms.core.service.Content content)
                   throws SearchException

Specified by:

updateContent in interface SearchService<SolrQuery>

Throws:

SearchException

updateContent

public void updateContent(String indexId,
                          String site,
                          String id,
                          org.craftercms.core.service.Content content)
                   throws SearchException

Specified by:

updateContent in interface SearchService<SolrQuery>

Throws:

SearchException

updateContent

public void updateContent(String site,
                          String id,
                          org.craftercms.core.service.Content content,
                          Map<String,List<String>> additionalFields)
                   throws SearchException

Specified by:

updateContent in interface SearchService<SolrQuery>

Throws:

SearchException

updateContent

public void updateContent(String indexId,
                          String site,
                          String id,
                          org.craftercms.core.service.Content content,
                          Map<String,List<String>> additionalFields)
                   throws SearchException

Specified by:

updateContent in interface SearchService<SolrQuery>

Throws:

SearchException

updateContent

public void updateContent(String indexId,
                          String site,
                          String id,
                          org.springframework.core.io.Resource resource,
                          Map<String,List<String>> additionalFields)
                   throws SearchException

Description copied from interface: ResourceAwareSearchService

Updates the search engine's index data of a binary or structured document (PDF, Word, Office).

Specified by:

updateContent in interface ResourceAwareSearchService<SolrQuery>

Parameters:

indexId - the index ID (core in Solr terminology). Use null for default index.

site - the Crafter site name the content belongs to

id - the id of the XML document, within the site

resource - the file content to update in the index

additionalFields - additional metadata fields to be indexed (shouldn't have the name site, id or document)

Throws:

SearchException

createBaseUrl

protected String createBaseUrl(String serviceUrl)

createBaseUrl

protected String createBaseUrl(String serviceUrl,
                               String indexId)