com.tsgrp.opencontent.core.external.searchservice

Interface IExternalSearchService

All Known Implementing Classes:

ElasticsearchDynamoExternalSearchService, ElasticsearchExternalSearchService, SolrDynamoExternalSearchService, SolrExternalSearchService, SolrHBaseExternalSearchService

public interface IExternalSearchService

Default implementation of the an external search service. This is meant for environments that do no have a built in search service like Dynamo and HBase. This is meant for interacting with those search services but NOT for querying. Querying should be contained in IQuery

Method Summary

Modifier and Type	Method and Description
void	clearSearchService() Clears the indexed contents on the search service Warning: this will clear your entire search service indexes, make sure to backup any data that you don't want to lose forever.
void	createIndex() Creates the index
java.lang.String	generateCreateDefaultSecurityObjectQuery(java.util.List<java.lang.String> targetObjectTypesList)
java.lang.String	generateCreateSecurityObjectQuery(java.lang.String aclName, java.lang.String targetObjectTypes, java.util.Map<java.lang.String,java.lang.Object> conditions) Generates the create security object query
java.lang.String	generateGetAttributeDrivenAclQuery(OpenContentObject oco) Generates the get attribute driven acl query
java.lang.String	generateTargetObjectTypeQuery(java.lang.String targetObjectType, java.lang.String conditionQueryString) Generate the create security object query where it targets an object type
LegacyCoreConfig	getSearchConfig() Returns the search config used
void	indexDocument(java.io.InputStream is, java.lang.String objectId, java.util.Map<java.lang.String,java.lang.Object[]> metadata) Indexes a document in our search service
void	indexDocument(java.io.InputStream is, java.lang.String objectId, java.util.Map<java.lang.String,java.lang.Object[]> metadata, int commitWithin) Indexes a document in our search service The commitWithin argument specific to Solr and will not change the commit time for Elasticsearch
void	removeDocumentById(java.lang.String objectId) Removes an indexed document by it id in the search service

Method Detail

clearSearchService

void clearSearchService()

Clears the indexed contents on the search service Warning: this will clear your entire search service indexes, make sure to backup any data that you don't want to lose forever.

indexDocument

void indexDocument(java.io.InputStream is,
                   java.lang.String objectId,
                   java.util.Map<java.lang.String,java.lang.Object[]> metadata)

Indexes a document in our search service

Parameters:

{InputSteam} - is

{String} - object id

{Map - Object[]} metadata

indexDocument

void indexDocument(java.io.InputStream is,
                   java.lang.String objectId,
                   java.util.Map<java.lang.String,java.lang.Object[]> metadata,
                   int commitWithin)

Indexes a document in our search service The commitWithin argument specific to Solr and will not change the commit time for Elasticsearch

Parameters:

{InputSteam} - is

{String} - object id

{Map - Object[]} metadata

{int} - commitWithin

removeDocumentById

void removeDocumentById(java.lang.String objectId)

Removes an indexed document by it id in the search service

Parameters:

{String} - object id

getSearchConfig

LegacyCoreConfig getSearchConfig()

Returns the search config used

Returns:

search config

generateCreateSecurityObjectQuery

java.lang.String generateCreateSecurityObjectQuery(java.lang.String aclName,
                                                   java.lang.String targetObjectTypes,
                                                   java.util.Map<java.lang.String,java.lang.Object> conditions)

Generates the create security object query

Parameters:

{String} - aclName

{String} - targetObjectTypes

{Map - Object> conditions

Returns:

{String} query string

generateTargetObjectTypeQuery

java.lang.String generateTargetObjectTypeQuery(java.lang.String targetObjectType,
                                               java.lang.String conditionQueryString)

Generate the create security object query where it targets an object type

Parameters:

{String} - target object type

{String} - condition query string

Returns:

{String} query string

generateCreateDefaultSecurityObjectQuery

java.lang.String generateCreateDefaultSecurityObjectQuery(java.util.List<java.lang.String> targetObjectTypesList)

generateGetAttributeDrivenAclQuery

java.lang.String generateGetAttributeDrivenAclQuery(OpenContentObject oco)

Generates the get attribute driven acl query

Parameters:

{OpenContentObject} - oco

Returns:

{String} query string

createIndex

void createIndex()

Creates the index