Package org.opencastproject.search.endpoint

Class SearchRestService

java.lang.Object

org.opencastproject.rest.AbstractJobProducerEndpoint

org.opencastproject.search.endpoint.SearchRestService

@Path("/search")
public class SearchRestService
extends AbstractJobProducerEndpoint

The REST endpoint

Field Summary

Fields

Modifier and Type	Field	Description
protected SearchServiceIndex	searchIndex	The connector to the actual index
protected SearchServiceImpl	searchService	The search service which talks to the database.

Constructor Summary

Constructors

Constructor	Description
SearchRestService()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getEpisodes(String id, String text, String seriesId, String seriesName, String sort, String limit, String offset, String sign)
javax.ws.rs.core.Response	getSeries(String id, String text, String sort, String limit, String offset)
JobProducer	getService()	Returns the job producer that is backing this REST endpoint.
ServiceRegistry	getServiceRegistry()	Return the service registry.
javax.ws.rs.core.Response	indexUpdate(String id)
void	setSearchIndex(SearchServiceIndex searchIndex)
void	setSearchService(SearchServiceImpl searchService)	Callback from OSGi to set the search service implementation.
void	setSecurityService(SecurityService securityService)
void	setServiceRegistry(ServiceRegistry serviceRegistry)

Methods inherited from class org.opencastproject.rest.AbstractJobProducerEndpoint

checkHeartbeat, dispatchJob

Methods inherited from class java.lang.Object

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

Field Details

searchService

protected SearchServiceImpl searchService

The search service which talks to the database. Only needed for the JobProducer bits.

searchIndex

protected SearchServiceIndex searchIndex

The connector to the actual index

Constructor Details

SearchRestService

public SearchRestService()

Method Details

getSeries

@GET
@Path("series.json")
@Produces("application/json")
public javax.ws.rs.core.Response getSeries(@QueryParam("id")
 String id,
 @QueryParam("q")
 String text,
 @QueryParam("sort")
 String sort,
 @QueryParam("limit")
 String limit,
 @QueryParam("offset")
 String offset)
                                    throws SearchException

Throws:

SearchException

getEpisodes

@GET
@Path("episode.json")
@Produces("application/json")
public javax.ws.rs.core.Response getEpisodes(@QueryParam("id")
 String id,
 @QueryParam("q")
 String text,
 @QueryParam("sid")
 String seriesId,
 @QueryParam("sname")
 String seriesName,
 @QueryParam("sort")
 String sort,
 @QueryParam("limit")
 String limit,
 @QueryParam("offset")
 String offset,
 @QueryParam("sign")
 String sign)
                                      throws SearchException

Throws:

SearchException

indexUpdate

@POST
@Path("updateIndex")
public javax.ws.rs.core.Response indexUpdate(@FormParam("id")
 String id)

getService

public JobProducer getService()

Description copied from class: AbstractJobProducerEndpoint

Returns the job producer that is backing this REST endpoint.

Specified by:

getService in class AbstractJobProducerEndpoint

Returns:

the job producer

See Also:

• AbstractJobProducerEndpoint.getService()

setSearchService

public void setSearchService(SearchServiceImpl searchService)

Callback from OSGi to set the search service implementation.

Parameters:

searchService - the service implementation

setSearchIndex

public void setSearchIndex(SearchServiceIndex searchIndex)

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

getServiceRegistry

public ServiceRegistry getServiceRegistry()

Description copied from class: AbstractJobProducerEndpoint

Return the service registry.

Specified by:

getServiceRegistry in class AbstractJobProducerEndpoint

setSecurityService

public void setSecurityService(SecurityService securityService)