eu.europeana.api2.v2.web.controller

Class ObjectController

java.lang.Object

eu.europeana.api2.v2.web.controller.ObjectController

@Controller
 @RequestMapping(value="/v2/record")
 @SwaggerSelect
public class ObjectController
extends Object

Provides record information in all kinds of formats; json, json-ld, rdf and srw

Author:

Willem-Jan Boogerd

Constructor Summary

Constructors

Constructor and Description
ObjectController(eu.europeana.corelib.search.SearchService searchService, ApiKeyUtils apiKeyUtils, HttpCacheUtils httpCacheUtils) Create a new ObjectController

Method Summary

Modifier and Type	Method and Description
org.springframework.web.servlet.ModelAndView	contextJSONLD(String callback)
org.springframework.web.servlet.ModelAndView	record(String collectionId, String recordId, String profile, String wskey, String callback, org.springframework.web.context.request.WebRequest webRequest, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse response) Handles record.json GET requests.
org.springframework.web.servlet.ModelAndView	recordJSON_LD(String collectionId, String recordId, String wskey, String format, String callback, org.springframework.web.context.request.WebRequest webRequest, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse response) Retrieve a record in JSON-LD format (hidden alias for record.jsonld request)
org.springframework.web.servlet.ModelAndView	recordJSONLD(String collectionId, String recordId, String wskey, String format, String callback, org.springframework.web.context.request.WebRequest webRequest, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse response) Retrieve a record in JSON-LD format.
org.springframework.web.servlet.ModelAndView	recordRdf(String collectionId, String recordId, String wskey, org.springframework.web.context.request.WebRequest webRequest, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse response) Retrieve a record in RDF format
org.springframework.web.servlet.ModelAndView	recordSchemaOrg(String collectionId, String recordId, String wskey, String format, String callback, org.springframework.web.context.request.WebRequest webRequest, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse response) Retrieve a record in Schema.org JSON-LD format.
SrwResponse	recordSrw(String collectionId, String recordId, String wskey, org.springframework.web.context.request.WebRequest webRequest, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse response) Provides records in SRU/SRW (XML) format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectController

@Autowired
public ObjectController(eu.europeana.corelib.search.SearchService searchService,
                                   ApiKeyUtils apiKeyUtils,
                                   HttpCacheUtils httpCacheUtils)

Create a new ObjectController

Parameters:

searchService -

apiKeyUtils -

httpCacheUtils -

Method Detail

record

@RequestMapping(value="/{collectionId}/{recordId}.json",
                method={GET,POST},
                produces="application/json;charset=UTF-8")
public org.springframework.web.servlet.ModelAndView record(@PathVariable
                                                                                                                                                                                                                  String collectionId,
                                                                                                                                                                                                                  @PathVariable
                                                                                                                                                                                                                  String recordId,
                                                                                                                                                                                                                  @RequestParam(value="profile",required=false,defaultValue="full")
                                                                                                                                                                                                                  String profile,
                                                                                                                                                                                                                  @RequestParam(value="wskey")
                                                                                                                                                                                                                  String wskey,
                                                                                                                                                                                                                  @RequestParam(value="callback",required=false)
                                                                                                                                                                                                                  String callback,
                                                                                                                                                                                                                  org.springframework.web.context.request.WebRequest webRequest,
                                                                                                                                                                                                                  javax.servlet.http.HttpServletRequest servletRequest,
                                                                                                                                                                                                                  javax.servlet.http.HttpServletResponse response)
                                                                                                                                                                                                           throws ApiLimitException

Handles record.json GET requests. Each request should consists of at least a collectionId, a recordId and an api-key (wskey)

Parameters:

collectionId - ID of data collection or data set

recordId - ID of record, item - a.k.a. 'localId'

wskey - pre-api term for 'apikey'

profile - supported types are 'params' and 'similar'

callback -

webRequest -

servletRequest -

response -

Returns:

Throws:

ApiLimitException

contextJSONLD

@SwaggerIgnore
 @RequestMapping(value={"/context.jsonld","/context.json-ld"},
                method={GET,POST},
                produces="application/json")
public org.springframework.web.servlet.ModelAndView contextJSONLD(@RequestParam(value="callback",required=false)
                                                                                                                                                                                                                                String callback)

Parameters:

callback -

Returns:

only the context part of a json-ld record

recordJSON_LD

@SwaggerIgnore
 @RequestMapping(value="/{collectionId}/{recordId}.json-ld",
                method={GET,POST},
                produces="application/json")
public org.springframework.web.servlet.ModelAndView recordJSON_LD(@PathVariable
                                                                                                                                                                                                                              String collectionId,
                                                                                                                                                                                                                              @PathVariable
                                                                                                                                                                                                                              String recordId,
                                                                                                                                                                                                                              @RequestParam(value="wskey")
                                                                                                                                                                                                                              String wskey,
                                                                                                                                                                                                                              @RequestParam(value="format",required=false,defaultValue="compacted")
                                                                                                                                                                                                                              String format,
                                                                                                                                                                                                                              @RequestParam(value="callback",required=false)
                                                                                                                                                                                                                              String callback,
                                                                                                                                                                                                                              org.springframework.web.context.request.WebRequest webRequest,
                                                                                                                                                                                                                              javax.servlet.http.HttpServletRequest servletRequest,
                                                                                                                                                                                                                              javax.servlet.http.HttpServletResponse response)
                                                                                                                                                                                                                       throws ApiLimitException

Retrieve a record in JSON-LD format (hidden alias for record.jsonld request)

Parameters:

collectionId - ID of data collection or data set

recordId - ID of record, item - a.k.a. 'localId'

wskey - pre-api term for 'apikey'

format -

callback -

webRequest -

servletRequest -

response -

Returns:

Throws:

ApiLimitException

recordJSONLD

@RequestMapping(value="/{collectionId}/{recordId}.jsonld",
                method={GET,POST},
                produces="application/json")
public org.springframework.web.servlet.ModelAndView recordJSONLD(@PathVariable
                                                                                                                                                                                                            String collectionId,
                                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                                            String recordId,
                                                                                                                                                                                                            @RequestParam(value="wskey")
                                                                                                                                                                                                            String wskey,
                                                                                                                                                                                                            @RequestParam(value="format",required=false,defaultValue="compacted")
                                                                                                                                                                                                            String format,
                                                                                                                                                                                                            @RequestParam(value="callback",required=false)
                                                                                                                                                                                                            String callback,
                                                                                                                                                                                                            org.springframework.web.context.request.WebRequest webRequest,
                                                                                                                                                                                                            javax.servlet.http.HttpServletRequest servletRequest,
                                                                                                                                                                                                            javax.servlet.http.HttpServletResponse response)
                                                                                                                                                                                                     throws ApiLimitException

Retrieve a record in JSON-LD format.

Parameters:

collectionId - ID of data collection or data set

recordId - ID of record, item - a.k.a. 'localId'

wskey - pre-api term for 'apikey'

format - supported types are 'compacted', 'flattened' and 'normalized'

callback -

webRequest -

servletRequest -

response -

Returns:

Throws:

ApiLimitException

recordSchemaOrg

@RequestMapping(value="/{collectionId}/{recordId}.schema.jsonld",
                method={GET,POST},
                produces="application/json")
public org.springframework.web.servlet.ModelAndView recordSchemaOrg(@PathVariable
                                                                                                                                                                                                                      String collectionId,
                                                                                                                                                                                                                      @PathVariable
                                                                                                                                                                                                                      String recordId,
                                                                                                                                                                                                                      @RequestParam(value="wskey",required=true)
                                                                                                                                                                                                                      String wskey,
                                                                                                                                                                                                                      @RequestParam(value="format",required=false,defaultValue="compacted")
                                                                                                                                                                                                                      String format,
                                                                                                                                                                                                                      @RequestParam(value="callback",required=false)
                                                                                                                                                                                                                      String callback,
                                                                                                                                                                                                                      org.springframework.web.context.request.WebRequest webRequest,
                                                                                                                                                                                                                      javax.servlet.http.HttpServletRequest servletRequest,
                                                                                                                                                                                                                      javax.servlet.http.HttpServletResponse response)
                                                                                                                                                                                                               throws ApiLimitException

Retrieve a record in Schema.org JSON-LD format.

Parameters:

collectionId - ID of data collection or data set

recordId - ID of record, item - a.k.a. 'localId'

wskey - pre-api term for 'apikey'

format - supported types are 'compacted', 'flattened' and 'normalized'

callback - repeats whatever you supply

webRequest -

servletRequest -

response -

Returns:

Throws:

ApiLimitException

recordRdf

@RequestMapping(value="/{collectionId}/{recordId}.rdf",
                method={GET,POST},
                produces="application/rdf+xml; charset=UTF-8")
public org.springframework.web.servlet.ModelAndView recordRdf(@PathVariable
                                                                                                                                                                                                                        String collectionId,
                                                                                                                                                                                                                        @PathVariable
                                                                                                                                                                                                                        String recordId,
                                                                                                                                                                                                                        @RequestParam(value="wskey")
                                                                                                                                                                                                                        String wskey,
                                                                                                                                                                                                                        org.springframework.web.context.request.WebRequest webRequest,
                                                                                                                                                                                                                        javax.servlet.http.HttpServletRequest servletRequest,
                                                                                                                                                                                                                        javax.servlet.http.HttpServletResponse response)
                                                                                                                                                                                                                 throws ApiLimitException

Retrieve a record in RDF format

Parameters:

collectionId - ID of data collection or data set

recordId - ID of record, item - a.k.a. 'localId'

wskey - pre-api term for 'apikey'

webRequest -

servletRequest -

response -

Returns:

Throws:

ApiLimitException

recordSrw

@SwaggerIgnore
 @RequestMapping(value="/{collectionId}/{recordId}.srw",
                method={GET,POST},
                produces="text/xml")
 @ResponseBody
public SrwResponse recordSrw(@PathVariable
                                                                                                                                                                                            String collectionId,
                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                            String recordId,
                                                                                                                                                                                            @RequestParam(value="wskey",required=false)
                                                                                                                                                                                            String wskey,
                                                                                                                                                                                            org.springframework.web.context.request.WebRequest webRequest,
                                                                                                                                                                                            javax.servlet.http.HttpServletRequest servletRequest,
                                                                                                                                                                                            javax.servlet.http.HttpServletResponse response)
                                                                                                                                                                                     throws ApiLimitException,
                                                                                                                                                                                            eu.europeana.corelib.web.exception.EuropeanaException

Provides records in SRU/SRW (XML) format.

Parameters:

collectionId - ID of data collection or data set

recordId - ID of record, item - a.k.a. 'localId'

wskey - pre-api term for 'apikey'

webRequest -

servletRequest -

response -

Returns:

Throws:

Exception

ApiLimitException

eu.europeana.corelib.web.exception.EuropeanaException