ca.uhn.fhir.jaxrs.server

Class AbstractJaxRsProvider

java.lang.Object

ca.uhn.fhir.jaxrs.server.AbstractJaxRsProvider

All Implemented Interfaces:

IRestfulServerDefaults

Direct Known Subclasses:

AbstractJaxRsBundleProvider, AbstractJaxRsConformanceProvider, AbstractJaxRsPageProvider, AbstractJaxRsResourceProvider

public abstract class AbstractJaxRsProvider
extends Object
implements IRestfulServerDefaults

This is the abstract superclass for all jaxrs providers. It contains some defaults implementing the IRestfulServerDefaults interface and exposes the uri and headers.

Author:

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJaxRsProvider() Default is DSTU2.
protected	AbstractJaxRsProvider(ca.uhn.fhir.context.FhirContext ctx)

Method Summary

Modifier and Type	Method and Description
ca.uhn.fhir.context.api.AddProfileTagEnum	getAddProfileTag() DEFAULT = AddProfileTagEnum.NEVER
String	getBaseForRequest() This method returns the server base, including the resource path.
String	getBaseForServer() This method returns the server base, independent of the request or resource.
ca.uhn.fhir.rest.api.EncodingEnum	getDefaultResponseEncoding() DEFAULT = EncodingEnum.JSON
ElementsSupportEnum	getElementsSupport() DEFAULT = ElementsSupportEnum.STANDARD
ETagSupportEnum	getETagSupport() DEFAULT = ETagSupportEnum.DISABLED
ca.uhn.fhir.context.FhirContext	getFhirContext()
javax.ws.rs.core.HttpHeaders	getHeaders() Get the headers
List<IServerInterceptor>	getInterceptors_() Default: an empty list of interceptors (Interceptors are not yet supported in the JAX-RS server).
ca.uhn.fhir.interceptor.api.IInterceptorService	getInterceptorService()
IPagingProvider	getPagingProvider() By default, no paging provider is used
Map<String,String[]>	getParameters() This method returns the query parameters
JaxRsRequest.Builder	getRequest(ca.uhn.fhir.rest.api.RequestTypeEnum requestType, ca.uhn.fhir.rest.api.RestOperationTypeEnum restOperation) Return the requestbuilder for the server
JaxRsRequest.Builder	getRequest(ca.uhn.fhir.rest.api.RequestTypeEnum requestType, ca.uhn.fhir.rest.api.RestOperationTypeEnum restOperation, String theResourceName) Return the requestbuilder for the server
IServerAddressStrategy	getServerAddressStrategy() This method returns the default server address strategy.
javax.ws.rs.core.UriInfo	getUriInfo() Get the uriInfo
javax.ws.rs.core.Response	handleException(JaxRsRequest theRequest, Throwable theException) Convert an exception to a response
boolean	isDefaultPrettyPrint() DEFAULT = true
void	setHeaders(javax.ws.rs.core.HttpHeaders headers) Set the headers
void	setUriInfo(javax.ws.rs.core.UriInfo uriInfo) Set the Uri Info
boolean	withStackTrace() DEFAULT = false

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJaxRsProvider

protected AbstractJaxRsProvider()

Default is DSTU2. Use AbstractJaxRsProvider(FhirContext) to specify a DSTU3 context.

AbstractJaxRsProvider

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

Parameters:

ctx - the FhirContext to support.

Method Detail

getInterceptorService

public ca.uhn.fhir.interceptor.api.IInterceptorService getInterceptorService()

Specified by:

getInterceptorService in interface IRestfulServerDefaults

getAddProfileTag

public ca.uhn.fhir.context.api.AddProfileTagEnum getAddProfileTag()

DEFAULT = AddProfileTagEnum.NEVER

Specified by:

getAddProfileTag in interface IRestfulServerDefaults

getBaseForRequest

public String getBaseForRequest()

This method returns the server base, including the resource path. UriInfo#getBaseUri()

Returns:

the ascii string for the base resource provider path

getBaseForServer

public String getBaseForServer()

This method returns the server base, independent of the request or resource.

Returns:

the ascii string for the server base

See Also:

UriInfo.getBaseUri()

getDefaultResponseEncoding

public ca.uhn.fhir.rest.api.EncodingEnum getDefaultResponseEncoding()

DEFAULT = EncodingEnum.JSON

Specified by:

getDefaultResponseEncoding in interface IRestfulServerDefaults

getETagSupport

public ETagSupportEnum getETagSupport()

DEFAULT = ETagSupportEnum.DISABLED

Specified by:

getETagSupport in interface IRestfulServerDefaults

getElementsSupport

public ElementsSupportEnum getElementsSupport()

DEFAULT = ElementsSupportEnum.STANDARD

Specified by:

getElementsSupport in interface IRestfulServerDefaults

getFhirContext

public ca.uhn.fhir.context.FhirContext getFhirContext()

Specified by:

getFhirContext in interface IRestfulServerDefaults

getHeaders

public javax.ws.rs.core.HttpHeaders getHeaders()

Get the headers

Returns:

the headers

getInterceptors_

public List<IServerInterceptor> getInterceptors_()

Default: an empty list of interceptors (Interceptors are not yet supported in the JAX-RS server). Please get in touch if you'd like to help!

Specified by:

getInterceptors_ in interface IRestfulServerDefaults

See Also:

IRestfulServerDefaults.getInterceptors_()

getPagingProvider

public IPagingProvider getPagingProvider()

By default, no paging provider is used

Specified by:

getPagingProvider in interface IRestfulServerDefaults

getParameters

public Map<String,String[]> getParameters()

This method returns the query parameters

Returns:

the query parameters

getRequest

public JaxRsRequest.Builder getRequest(ca.uhn.fhir.rest.api.RequestTypeEnum requestType,
                                       ca.uhn.fhir.rest.api.RestOperationTypeEnum restOperation)

Return the requestbuilder for the server

Parameters:

requestType - the type of the request

restOperation - the rest operation type

Returns:

the requestbuilder

getRequest

public JaxRsRequest.Builder getRequest(ca.uhn.fhir.rest.api.RequestTypeEnum requestType,
                                       ca.uhn.fhir.rest.api.RestOperationTypeEnum restOperation,
                                       String theResourceName)

Return the requestbuilder for the server

Parameters:

requestType - the type of the request

restOperation - the rest operation type

theResourceName - the resource name

Returns:

the requestbuilder

getServerAddressStrategy

public IServerAddressStrategy getServerAddressStrategy()

This method returns the default server address strategy. The default strategy return the base uri for the request getBaseForRequest()

Returns:

getUriInfo

public javax.ws.rs.core.UriInfo getUriInfo()

Get the uriInfo

Returns:

the uri info

handleException

public javax.ws.rs.core.Response handleException(JaxRsRequest theRequest,
                                                 Throwable theException)
                                          throws IOException

Convert an exception to a response

Parameters:

theRequest - the incoming request

theException - the exception to convert

Returns:

response

Throws:

IOException

isDefaultPrettyPrint

public boolean isDefaultPrettyPrint()

DEFAULT = true

Specified by:

isDefaultPrettyPrint in interface IRestfulServerDefaults

setHeaders

public void setHeaders(javax.ws.rs.core.HttpHeaders headers)

Set the headers

Parameters:

headers - the headers to set

setUriInfo

public void setUriInfo(javax.ws.rs.core.UriInfo uriInfo)

Set the Uri Info

Parameters:

uriInfo - the uri info

withStackTrace

public boolean withStackTrace()

DEFAULT = false