Package ca.uhn.fhir.jaxrs.server

Class AbstractJaxRsResourceProvider<R extends org.hl7.fhir.instance.model.api.IBaseResource>

java.lang.Object

ca.uhn.fhir.jaxrs.server.AbstractJaxRsProvider

ca.uhn.fhir.jaxrs.server.AbstractJaxRsResourceProvider<R>

All Implemented Interfaces:

ca.uhn.fhir.rest.api.server.IRestfulServer<JaxRsRequest>, ca.uhn.fhir.rest.server.IResourceProvider, ca.uhn.fhir.rest.server.IRestfulServerDefaults

@Produces({"application/json","application/xml","text/plain","application/json+fhir","application/xml+fhir"})
@Consumes({"application/x-www-form-urlencoded","application/json","application/json+fhir","application/xml+fhir","application/fhir+json","application/fhir+xml","application/octet-stream"})
public abstract class AbstractJaxRsResourceProvider<R extends org.hl7.fhir.instance.model.api.IBaseResource>
extends AbstractJaxRsProvider
implements ca.uhn.fhir.rest.api.server.IRestfulServer<JaxRsRequest>, ca.uhn.fhir.rest.server.IResourceProvider

This server is the abstract superclass for all resource providers. It exposes a large amount of the fhir api functionality using JAXRS

Author:

Peter Van Houte | peter.vanhoute@agfa.com | Agfa Healthcare

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractJaxRsResourceProvider()	The default constructor.
protected	AbstractJaxRsResourceProvider(ca.uhn.fhir.context.FhirContext ctx)	Provides the ability to specify the FhirContext.
protected	AbstractJaxRsResourceProvider(ca.uhn.fhir.context.FhirContext ctx, Class<? extends AbstractJaxRsProvider> theProviderClass)	This constructor takes in an explicit interface class.
protected	AbstractJaxRsResourceProvider(Class<? extends AbstractJaxRsProvider> theProviderClass)	This constructor takes in an explicit interface class.

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	conditionalUpdate(String resource)	Update an existing resource based on the given condition
jakarta.ws.rs.core.Response	create(String resource)	Create a new resource with a server assigned id
protected jakarta.ws.rs.core.Response	customOperation(String resource, ca.uhn.fhir.rest.api.RequestTypeEnum requestType, String id, String operationName, ca.uhn.fhir.rest.api.RestOperationTypeEnum operationType)	Execute a custom operation
jakarta.ws.rs.core.Response	delete()	Delete a resource based on the given condition
jakarta.ws.rs.core.Response	delete(String id)	Delete a resource
jakarta.ws.rs.core.Response	find(String id)	Read the current state of the resource
jakarta.ws.rs.core.Response	findCompartment(String id, String compartment)	Compartment Based Access
jakarta.ws.rs.core.Response	findVersion(String id, String version)	Retrieve a version of a resource
String	getBaseForRequest()	The base for request for a resource provider has the following form: getBaseForServer() + "/" + getResourceType() .getSimpleName()
protected ca.uhn.fhir.rest.server.method.BaseMethodBinding	getBinding(ca.uhn.fhir.rest.api.RestOperationTypeEnum restOperation, String theBindingKey)	Return the method binding for the given rest operation
JaxRsMethodBindings	getBindings()	Return the bindings defined in this resource provider
ca.uhn.fhir.context.api.BundleInclusionRule	getBundleInclusionRule()	Default: BundleInclusionRule.BASED_ON_INCLUDES
ca.uhn.fhir.rest.api.PreferReturnEnum	getDefaultPreferReturn()
ca.uhn.fhir.rest.server.IPagingProvider	getPagingProvider()	Default: no paging provider
abstract Class<R>	getResourceType()	The resource type should return conform to the generic resource included in the topic
jakarta.ws.rs.core.Response	historyForInstance(String id)	Retrieve the update history for a particular resource
jakarta.ws.rs.core.Response	historyForType()	Retrieve the update history for a particular type
jakarta.ws.rs.core.Response	search()	Search the resource type based on some filter criteria
jakarta.ws.rs.core.Response	searchWithPost()	Search the resource type based on some filter criteria
jakarta.ws.rs.core.Response	update(String id, String resource)	Update an existing resource by its id (or create it if it is new)
jakarta.ws.rs.core.Response	validate(String resource)

Methods inherited from class ca.uhn.fhir.jaxrs.server.AbstractJaxRsProvider

getAddProfileTag, getBaseForServer, getDefaultResponseEncoding, getElementsSupport, getETagSupport, getFhirContext, getHeaders, getInterceptors_, getInterceptorService, getParameters, getRequest, getRequest, getServerAddressStrategy, getUriInfo, handleException, isDefaultPrettyPrint, setHeaders, setUriInfo, withStackTrace

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.fhir.rest.api.server.IRestfulServer

canStoreSearchResults

Methods inherited from interface ca.uhn.fhir.rest.server.IRestfulServerDefaults

getAddProfileTag, getDefaultPageSize, getDefaultResponseEncoding, getElementsSupport, getETagSupport, getFhirContext, getInterceptors_, getInterceptorService, getMaximumPageSize, isDefaultPrettyPrint

Constructor Details

AbstractJaxRsResourceProvider

protected AbstractJaxRsResourceProvider()

The default constructor. The method bindings are retrieved from the class being constructed.

AbstractJaxRsResourceProvider

protected AbstractJaxRsResourceProvider(ca.uhn.fhir.context.FhirContext ctx)

Provides the ability to specify the FhirContext.

Parameters:

ctx - the FhirContext instance.

AbstractJaxRsResourceProvider

protected AbstractJaxRsResourceProvider(Class<? extends AbstractJaxRsProvider> theProviderClass)

This constructor takes in an explicit interface class. This subclass should be identical to the class being constructed but is given explicitly in order to avoid issues with proxy classes in a jee environment.

Parameters:

theProviderClass - the interface of the class

AbstractJaxRsResourceProvider

protected AbstractJaxRsResourceProvider(ca.uhn.fhir.context.FhirContext ctx,
 Class<? extends AbstractJaxRsProvider> theProviderClass)

This constructor takes in an explicit interface class. This subclass should be identical to the class being constructed but is given explicitly in order to avoid issues with proxy classes in a jee environment.

Parameters:

ctx - the FhirContext instance.

theProviderClass - the interface of the class

Method Details

getBaseForRequest

public String getBaseForRequest()

The base for request for a resource provider has the following form:
getBaseForServer() + "/" + getResourceType() .getSimpleName()

Overrides:

getBaseForRequest in class AbstractJaxRsProvider

Returns:

the ascii string for the base resource provider path

create

@POST
public jakarta.ws.rs.core.Response create(String resource)
                                   throws IOException

Create a new resource with a server assigned id

Parameters:

resource - the body of the post method containing resource being created in a xml/json form

Returns:

the response

Throws:

IOException

See Also:

• https://www.hl7. org/fhir/http.html#create

searchWithPost

@POST
@Path("/_search")
public jakarta.ws.rs.core.Response searchWithPost()
                                           throws IOException

Search the resource type based on some filter criteria

Returns:

the response

Throws:

IOException

See Also:

• https://www.hl7.org/fhir/http.html#search

search

@GET
public jakarta.ws.rs.core.Response search()
                                   throws IOException

Search the resource type based on some filter criteria

Returns:

the response

Throws:

IOException

See Also:

• https://www.hl7.org/fhir/http.html#search

conditionalUpdate

@PUT
public jakarta.ws.rs.core.Response conditionalUpdate(String resource)
                                              throws IOException

Update an existing resource based on the given condition

Parameters:

resource - the body contents for the put method

Returns:

the response

Throws:

IOException

See Also:

• https://www.hl7.org/fhir/http.html#update

update

@PUT
@Path("/{id}")
public jakarta.ws.rs.core.Response update(@PathParam("id")
 String id,
 String resource)
                                   throws IOException

Update an existing resource by its id (or create it if it is new)

Parameters:

id - the id of the resource

resource - the body contents for the put method

Returns:

the response

Throws:

IOException

See Also:

• https://www.hl7.org/fhir/http.html#update

delete

@DELETE
public jakarta.ws.rs.core.Response delete()
                                   throws IOException

Delete a resource based on the given condition

Returns:

the response

Throws:

IOException

See Also:

• https://www.hl7.org/fhir/http.html#delete

delete

@DELETE
@Path("/{id}")
public jakarta.ws.rs.core.Response delete(@PathParam("id")
 String id)
                                   throws IOException

Delete a resource

Parameters:

id - the id of the resource to delete

Returns:

the response

Throws:

IOException

See Also:

• https://www.hl7.org/fhir/http.html#delete

find

@GET
@Path("/{id : ((?!_history).)*}")
public jakarta.ws.rs.core.Response find(@PathParam("id")
 String id)
                                 throws IOException

Read the current state of the resource

Parameters:

id - the id of the resource to read

Returns:

the response

Throws:

IOException

See Also:

• https://www.hl7.org/fhir/http.html#read

customOperation

protected jakarta.ws.rs.core.Response customOperation(String resource,
 ca.uhn.fhir.rest.api.RequestTypeEnum requestType,
 String id,
 String operationName,
 ca.uhn.fhir.rest.api.RestOperationTypeEnum operationType)
                                               throws IOException

Execute a custom operation

Parameters:

resource - the resource to create

requestType - the type of request

id - the id of the resource on which to perform the operation

operationName - the name of the operation to execute

operationType - the rest operation type

Returns:

the response

Throws:

IOException

See Also:

• https://www.hl7.org/fhir/operations.html

findVersion

@GET
@Path("/{id}/_history/{version}")
public jakarta.ws.rs.core.Response findVersion(@PathParam("id")
 String id,
 @PathParam("version")
 String version)
                                        throws IOException

Retrieve a version of a resource

Parameters:

id - the id of the resource

version - the version of the resource

Returns:

the response

Throws:

IOException

See Also:

• https://www.hl7.org/fhir/http.html#history

historyForInstance

@GET
@Path("/{id}/_history")
public jakarta.ws.rs.core.Response historyForInstance(@PathParam("id")
 String id)
                                               throws IOException

Retrieve the update history for a particular resource

Parameters:

id - the id of the resource

Returns:

the response

Throws:

IOException

See Also:

• https://www.hl7.org/fhir/http.html#history

historyForType

@GET
@Path("/_history")
public jakarta.ws.rs.core.Response historyForType()
                                           throws IOException

Retrieve the update history for a particular type

Returns:

the response

Throws:

IOException

See Also:

• https://www.hl7.org/fhir/http.html#history

findCompartment

@GET
@Path("/{id}/{compartment : ((?!_history).)*}")
public jakarta.ws.rs.core.Response findCompartment(@PathParam("id")
 String id,
 @PathParam("compartment")
 String compartment)
                                            throws IOException

Compartment Based Access

Parameters:

id - the resource to which the compartment belongs

compartment - the compartment

Returns:

the repsonse

Throws:

IOException

See Also:

• https://www.hl7.org/fhir/http.html#search
• https://www.hl7.org/fhir/compartments.html#compartment

validate

@POST
@Path("/$validate")
public jakarta.ws.rs.core.Response validate(String resource)
                                     throws IOException

Throws:

IOException

getBinding

protected ca.uhn.fhir.rest.server.method.BaseMethodBinding getBinding(ca.uhn.fhir.rest.api.RestOperationTypeEnum restOperation,
 String theBindingKey)

Return the method binding for the given rest operation

Parameters:

restOperation - the rest operation to retrieve

theBindingKey - the key determining the method to be executed (needed for e.g. custom operation)

Returns:

getPagingProvider

public ca.uhn.fhir.rest.server.IPagingProvider getPagingProvider()

Default: no paging provider

Specified by:

getPagingProvider in interface ca.uhn.fhir.rest.api.server.IRestfulServer<R extends org.hl7.fhir.instance.model.api.IBaseResource>

Specified by:

getPagingProvider in interface ca.uhn.fhir.rest.server.IRestfulServerDefaults

Overrides:

getPagingProvider in class AbstractJaxRsProvider

getBundleInclusionRule

public ca.uhn.fhir.context.api.BundleInclusionRule getBundleInclusionRule()

Default: BundleInclusionRule.BASED_ON_INCLUDES

Specified by:

getBundleInclusionRule in interface ca.uhn.fhir.rest.api.server.IRestfulServer<R extends org.hl7.fhir.instance.model.api.IBaseResource>

getDefaultPreferReturn

public ca.uhn.fhir.rest.api.PreferReturnEnum getDefaultPreferReturn()

Specified by:

getDefaultPreferReturn in interface ca.uhn.fhir.rest.api.server.IRestfulServer<R extends org.hl7.fhir.instance.model.api.IBaseResource>

getResourceType

public abstract Class<R> getResourceType()

The resource type should return conform to the generic resource included in the topic

Specified by:

getResourceType in interface ca.uhn.fhir.rest.server.IResourceProvider

getBindings

public JaxRsMethodBindings getBindings()

Return the bindings defined in this resource provider

Returns:

the jax-rs method bindings