Package com.ibm.fhir.server.rest

Interface FHIRRestInteractionVisitor

All Known Implementing Classes:

FHIRRestInteractionVisitorBase, FHIRRestInteractionVisitorMeta, FHIRRestInteractionVisitorPersist, FHIRRestInteractionVisitorReferenceMapping

public interface FHIRRestInteractionVisitor

Defines operations which can be performed on the persistence layer

Method Summary

Modifier and Type	Method	Description
FHIRRestOperationResponse	doCreate(int entryIndex, FHIRPersistenceEvent event, List<OperationOutcome.Issue> warnings, Bundle.Entry validationResponseEntry, String requestDescription, FHIRUrlParser requestURL, long initialTime, String type, Resource resource, String ifNoneExist, String localIdentifier)	Performs the heavy lifting associated with a 'create' interaction.
FHIRRestOperationResponse	doDelete(int entryIndex, String requestDescription, FHIRUrlParser requestURL, long initialTime, String type, String id, String searchQueryString)	Performs a 'delete' operation on the specified resource.
FHIRRestOperationResponse	doHistory(int entryIndex, String requestDescription, FHIRUrlParser requestURL, long initialTime, String type, String id, javax.ws.rs.core.MultivaluedMap<String,String> queryParameters, String requestUri)	Performs the work of retrieving versions of a Resource.
FHIRRestOperationResponse	doInvoke(String method, int entryIndex, Bundle.Entry validationResponseEntry, String requestDescription, FHIRUrlParser requestURL, long initialTime, FHIROperationContext operationContext, String resourceTypeName, String logicalId, String versionId, Resource resource, javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)	Helper method which invokes a custom operation.
FHIRRestOperationResponse	doPatch(int entryIndex, FHIRPersistenceEvent event, Bundle.Entry validationResponseEntry, String requestDescription, FHIRUrlParser requestURL, long initialTime, String type, String id, Resource newResource, Resource prevResource, FHIRPatch patch, String ifMatchValue, String searchQueryString, boolean skippableUpdate, List<OperationOutcome.Issue> warnings, String localIdentifier)	Performs a patch operation (a new version of the Resource will be stored).
FHIRRestOperationResponse	doRead(int entryIndex, String requestDescription, FHIRUrlParser requestURL, long initialTime, String type, String id, boolean throwExcOnNull, boolean includeDeleted, Resource contextResource, javax.ws.rs.core.MultivaluedMap<String,String> queryParameters, boolean checkInteractionAllowed)	Performs a 'read' operation to retrieve a Resource.
FHIRRestOperationResponse	doSearch(int entryIndex, String requestDescription, FHIRUrlParser requestURL, long initialTime, String type, String compartment, String compartmentId, javax.ws.rs.core.MultivaluedMap<String,String> queryParameters, String requestUri, Resource contextResource, boolean checkInteractionAllowed)	Performs heavy lifting associated with a 'search' operation.
FHIRRestOperationResponse	doUpdate(int entryIndex, FHIRPersistenceEvent event, Bundle.Entry validationResponseEntry, String requestDescription, FHIRUrlParser requestURL, long initialTime, String type, String id, Resource newResource, Resource prevResource, String ifMatchValue, String searchQueryString, boolean skippableUpdate, String localIdentifier, List<OperationOutcome.Issue> warnings, boolean isDeleted, Integer ifNoneMatch)	Performs an update operation (a new version of the Resource will be stored).
FHIRRestOperationResponse	doVRead(int entryIndex, String requestDescription, FHIRUrlParser requestURL, long initialTime, String type, String id, String versionId, javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)	Performs a 'vread' operation by retrieving the specified version of a Resource with no query parameters
FHIRRestOperationResponse	issue(int entryIndex, String requestDescription, long initialTime, javax.ws.rs.core.Response.Status status, Bundle.Entry responseEntry)	Add the issue to the result bundle
FHIRRestOperationResponse	validationResponse(int entryIndex, Bundle.Entry validationResponseEntry, String requestDescription, long initialTime)	Add the given validationResponseEntry to the result bundle

Method Detail

doSearch

FHIRRestOperationResponse doSearch(int entryIndex,
                                   String requestDescription,
                                   FHIRUrlParser requestURL,
                                   long initialTime,
                                   String type,
                                   String compartment,
                                   String compartmentId,
                                   javax.ws.rs.core.MultivaluedMap<String,String> queryParameters,
                                   String requestUri,
                                   Resource contextResource,
                                   boolean checkInteractionAllowed)
                            throws Exception

Performs heavy lifting associated with a 'search' operation.

Parameters:

entryIndex -

requestDescription -

requestURL -

initialTime -

type - the resource type associated with the search

compartment - the compartment type to search in, or null if not a compartment search

compartmentId - the specific compartment to search in, or null if not a compartment search

queryParameters - a Map containing the query parameters from the request URL

requestUri - the request URI

contextResource - the resource context

checkIfInteractionAllowed - if true, check that the search interaction is permitted

Returns:

a FHIRRestOperationResponse containing the search result bundle

Throws:

Exception

doVRead

FHIRRestOperationResponse doVRead(int entryIndex,
                                  String requestDescription,
                                  FHIRUrlParser requestURL,
                                  long initialTime,
                                  String type,
                                  String id,
                                  String versionId,
                                  javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)
                           throws Exception

Performs a 'vread' operation by retrieving the specified version of a Resource with no query parameters

Parameters:

entryIndex -

requestDescription -

requestURL -

initialTime -

type - the resource type associated with the Resource to be retrieved

id - the id of the Resource to be retrieved

versionId - the version id of the Resource to be retrieved

queryParameters -

Returns:

the Resource

Throws:

Exception

doRead

FHIRRestOperationResponse doRead(int entryIndex,
                                 String requestDescription,
                                 FHIRUrlParser requestURL,
                                 long initialTime,
                                 String type,
                                 String id,
                                 boolean throwExcOnNull,
                                 boolean includeDeleted,
                                 Resource contextResource,
                                 javax.ws.rs.core.MultivaluedMap<String,String> queryParameters,
                                 boolean checkInteractionAllowed)
                          throws Exception

Performs a 'read' operation to retrieve a Resource.

Parameters:

entryIndex -

requestDescription -

requestURL -

initialTime -

type - the resource type associated with the Resource to be retrieved

id - the id of the Resource to be retrieved

throwExcOnNull - whether to throw an exception on null

includeDeleted - allow the read, even if the resource has been deleted

contextResource - the resource

queryParameters - for supporting _elements and _summary for resource read

Returns:

a SingleResourceResult wrapping the resource and including its deletion status

Throws:

Exception

doHistory

FHIRRestOperationResponse doHistory(int entryIndex,
                                    String requestDescription,
                                    FHIRUrlParser requestURL,
                                    long initialTime,
                                    String type,
                                    String id,
                                    javax.ws.rs.core.MultivaluedMap<String,String> queryParameters,
                                    String requestUri)
                             throws Exception

Performs the work of retrieving versions of a Resource.

Parameters:

entryIndex -

requestDescription -

requestURL -

initialTime -

type - the resource type associated with the Resource to be retrieved

id - the id of the Resource to be retrieved

queryParameters - a Map containing the query parameters from the request URL

requestUri -

Returns:

a Bundle containing the history of the specified Resource

Throws:

Exception

doCreate

FHIRRestOperationResponse doCreate(int entryIndex,
                                   FHIRPersistenceEvent event,
                                   List<OperationOutcome.Issue> warnings,
                                   Bundle.Entry validationResponseEntry,
                                   String requestDescription,
                                   FHIRUrlParser requestURL,
                                   long initialTime,
                                   String type,
                                   Resource resource,
                                   String ifNoneExist,
                                   String localIdentifier)
                            throws Exception

Performs the heavy lifting associated with a 'create' interaction.

Parameters:

entryIndex -

event -

warnings - the list of warning issues accumulated for this entry

validationResponseEntry -

requestDescription -

requestURL -

initialTime -

type - the resource type specified as part of the request URL

resource - the Resource to be stored.

ifNoneExist - whether to create the resource if none exists

localIdentifier -

Returns:

a FHIRRestOperationResponse object containing the results of the operation

Throws:

Exception

doUpdate

FHIRRestOperationResponse doUpdate(int entryIndex,
                                   FHIRPersistenceEvent event,
                                   Bundle.Entry validationResponseEntry,
                                   String requestDescription,
                                   FHIRUrlParser requestURL,
                                   long initialTime,
                                   String type,
                                   String id,
                                   Resource newResource,
                                   Resource prevResource,
                                   String ifMatchValue,
                                   String searchQueryString,
                                   boolean skippableUpdate,
                                   String localIdentifier,
                                   List<OperationOutcome.Issue> warnings,
                                   boolean isDeleted,
                                   Integer ifNoneMatch)
                            throws Exception

Performs an update operation (a new version of the Resource will be stored).

Parameters:

entryIndex -

event - the persistence event used for this resource interaction

validationResponseEntry -

requestDescription -

requestURL -

initialTime -

type -

id - the id of the Resource being updated

newResource - the new resource to be stored

prevResource - the old resource value if we have it

ifMatchValue - an optional "If-Match" header value to request a version-aware update

searchQueryString - an optional search query string to request a conditional update

skippableUpdate - if true, and the resource content in the update matches the existing resource on the server, then skip the update; if false, then always attempt the update

localIdentifier - if not null, represents the local identifier within the bundle used to support local references

warnings - the accumulated list of warnings gathered while processing the interaction

isDeleted - flag to indicate if the resource is currently deleted

ifNoneMatch - conditional create-on-update

Returns:

a FHIRRestOperationResponse that contains the results of the operation

Throws:

Exception

doPatch

FHIRRestOperationResponse doPatch(int entryIndex,
                                  FHIRPersistenceEvent event,
                                  Bundle.Entry validationResponseEntry,
                                  String requestDescription,
                                  FHIRUrlParser requestURL,
                                  long initialTime,
                                  String type,
                                  String id,
                                  Resource newResource,
                                  Resource prevResource,
                                  FHIRPatch patch,
                                  String ifMatchValue,
                                  String searchQueryString,
                                  boolean skippableUpdate,
                                  List<OperationOutcome.Issue> warnings,
                                  String localIdentifier)
                           throws Exception

Performs a patch operation (a new version of the Resource will be stored).

Parameters:

entryIndex -

event - the persistence event used for this resource interaction

validationResponseEntry -

requestDescription -

requestURL -

initialTime -

type - the type of the resource to be updated

id - the id of the Resource being updated

newResource - the latest value of the resource

prevResource - the value of the resource before any changes

patch - the patch to apply

ifMatchValue - an optional "If-Match" header value to request a version-aware update

searchQueryString - an optional search query string to request a conditional update

skippableUpdate - if true, and the result of the patch matches the existing resource on the server, then skip the update; if false, then always attempt the update

warnings -

localIdentifier -

Returns:

a FHIRRestOperationResponse that contains the results of the operation

Throws:

Exception

doInvoke

FHIRRestOperationResponse doInvoke(String method,
                                   int entryIndex,
                                   Bundle.Entry validationResponseEntry,
                                   String requestDescription,
                                   FHIRUrlParser requestURL,
                                   long initialTime,
                                   FHIROperationContext operationContext,
                                   String resourceTypeName,
                                   String logicalId,
                                   String versionId,
                                   Resource resource,
                                   javax.ws.rs.core.MultivaluedMap<String,String> queryParameters)
                            throws Exception

Helper method which invokes a custom operation.

Parameters:

method -

entryIndex -

validationResponseEntry -

requestDescription -

requestUrl -

initialTime -

operationContext - the FHIROperationContext associated with the request

resourceTypeName - the resource type associated with the request

logicalId - the resource logical id associated with the request

versionId - the resource version id associated with the request

resource - the input resource associated with the custom operation to be invoked

queryParameters - query parameters may be passed instead of a Parameters resource for certain custom operations invoked via GET

Returns:

a Resource that represents the response to the custom operation

Throws:

Exception

doDelete

FHIRRestOperationResponse doDelete(int entryIndex,
                                   String requestDescription,
                                   FHIRUrlParser requestURL,
                                   long initialTime,
                                   String type,
                                   String id,
                                   String searchQueryString)
                            throws Exception

Performs a 'delete' operation on the specified resource.

Parameters:

type - the resource type associated with the Resource to be deleted

id - the id of the Resource to be deleted

Returns:

a FHIRRestOperationResponse that contains the results of the operation

Throws:

Exception

validationResponse

FHIRRestOperationResponse validationResponse(int entryIndex,
                                             Bundle.Entry validationResponseEntry,
                                             String requestDescription,
                                             long initialTime)
                                      throws Exception

Add the given validationResponseEntry to the result bundle

Parameters:

entryIndex -

validationResponseEntry -

requestDescription -

initialTime -

Returns:

Throws:

Exception

issue

FHIRRestOperationResponse issue(int entryIndex,
                                String requestDescription,
                                long initialTime,
                                javax.ws.rs.core.Response.Status status,
                                Bundle.Entry responseEntry)
                         throws Exception

Add the issue to the result bundle

Parameters:

entryIndex -

requestDescription -

initialTime -

status -

responseEntry -

Returns:

Throws:

Exception