Package org.ehrbase.rest.openehr

Class OpenehrQueryController

java.lang.Object

org.ehrbase.rest.BaseController

org.ehrbase.rest.openehr.OpenehrQueryController

All Implemented Interfaces:

QueryApiSpecification

@RestController
@RequestMapping(path="${openehr-api.context-path:/rest/openehr}/v1/query")
public class OpenehrQueryController
extends BaseController
implements QueryApiSpecification

Controller for openEHR REST API QUERY resource.

Since:

1.0

Author:

Jake Smolka, Renaud Subiger

Field Summary

Fields inherited from class org.ehrbase.rest.BaseController

ACCEPT, COMPOSITION, CONTENT_TYPE, CONTRIBUTION, DEFINITION, DIRECTORY, EHR, EHR_STATUS, ETAG, IF_MATCH, IF_NONE_MATCH, LAST_MODIFIED, LOCATION, OPENEHR_AUDIT_DETAILS, OPENEHR_VERSION, PREFER, QUERY, REQ_ACCEPT, REQ_CONTENT_TYPE, REQ_CONTENT_TYPE_BODY, REQ_OPENEHR_AUDIT, REQ_OPENEHR_VERSION, REQ_PREFER, RESP_CONTENT_TYPE_DESC, RESP_ETAG_DESC, RESP_LAST_MODIFIED_DESC, RESP_LOCATION_DESC, RESP_NOT_ACCEPTABLE_DESC, RESP_UNSUPPORTED_MEDIA_DESC, REST_OPERATION, RETURN_MINIMAL, RETURN_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
OpenehrQueryController(QueryService queryService)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.QueryResponseData>	executeAdHocQuery(String query, Integer offset, Integer fetch, Map<String,Object> queryParameters, String accept, javax.servlet.http.HttpServletRequest request)	Execute ad-hoc (non-stored) AQL query.
org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.QueryResponseData>	executeAdHocQuery(Map<String,Object> queryRequest, String accept, String contentType, javax.servlet.http.HttpServletRequest request)	Execute ad-hoc (non-stored) AQL query.
org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.QueryResponseData>	executeStoredQuery(String qualifiedQueryName, String version, Integer offset, Integer fetch, Map<String,Object> queryParameter, String accept, javax.servlet.http.HttpServletRequest request)	Execute stored query.
org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.QueryResponseData>	executeStoredQuery(String qualifiedQueryName, String version, String accept, String contentType, Map<String,Object> queryRequest, javax.servlet.http.HttpServletRequest request)	Execute stored query.

Methods inherited from class org.ehrbase.rest.BaseController

add2MetaMap, encodePath, enrichRequestAttribute, extractCompositionFormat, extractVersionedObjectUidFromVersionUid, extractVersionFromVersionUid, getBaseEnvLinkURL, getCompositionVersionedObjectUidString, getContributionVersionedObjectUidString, getEhrUuid, getVersionAtTimeParam, resolveContentType, resolveContentType

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenehrQueryController

public OpenehrQueryController(QueryService queryService)

Method Detail

executeAdHocQuery

@GetMapping(path="/aql")
@PostAuthorize("checkAbacPostQuery(@queryServiceImp.getAuditResultMap())")
public org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.QueryResponseData> executeAdHocQuery(@RequestParam(name="q")
                                                                                                                 String query,
                                                                                                                 @RequestParam(name="offset",required=false)
                                                                                                                 Integer offset,
                                                                                                                 @RequestParam(name="fetch",required=false)
                                                                                                                 Integer fetch,
                                                                                                                 @RequestParam(name="query_parameters",required=false)
                                                                                                                 Map<String,Object> queryParameters,
                                                                                                                 @RequestHeader(name="Accept",required=false)
                                                                                                                 String accept,
                                                                                                                 javax.servlet.http.HttpServletRequest request)

Execute ad-hoc (non-stored) AQL query.

Specified by:

executeAdHocQuery in interface QueryApiSpecification

executeAdHocQuery

@PostMapping(path="/aql")
@PostAuthorize("checkAbacPostQuery(@queryServiceImp.getAuditResultMap())")
public org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.QueryResponseData> executeAdHocQuery(@RequestBody
                                                                                                                 Map<String,Object> queryRequest,
                                                                                                                 @RequestHeader(name="Accept",required=false)
                                                                                                                 String accept,
                                                                                                                 @RequestHeader(name="Content-Type")
                                                                                                                 String contentType,
                                                                                                                 javax.servlet.http.HttpServletRequest request)

Execute ad-hoc (non-stored) AQL query.

Specified by:

executeAdHocQuery in interface QueryApiSpecification

executeStoredQuery

@GetMapping(path={"/{qualified_query_name}","/{qualified_query_name}/{version}"})
@PostAuthorize("checkAbacPostQuery(@queryServiceImp.getAuditResultMap())")
public org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.QueryResponseData> executeStoredQuery(@PathVariable(name="qualified_query_name")
                                                                                                                  String qualifiedQueryName,
                                                                                                                  @PathVariable(name="version",required=false)
                                                                                                                  String version,
                                                                                                                  @RequestParam(name="offset",required=false)
                                                                                                                  Integer offset,
                                                                                                                  @RequestParam(name="fetch",required=false)
                                                                                                                  Integer fetch,
                                                                                                                  @RequestParam(name="query_parameters",required=false)
                                                                                                                  Map<String,Object> queryParameter,
                                                                                                                  @RequestHeader(name="Accept",required=false)
                                                                                                                  String accept,
                                                                                                                  javax.servlet.http.HttpServletRequest request)

Execute stored query.

Specified by:

executeStoredQuery in interface QueryApiSpecification

executeStoredQuery

@PostMapping(path={"/{qualified_query_name}","/{qualified_query_name}/{version}"})
@PostAuthorize("checkAbacPostQuery(@queryServiceImp.getAuditResultMap())")
public org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.QueryResponseData> executeStoredQuery(@PathVariable(name="qualified_query_name")
                                                                                                                  String qualifiedQueryName,
                                                                                                                  @PathVariable(name="version",required=false)
                                                                                                                  String version,
                                                                                                                  @RequestHeader(name="Accept",required=false)
                                                                                                                  String accept,
                                                                                                                  @RequestHeader(name="Content-Type")
                                                                                                                  String contentType,
                                                                                                                  @RequestBody(required=false)
                                                                                                                  Map<String,Object> queryRequest,
                                                                                                                  javax.servlet.http.HttpServletRequest request)

Execute stored query.

Specified by:

executeStoredQuery in interface QueryApiSpecification