Package org.opencastproject.elasticsearch.index.rebuild

Class IndexRebuildService

java.lang.Object

org.opencastproject.elasticsearch.index.rebuild.IndexRebuildService

All Implemented Interfaces:

org.osgi.framework.BundleActivator

public class IndexRebuildService
extends Object
implements org.osgi.framework.BundleActivator

The bundle activator is defined in the pom.xml of this bundle.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	IndexRebuildService.DataType
static enum	IndexRebuildService.Service	The services whose data is indexed by ElasticSearch.
static enum	IndexRebuildService.State

Constructor Summary

Constructors

Constructor	Description
IndexRebuildService()

Method Summary

Modifier and Type	Method	Description
IndexProducer	getIndexProducer(IndexRebuildService.Service service)	Get the service by its enum identifier.
Map<String,String>	getRebuildStates()
void	rebuildIndex(ElasticsearchIndex index)	Clear and rebuild the index from all services.
void	rebuildIndex(IndexProducer indexProducer, IndexRebuildService.DataType dataType)	Partially rebuild the index from a specific service and maybe only a specific data type.
void	resumeIndexRebuild(IndexRebuildService.Service startingService)	Start Index Rebuild from the specified service and then do all that follow.
void	start(org.osgi.framework.BundleContext bundleContext)	Called by OSGI when this bundle is started.
void	stop(org.osgi.framework.BundleContext bundleContext)	Called by OSGI when this bundle is stopped.

Methods inherited from class java.lang.Object

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

Constructor Details

IndexRebuildService

public IndexRebuildService()

Method Details

start

public void start(org.osgi.framework.BundleContext bundleContext)
           throws Exception

Called by OSGI when this bundle is started.

Specified by:

start in interface org.osgi.framework.BundleActivator

Parameters:

bundleContext - The bundle context.

Throws:

Exception

stop

public void stop(org.osgi.framework.BundleContext bundleContext)
          throws Exception

Called by OSGI when this bundle is stopped.

Specified by:

stop in interface org.osgi.framework.BundleActivator

Parameters:

bundleContext - The bundle context.

Throws:

Exception

getIndexProducer

public IndexProducer getIndexProducer(IndexRebuildService.Service service)
                               throws IllegalStateException

Get the service by its enum identifier.

Parameters:

service - The enum identifying the service.

Returns:

the service

Throws:

IllegalStateException - If the service is not registered.

rebuildIndex

public void rebuildIndex(ElasticsearchIndex index)
                  throws IOException,
IndexRebuildException,
IllegalArgumentException

Clear and rebuild the index from all services.

Parameters:

index - The index to rebuild.

Throws:

IOException - Thrown if the index cannot be cleared.

IndexRebuildException - Thrown if the index rebuild failed.

IllegalArgumentException

rebuildIndex

public void rebuildIndex(IndexProducer indexProducer,
 IndexRebuildService.DataType dataType)
                  throws IllegalArgumentException,
IndexRebuildException

Partially rebuild the index from a specific service and maybe only a specific data type.

Parameters:

indexProducer - The service to re-index from.

dataType - The data type to re-index.

Throws:

IllegalArgumentException - Thrown if the service doesn't support the data type.

IndexRebuildException - Thrown if the index rebuild failed.

resumeIndexRebuild

public void resumeIndexRebuild(IndexRebuildService.Service startingService)
                        throws IllegalArgumentException,
IndexRebuildException

Start Index Rebuild from the specified service and then do all that follow. Can be used to resume a complete index rebuild that was interrupted.

Parameters:

startingService - The IndexRebuildService.Service to start with.

Throws:

IllegalArgumentException - Thrown if the service doesn't exist.

IndexRebuildException - Thrown if the index rebuild failed.

getRebuildStates

public Map<String,String> getRebuildStates()

Returns:

All rebuild service repopulation states.