Package org.dspace.app.rest

Class OpenSearchController

java.lang.Object

org.dspace.app.rest.OpenSearchController

@Controller
@RequestMapping("/opensearch")
public class OpenSearchController
extends Object

This class provides a controller for OpenSearch support. It creates a namespace /opensearch in the DSpace REST webapp.

Author:

Oliver Goldschmidt (o.goldschmidt at tuhh.de)

Constructor Summary

Constructors

Constructor	Description
OpenSearchController()

Method Summary

Modifier and Type	Method	Description
void	search(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, String query, Integer start, Integer count, String format, String sort, String sortDirection, String dsoObject, String configuration, List<SearchFilter> searchFilters)	This method provides the OpenSearch query on the path /search It will pass the result as a OpenSearchDocument directly to the client
void	service(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	This method provides the OpenSearch servicedescription document on the path /service It will pass the result as a OpenSearchDocument directly to the client
void	setOpenSearchService(OpenSearchService oSS)

Methods inherited from class java.lang.Object

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

Constructor Details

OpenSearchController

public OpenSearchController()

Method Details

search

@GetMapping("/search")
public void search(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 @RequestParam(name="query",required=false)
 String query,
 @RequestParam(name="start",required=false)
 Integer start,
 @RequestParam(name="rpp",required=false)
 Integer count,
 @RequestParam(name="format",required=false)
 String format,
 @RequestParam(name="sort",required=false)
 String sort,
 @RequestParam(name="sort_direction",required=false)
 String sortDirection,
 @RequestParam(name="scope",required=false)
 String dsoObject,
 @RequestParam(name="configuration",required=false)
 String configuration,
 List<SearchFilter> searchFilters)
            throws IOException,
jakarta.servlet.ServletException

This method provides the OpenSearch query on the path /search It will pass the result as a OpenSearchDocument directly to the client

Throws:

IOException

jakarta.servlet.ServletException

service

@GetMapping("/service")
public void service(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
             throws IOException

This method provides the OpenSearch servicedescription document on the path /service It will pass the result as a OpenSearchDocument directly to the client

Throws:

IOException

setOpenSearchService

public void setOpenSearchService(OpenSearchService oSS)