Package org.opencastproject.search.impl

Class SearchServiceIndex

java.lang.Object

org.opencastproject.elasticsearch.index.rebuild.AbstractIndexProducer

org.opencastproject.search.impl.SearchServiceIndex

All Implemented Interfaces:

IndexProducer

public final class SearchServiceIndex
extends AbstractIndexProducer
implements IndexProducer

A Elasticsearch-based SearchService implementation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INDEX_NAME

Constructor Summary

Constructors

Constructor	Description
SearchServiceIndex()	Creates a new instance of the search service index.

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	Service activator, called via declarative services configuration.
void	addSynchronously(MediaPackage mediaPackage)	Immediately adds the mediapackage to the search index.
boolean	deleteSeriesSynchronously(String seriesId)	Immediately removes the given series from the search service.
boolean	deleteSynchronously(String mediaPackageId)	Immediately removes the given mediapackage from the search service.
IndexRebuildService.Service	getService()	Get the service that implements IndexProducer.
void	indexMediaPackage(String mediaPackageId)
void	repopulate(IndexRebuildService.DataType type)	Re-add the data of this service to the index.
org.elasticsearch.action.search.SearchResponse	search(org.elasticsearch.search.builder.SearchSourceBuilder searchSource)
void	setAuthorizationService(AuthorizationService authorizationService)
void	setEsIndex(ElasticsearchIndex esIndex)
void	setListProvidersService(ListProvidersService listProvidersService)
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectory)	Sets a reference to the organization directory service.
void	setPersistence(SearchServiceDatabase persistence)
void	setSecurityService(SecurityService securityService)	Callback for setting the security service.
void	setSeriesService(SeriesService seriesService)
void	setWorkspace(Workspace workspace)

Methods inherited from class org.opencastproject.elasticsearch.index.rebuild.AbstractIndexProducer

logIndexRebuildBegin, logIndexRebuildBegin, logIndexRebuildError, logIndexRebuildError, logIndexRebuildError, logIndexRebuildProgress, logIndexRebuildProgress, logIndexRebuildProgress, logIndexRebuildProgress, logSkippingElement, logSkippingElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencastproject.elasticsearch.index.rebuild.IndexProducer

dataTypeSupported, getSupportedDataTypes

Field Details

INDEX_NAME

public static final String INDEX_NAME

See Also:

• Constant Field Values

Constructor Details

SearchServiceIndex

public SearchServiceIndex()

Creates a new instance of the search service index.

Method Details

getService

public IndexRebuildService.Service getService()

Description copied from interface: IndexProducer

Get the service that implements IndexProducer.

Specified by:

getService in interface IndexProducer

Returns:

service The service that implements IndexProducer.

activate

public void activate(org.osgi.service.component.ComponentContext cc)
              throws IllegalStateException

Service activator, called via declarative services configuration.

Parameters:

cc - the component context

Throws:

IllegalStateException

setEsIndex

public void setEsIndex(ElasticsearchIndex esIndex)

search

public org.elasticsearch.action.search.SearchResponse search(org.elasticsearch.search.builder.SearchSourceBuilder searchSource)
                                                      throws SearchException

Throws:

SearchException

addSynchronously

public void addSynchronously(MediaPackage mediaPackage)
                      throws SearchException,
IllegalArgumentException,
UnauthorizedException,
SearchServiceDatabaseException

Immediately adds the mediapackage to the search index.

Parameters:

mediaPackage - the media package

Throws:

SearchException - if the media package cannot be added to the search index

IllegalArgumentException - if the media package is null

UnauthorizedException - if the user does not have the rights to add the mediapackage

SearchServiceDatabaseException

indexMediaPackage

public void indexMediaPackage(String mediaPackageId)
                       throws SearchException,
SearchServiceDatabaseException,
UnauthorizedException,
NotFoundException

Throws:

SearchException

SearchServiceDatabaseException

UnauthorizedException

NotFoundException

deleteSynchronously

public boolean deleteSynchronously(String mediaPackageId)
                            throws SearchException

Immediately removes the given mediapackage from the search service.

Parameters:

mediaPackageId - the media package identifier

Returns:

true if the mediapackage was deleted

Throws:

SearchException - if deletion failed

deleteSeriesSynchronously

public boolean deleteSeriesSynchronously(String seriesId)
                                  throws SearchException

Immediately removes the given series from the search service.

Parameters:

seriesId - the series

Throws:

SearchException

repopulate

public void repopulate(IndexRebuildService.DataType type)
                throws IndexRebuildException

Description copied from interface: IndexProducer

Re-add the data of this service to the index.

Specified by:

repopulate in interface IndexProducer

Parameters:

type - Limit the data added to the index. Use ALL to re-index all data.

Throws:

IndexRebuildException

setPersistence

public void setPersistence(SearchServiceDatabase persistence)

setSeriesService

public void setSeriesService(SeriesService seriesService)

setWorkspace

public void setWorkspace(Workspace workspace)

setAuthorizationService

public void setAuthorizationService(AuthorizationService authorizationService)

setSecurityService

public void setSecurityService(SecurityService securityService)

Callback for setting the security service.

Parameters:

securityService - the securityService to set

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectory)

Sets a reference to the organization directory service.

Parameters:

organizationDirectory - the organization directory

setListProvidersService

public void setListProvidersService(ListProvidersService listProvidersService)