Package org.ehrbase.rest.openehr

Class OpenehrDirectoryController

java.lang.Object

org.ehrbase.rest.BaseController

org.ehrbase.rest.openehr.OpenehrDirectoryController

All Implemented Interfaces:

DirectoryApiSpecification

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

Controller for openEHR /directory endpoints

Since:

1.0

Author:

Jake Smolka, Luis Marco-Ruiz, 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
OpenehrDirectoryController(FolderService folderService, EhrService ehrService)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.DirectoryResponseData>	createDirectory(UUID ehrId, String openEhrVersion, String openEhrAuditDetails, String contentType, String accept, String prefer, com.nedap.archie.rm.directory.Folder folder)
org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.DirectoryResponseData>	deleteDirectory(UUID ehrId, String openEhrVersion, String openEhrAuditDetails, String accept, com.nedap.archie.rm.support.identification.ObjectVersionId folderId)
org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.DirectoryResponseData>	getFolderInDirectory(UUID ehrId, com.nedap.archie.rm.support.identification.ObjectVersionId versionUid, String path, String accept)
org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.DirectoryResponseData>	getFolderInDirectoryVersionAtTime(UUID ehrId, String versionAtTime, String path, String accept)
org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.DirectoryResponseData>	updateDirectory(UUID ehrId, com.nedap.archie.rm.support.identification.ObjectVersionId folderId, String contentType, String accept, String prefer, String openEhrVersion, String openEhrAuditDetails, com.nedap.archie.rm.directory.Folder folder)

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

OpenehrDirectoryController

public OpenehrDirectoryController(FolderService folderService,
                                  EhrService ehrService)

Method Detail

createDirectory

@PostMapping(path="/{ehr_id}/directory")
public org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.DirectoryResponseData> createDirectory(@PathVariable(name="ehr_id")
                                                                                                                   UUID ehrId,
                                                                                                                   @RequestHeader(name="openEHR-VERSION",required=false)
                                                                                                                   String openEhrVersion,
                                                                                                                   @RequestHeader(name="openEHR-AUDIT_DETAILS",required=false)
                                                                                                                   String openEhrAuditDetails,
                                                                                                                   @RequestHeader(name="Content-Type")
                                                                                                                   String contentType,
                                                                                                                   @RequestHeader(name="Accept",defaultValue="application/json")
                                                                                                                   String accept,
                                                                                                                   @RequestHeader(name="Prefer",defaultValue="return=minimal")
                                                                                                                   String prefer,
                                                                                                                   @RequestBody
                                                                                                                   com.nedap.archie.rm.directory.Folder folder)

Specified by:

createDirectory in interface DirectoryApiSpecification

updateDirectory

@PutMapping(path="/{ehr_id}/directory")
public org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.DirectoryResponseData> updateDirectory(@PathVariable(name="ehr_id")
                                                                                                                   UUID ehrId,
                                                                                                                   @RequestHeader(name="If-Match")
                                                                                                                   com.nedap.archie.rm.support.identification.ObjectVersionId folderId,
                                                                                                                   @RequestHeader(name="Content-Type")
                                                                                                                   String contentType,
                                                                                                                   @RequestHeader(name="Accept",defaultValue="application/json")
                                                                                                                   String accept,
                                                                                                                   @RequestHeader(name="Prefer",defaultValue="return=minimal")
                                                                                                                   String prefer,
                                                                                                                   @RequestHeader(name="openEHR-VERSION",required=false)
                                                                                                                   String openEhrVersion,
                                                                                                                   @RequestHeader(name="openEHR-AUDIT_DETAILS",required=false)
                                                                                                                   String openEhrAuditDetails,
                                                                                                                   @RequestBody
                                                                                                                   com.nedap.archie.rm.directory.Folder folder)

Specified by:

updateDirectory in interface DirectoryApiSpecification

deleteDirectory

@DeleteMapping(path="/{ehr_id}/directory")
public org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.DirectoryResponseData> deleteDirectory(@PathVariable(name="ehr_id")
                                                                                                                   UUID ehrId,
                                                                                                                   @RequestHeader(name="openEHR-VERSION",required=false)
                                                                                                                   String openEhrVersion,
                                                                                                                   @RequestHeader(name="openEHR-AUDIT_DETAILS",required=false)
                                                                                                                   String openEhrAuditDetails,
                                                                                                                   @RequestHeader(name="Accept",defaultValue="application/json")
                                                                                                                   String accept,
                                                                                                                   @RequestHeader(name="If-Match")
                                                                                                                   com.nedap.archie.rm.support.identification.ObjectVersionId folderId)

Specified by:

deleteDirectory in interface DirectoryApiSpecification

getFolderInDirectory

@GetMapping(path="/{ehr_id}/directory/{version_uid}")
public org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.DirectoryResponseData> getFolderInDirectory(@PathVariable(name="ehr_id")
                                                                                                                        UUID ehrId,
                                                                                                                        @PathVariable(name="version_uid")
                                                                                                                        com.nedap.archie.rm.support.identification.ObjectVersionId versionUid,
                                                                                                                        @RequestParam(name="path",required=false)
                                                                                                                        String path,
                                                                                                                        @RequestHeader(name="Accept",defaultValue="application/json")
                                                                                                                        String accept)

Specified by:

getFolderInDirectory in interface DirectoryApiSpecification

getFolderInDirectoryVersionAtTime

@GetMapping(path="/{ehr_id}/directory")
public org.springframework.http.ResponseEntity<org.ehrbase.response.openehr.DirectoryResponseData> getFolderInDirectoryVersionAtTime(@PathVariable(name="ehr_id")
                                                                                                                                     UUID ehrId,
                                                                                                                                     @RequestParam(name="version_at_time",required=false)
                                                                                                                                     String versionAtTime,
                                                                                                                                     @RequestParam(name="path",required=false)
                                                                                                                                     String path,
                                                                                                                                     @RequestHeader(name="Accept",required=false,defaultValue="application/json")
                                                                                                                                     String accept)

Specified by:

getFolderInDirectoryVersionAtTime in interface DirectoryApiSpecification