Package org.dspace.app.rest

Class DiscoveryRestController

java.lang.Object

org.dspace.app.rest.DiscoveryRestController

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

@RestController
@RequestMapping("/api/discover")
public class DiscoveryRestController
extends Object
implements org.springframework.beans.factory.InitializingBean

The controller for the api/discover endpoint

Field Summary

Fields

Modifier and Type	Field	Description
protected Utils	utils

Constructor Summary

Constructors

Constructor	Description
DiscoveryRestController()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
FacetsResource	getFacets(String query, List<String> dsoTypes, String dsoScope, String configuration, List<SearchFilter> searchFilters, org.springframework.data.domain.Pageable page)
FacetConfigurationResource	getFacetsConfiguration(String dsoScope, String configuration, org.springframework.data.domain.Pageable pageable)
org.springframework.hateoas.RepresentationModel	getFacetValues(String facetName, String prefix, String query, List<String> dsoTypes, String dsoScope, String configuration, List<SearchFilter> searchFilters, org.springframework.data.domain.Pageable page)
SearchConfigurationResource	getSearchConfiguration(String dsoScope, String configuration)
SearchResultsResource	getSearchObjects(String query, List<String> dsoTypes, String dsoScope, String configuration, List<SearchFilter> searchFilters, org.springframework.data.domain.Pageable page)
SearchSupportResource	getSearchSupport(String dsoScope, String configuration)

Methods inherited from class java.lang.Object

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

Field Details

utils

@Autowired
protected Utils utils

Constructor Details

DiscoveryRestController

public DiscoveryRestController()

Method Details

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

getSearchSupport

@RequestMapping(method=GET)
public SearchSupportResource getSearchSupport(@RequestParam(name="scope",required=false)
 String dsoScope,
 @RequestParam(name="configuration",required=false)
 String configuration)
                                       throws Exception

Throws:

Exception

getSearchConfiguration

@RequestMapping(method=GET,
                value="/search")
public SearchConfigurationResource getSearchConfiguration(@RequestParam(name="scope",required=false)
 String dsoScope,
 @RequestParam(name="configuration",required=false)
 String configuration)
                                                   throws Exception

Throws:

Exception

getFacets

@RequestMapping(method=GET,
                value="/search/facets")
public FacetsResource getFacets(@RequestParam(name="query",required=false)
 String query,
 @RequestParam(name="dsoType",required=false)
 List<String> dsoTypes,
 @RequestParam(name="scope",required=false)
 String dsoScope,
 @RequestParam(name="configuration",required=false)
 String configuration,
 List<SearchFilter> searchFilters,
 org.springframework.data.domain.Pageable page)
                         throws Exception

Throws:

Exception

getSearchObjects

@RequestMapping(method=GET,
                value="/search/objects")
public SearchResultsResource getSearchObjects(@RequestParam(name="query",required=false)
 String query,
 @RequestParam(name="dsoType",required=false)
 List<String> dsoTypes,
 @RequestParam(name="scope",required=false)
 String dsoScope,
 @RequestParam(name="configuration",required=false)
 String configuration,
 List<SearchFilter> searchFilters,
 org.springframework.data.domain.Pageable page)
                                       throws Exception

Throws:

Exception

getFacetsConfiguration

@RequestMapping(method=GET,
                value="/facets")
public FacetConfigurationResource getFacetsConfiguration(@RequestParam(name="scope",required=false)
 String dsoScope,
 @RequestParam(name="configuration",required=false)
 String configuration,
 org.springframework.data.domain.Pageable pageable)
                                                  throws Exception

Throws:

Exception

getFacetValues

@RequestMapping(method=GET,
                value="/facets/{name}")
public org.springframework.hateoas.RepresentationModel getFacetValues(@PathVariable("name")
 String facetName,
 @RequestParam(name="prefix",required=false)
 String prefix,
 @RequestParam(name="query",required=false)
 String query,
 @RequestParam(name="dsoType",required=false)
 List<String> dsoTypes,
 @RequestParam(name="scope",required=false)
 String dsoScope,
 @RequestParam(name="configuration",required=false)
 String configuration,
 List<SearchFilter> searchFilters,
 org.springframework.data.domain.Pageable page)
                                                               throws Exception

Throws:

Exception