Package org.opencastproject.search.impl

Class SearchServiceImpl

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

org.opencastproject.search.impl.SearchServiceImpl

All Implemented Interfaces:

JobProducer, SearchService, StaticFileAuthorization

public final class SearchServiceImpl
extends AbstractJobProducer
implements SearchService, StaticFileAuthorization

An Opensearch-based SearchService implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencastproject.search.api.SearchService

SearchService.IndexEntryType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_JOB_LOAD_KEY	The key to look for in the service configuration file to override the DEFAULT_ADD_JOB_LOAD
static final float	DEFAULT_ADD_JOB_LOAD	The load introduced on the system by creating an add job
static final float	DEFAULT_DELETE_JOB_LOAD	The load introduced on the system by creating a delete job
static final String	DELETE_JOB_LOAD_KEY	The key to look for in the service configuration file to override the DEFAULT_DELETE_JOB_LOAD
static final String	JOB_TYPE	The job type
protected OrganizationDirectoryService	organizationDirectory	The organization directory service
protected UserDirectoryService	userDirectoryService	The user directory service

Fields inherited from class org.opencastproject.job.api.AbstractJobProducer

ACCEPT_JOB_LOADS_EXCEEDING_PROPERTY, acceptJobLoadsExeedingMaxLoad, DEFAULT_ACCEPT_JOB_LOADS_EXCEEDING, executor, jobType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	Service activator, called via declarative services configuration.
Job	add(MediaPackage mediaPackage)	Adds the media package to the search index.
void	addSynchronously(MediaPackage mediaPackage)	Immediately adds the mediapackage to the search index.
Job	delete(String mediaPackageId)	Removes the media package identified by mediaPackageId from the search index.
Job	deleteSeries(String seriesId)	Removes the series identified by seriseId from the search index.
boolean	deleteSynchronously(String mediaPackageId)	Immediately removes the given mediapackage from the search service.
MediaPackage	get(String mediaPackageId)	Gets the MediaPackage for an event, based on its mediapackage ID.
protected OrganizationDirectoryService	getOrganizationDirectoryService()	Returns a reference to the organization directory service.
List<Pattern>	getProtectedUrlPattern()	Get the list of URL patterns the service is responsible for.
protected SecurityService	getSecurityService()	Returns a reference to the security service
Collection<org.apache.commons.lang3.tuple.Pair<Organization,MediaPackage>>	getSeries(String seriesId)	Returns a list of Organization,MediaPackage pairs of mediapackages within a series.
protected ServiceRegistry	getServiceRegistry()	Returns a reference to the service registry.
protected UserDirectoryService	getUserDirectoryService()	Returns a reference to the user directory service
void	modified(Map<String,Object> properties)
protected String	process(Job job)	Asks the overriding class to process the arguments using the given operation.
SearchResultList	search(org.elasticsearch.search.builder.SearchSourceBuilder searchSource)	Searches the index based on a SearchSourceBuilder's query
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectory)	Sets a reference to the organization directory service.
void	setPersistence(SearchServiceDatabase persistence)
void	setSearchIndex(SearchServiceIndex ssi)
void	setSecurityService(SecurityService securityService)	Callback for setting the security service.
void	setServiceRegistry(ServiceRegistry serviceRegistry)
void	setUserDirectoryService(UserDirectoryService userDirectoryService)	Callback for setting the user directory service.
boolean	verifyUrlAccess(String path)	Check a given path for access.

Methods inherited from class org.opencastproject.job.api.AbstractJobProducer

acceptJob, countJobs, finallyUpdateJob, getJobType, incident, isReadyToAccept, isReadyToAcceptJobs

Methods inherited from class java.lang.Object

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

Field Details

JOB_TYPE

public static final String JOB_TYPE

The job type

See Also:

• Constant Field Values

DEFAULT_ADD_JOB_LOAD

public static final float DEFAULT_ADD_JOB_LOAD

The load introduced on the system by creating an add job

See Also:

• Constant Field Values

DEFAULT_DELETE_JOB_LOAD

public static final float DEFAULT_DELETE_JOB_LOAD

The load introduced on the system by creating a delete job

See Also:

• Constant Field Values

ADD_JOB_LOAD_KEY

public static final String ADD_JOB_LOAD_KEY

The key to look for in the service configuration file to override the DEFAULT_ADD_JOB_LOAD

See Also:

• Constant Field Values

DELETE_JOB_LOAD_KEY

public static final String DELETE_JOB_LOAD_KEY

The key to look for in the service configuration file to override the DEFAULT_DELETE_JOB_LOAD

See Also:

• Constant Field Values

userDirectoryService

protected UserDirectoryService userDirectoryService

The user directory service

organizationDirectory

protected OrganizationDirectoryService organizationDirectory

The organization directory service

Constructor Details

SearchServiceImpl

public SearchServiceImpl()

Creates a new instance of the search service.

Method Details

activate

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

Service activator, called via declarative services configuration.

Overrides:

activate in class AbstractJobProducer

Parameters:

cc - the component context

Throws:

IllegalStateException

add

public Job add(MediaPackage mediaPackage)
        throws SearchException,
IllegalArgumentException

Adds the media package to the search index.

Specified by:

add in interface SearchService

Parameters:

mediaPackage - the media package

Throws:

SearchException - if an error occurs while adding the media package

IllegalArgumentException

See Also:

• SearchService.add(org.opencastproject.mediapackage.MediaPackage)

addSynchronously

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

Description copied from interface: SearchService

Immediately adds the mediapackage to the search index.

Specified by:

addSynchronously in interface SearchService

Parameters:

mediaPackage - the media package

Throws:

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

IllegalArgumentException - if the mediapackage is null

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

getSeries

public Collection<org.apache.commons.lang3.tuple.Pair<Organization,MediaPackage>> getSeries(String seriesId)

Description copied from interface: SearchService

Returns a list of Organization,MediaPackage pairs of mediapackages within a series. Note that the Organization should always be the same since series should not cross organizational bounds.

Specified by:

getSeries in interface SearchService

Parameters:

seriesId - the series ID to query

Returns:

A list of Organization,MediaPackage pairs of mediapackages within the series.

delete

public Job delete(String mediaPackageId)
           throws SearchException

Removes the media package identified by mediaPackageId from the search index.

Specified by:

delete in interface SearchService

Parameters:

mediaPackageId - id of the media package to remove

Returns:

true if the episode was found and deleted

Throws:

SearchException - if an error occurs while removing the media package

See Also:

• SearchService.delete(java.lang.String)

deleteSynchronously

public boolean deleteSynchronously(String mediaPackageId)
                            throws SearchException

Description copied from interface: SearchService

Immediately removes the given mediapackage from the search service.

Specified by:

deleteSynchronously in interface SearchService

Parameters:

mediaPackageId - the mediapackage

Returns:

true if the mediapackage was deleted

Throws:

SearchException - if deletion failed

deleteSeries

public Job deleteSeries(String seriesId)
                 throws SearchException

Removes the series identified by seriseId from the search index. Does *not* remove the associated events from the index!

Specified by:

deleteSeries in interface SearchService

Parameters:

seriesId - id of the series to remove

Returns:

true if the series was found and deleted

Throws:

SearchException - if an error occurs while removing the series

See Also:

• SearchService.deleteSeries(java.lang.String)

get

public MediaPackage get(String mediaPackageId)
                 throws NotFoundException,
UnauthorizedException

Description copied from interface: SearchService

Gets the MediaPackage for an event, based on its mediapackage ID.

Specified by:

get in interface SearchService

Parameters:

mediaPackageId - The ID of the mediapackage in question

Returns:

The MediaPackage

Throws:

NotFoundException - If the mediapackage is not found.

UnauthorizedException - if the current user is not authorized to view this mediapackage.

search

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

Description copied from interface: SearchService

Searches the index based on a SearchSourceBuilder's query

Specified by:

search in interface SearchService

Parameters:

searchSource - The SearchSourceBuilder defining the search query

Returns:

A SearchResultList of the search's results

Throws:

SearchException - If an error occurs while searching the index.

process

protected String process(Job job)
                  throws Exception

Description copied from class: AbstractJobProducer

Asks the overriding class to process the arguments using the given operation. The result will be added to the associated job as the payload.

Specified by:

process in class AbstractJobProducer

Parameters:

job - the job to process

Returns:

the operation result

Throws:

Exception

See Also:

• AbstractJobProducer.process(org.opencastproject.job.api.Job)

setSearchIndex

public void setSearchIndex(SearchServiceIndex ssi)

setPersistence

public void setPersistence(SearchServiceDatabase persistence)

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

setSecurityService

public void setSecurityService(SecurityService securityService)

Callback for setting the security service.

Parameters:

securityService - the securityService to set

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

Callback for setting the user directory service.

Parameters:

userDirectoryService - the userDirectoryService to set

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectory)

Sets a reference to the organization directory service.

Parameters:

organizationDirectory - the organization directory

getOrganizationDirectoryService

protected OrganizationDirectoryService getOrganizationDirectoryService()

Description copied from class: AbstractJobProducer

Returns a reference to the organization directory service.

Specified by:

getOrganizationDirectoryService in class AbstractJobProducer

Returns:

the organization directory service

See Also:

• AbstractJobProducer.getOrganizationDirectoryService()

getSecurityService

protected SecurityService getSecurityService()

Description copied from class: AbstractJobProducer

Returns a reference to the security service

Specified by:

getSecurityService in class AbstractJobProducer

Returns:

the security service

See Also:

• AbstractJobProducer.getSecurityService()

getServiceRegistry

protected ServiceRegistry getServiceRegistry()

Description copied from class: AbstractJobProducer

Returns a reference to the service registry.

Specified by:

getServiceRegistry in class AbstractJobProducer

Returns:

the service registry

See Also:

• AbstractJobProducer.getServiceRegistry()

getUserDirectoryService

protected UserDirectoryService getUserDirectoryService()

Description copied from class: AbstractJobProducer

Returns a reference to the user directory service

Specified by:

getUserDirectoryService in class AbstractJobProducer

Returns:

the user directory service

See Also:

• AbstractJobProducer.getUserDirectoryService()

modified

public void modified(Map<String,Object> properties)

getProtectedUrlPattern

public List<Pattern> getProtectedUrlPattern()

Description copied from interface: StaticFileAuthorization

Get the list of URL patterns the service is responsible for.

Specified by:

getProtectedUrlPattern in interface StaticFileAuthorization

Returns:

List of pattern matchers

verifyUrlAccess

public boolean verifyUrlAccess(String path)

Description copied from interface: StaticFileAuthorization

Check a given path for access.

Specified by:

verifyUrlAccess in interface StaticFileAuthorization

Parameters:

path - Path to check

Returns:

if access is allowed