RestfulServer (HAPI FHIR - Server Framework 3.8.0 API)

java.lang.Object
- javax.servlet.GenericServlet
- - javax.servlet.http.HttpServlet
  - - ca.uhn.fhir.rest.server.RestfulServer

All Implemented Interfaces:

IRestfulServer<ServletRequestDetails>, IRestfulServerDefaults, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
```
public class RestfulServer
extends javax.servlet.http.HttpServlet
implements IRestfulServer<ServletRequestDetails>
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static ETagSupportEnum`	`DEFAULT_ETAG_SUPPORT` Default setting for `ETag Support`: `ETagSupportEnum.ENABLED`
`static ca.uhn.fhir.rest.api.PreferReturnEnum`	`DEFAULT_PREFER_RETURN` Default value for `setDefaultPreferReturn(PreferReturnEnum)`
`static String`	`REQUEST_START_TIME` All incoming requests will have an attribute added to `ServletRequest.getAttribute(String)` with this key.
`static String`	`SERVLET_CONTEXT_ATTRIBUTE` Requests will have an HttpServletRequest attribute set with this name, containing the servlet context, in order to avoid a dependency on Servlet-API 3.0+

Constructor Summary

Constructors
Constructor and Description

RestfulServer()
Constructor.

RestfulServer(ca.uhn.fhir.context.FhirContext theCtx)
Constructor

Constructors
Constructor and Description
`RestfulServer()` Constructor.
`RestfulServer(ca.uhn.fhir.context.FhirContext theCtx)` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addHeadersToResponse(javax.servlet.http.HttpServletResponse theHttpResponse)` This method is called prior to sending a response to incoming requests.
`RestulfulServerConfiguration`	`createConfiguration()`
`protected List<String>`	`createPoweredByAttributes()`
`protected String`	`createPoweredByHeader()` Subclasses may override to provide their own powered by header.
`protected String`	`createPoweredByHeaderComponentName()` Subclasses my override
`protected String`	`createPoweredByHeaderProductName()` Subclasses my override
`protected String`	`createPoweredByHeaderProductVersion()` Subclasses my override
`void`	`destroy()`
`BaseMethodBinding<?>`	`determineResourceMethod(RequestDetails requestDetails, String requestPath)` Figure out and return whichever method binding is appropriate for the given request
`protected void`	`doDelete(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`protected void`	`doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`protected void`	`doOptions(javax.servlet.http.HttpServletRequest theReq, javax.servlet.http.HttpServletResponse theResp)`
`protected void`	`doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`protected void`	`doPut(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`protected static int`	`escapedLength(String theServletPath)` Count length of URL string, but treating unescaped sequences (e.g.
`ca.uhn.fhir.context.api.AddProfileTagEnum`	`getAddProfileTag()` Deprecated. As of HAPI FHIR 1.5, this property has been moved to `FhirContext.setAddProfileTagWhenEncoding(AddProfileTagEnum)`
`ca.uhn.fhir.context.api.BundleInclusionRule`	`getBundleInclusionRule()`
`ca.uhn.fhir.rest.api.PreferReturnEnum`	`getDefaultPreferReturn()` By default, server create/update/patch/transaction methods return a copy of the resource as it was stored.
`ca.uhn.fhir.rest.api.EncodingEnum`	`getDefaultResponseEncoding()` Returns the default encoding to return (XML/JSON) if an incoming request does not specify a preference (either with the `_format` URL parameter, or with an `Accept` header in the request.
`ElementsSupportEnum`	`getElementsSupport()`
`ETagSupportEnum`	`getETagSupport()`
`ca.uhn.fhir.context.FhirContext`	`getFhirContext()` Gets the `FhirContext` associated with this server.
`String`	`getImplementationDescription()`
`List<IServerInterceptor>`	`getInterceptors_()` Deprecated. As of HAPI FHIR 3.8.0, use `getInterceptorService()` to access the interceptor service. You can register and unregister interceptors using this service.
`ca.uhn.fhir.interceptor.api.IInterceptorService`	`getInterceptorService()` Returns the interceptor registry for this service.
`IPagingProvider`	`getPagingProvider()` Returns the paging provider for this server
`Collection<Object>`	`getPlainProviders()` Provides the non-resource specific providers which implement method calls on this server
`protected String`	`getRequestPath(String requestFullPath, String servletContextPath, String servletPath)` Allows users of RestfulServer to override the getRequestPath method to let them build their custom request path implementation
`Collection<ResourceBinding>`	`getResourceBindings()`
`Collection<IResourceProvider>`	`getResourceProviders()` Provides the resource providers for this server
`IServerAddressStrategy`	`getServerAddressStrategy()` Get the server address strategy, which is used to determine what base URL to provide clients to refer to this server.
`String`	`getServerBaseForRequest(ServletRequestDetails theRequest)` Returns the server base URL (with no trailing '/') for a given request
`List<BaseMethodBinding<?>>`	`getServerBindings()` Returns the method bindings for this server which are not specific to any particular resource type.
`Object`	`getServerConformanceProvider()` Returns the server conformance provider, which is the provider that is used to generate the server's conformance (metadata) statement if one has been explicitly defined.
`String`	`getServerName()` Gets the server's name, as exported in conformance profiles exported by the server.
`IResourceProvider`	`getServerProfilesProvider()`
`String`	`getServerVersion()` Gets the server's version, as exported in conformance profiles exported by the server.
`protected void`	`handleRequest(ca.uhn.fhir.rest.api.RequestTypeEnum theRequestType, javax.servlet.http.HttpServletRequest theRequest, javax.servlet.http.HttpServletResponse theResponse)`
`void`	`init()` Initializes the server.
`protected void`	`initialize()` This method may be overridden by subclasses to do perform initialization that needs to be performed prior to the server being used.
`boolean`	`isDefaultPrettyPrint()` Should the server "pretty print" responses by default (requesting clients can always override this default by supplying an `Accept` header in the request, or a `_pretty` parameter in the request URL.
`boolean`	`isIgnoreServerParsedRequestParameters()` If set to `true` (the default is `true`) this server will not use the parsed request parameters (URL parameters and HTTP POST form contents) but will instead parse these values manually from the request URL and request body.
`boolean`	`isUncompressIncomingContents()` Should the server attempt to decompress incoming request contents (default is `true`).
`void`	`populateRequestDetailsFromRequestPath(RequestDetails theRequestDetails, String theRequestPath)`
`void`	`registerInterceptor(Object theInterceptor)` Registers an interceptor.
`void`	`registerProvider(Object provider)` Register a single provider.
`void`	`registerProviders(Collection<?> theProviders)` Register a group of theProviders.
`protected void`	`registerProviders(Collection<?> theProviders, boolean inInit)`
`void`	`registerProviders(Object... theProviders)` Register a group of providers.
`Object`	`returnResponse(ServletRequestDetails theRequest, ParseAction<?> outcome, int operationStatus, boolean allowPrefer, ca.uhn.fhir.rest.api.MethodOutcome response, String resourceName)`
`protected void`	`service(javax.servlet.http.HttpServletRequest theReq, javax.servlet.http.HttpServletResponse theResp)`
`void`	`setAddProfileTag(ca.uhn.fhir.context.api.AddProfileTagEnum theAddProfileTag)` Deprecated. As of HAPI FHIR 1.5, this property has been moved to `FhirContext.setAddProfileTagWhenEncoding(AddProfileTagEnum)`
`void`	`setBundleInclusionRule(ca.uhn.fhir.context.api.BundleInclusionRule theBundleInclusionRule)` Set how bundle factory should decide whether referenced resources should be included in bundles
`void`	`setDefaultPreferReturn(ca.uhn.fhir.rest.api.PreferReturnEnum theDefaultPreferReturn)` By default, server create/update/patch/transaction methods return a copy of the resource as it was stored.
`void`	`setDefaultPrettyPrint(boolean theDefaultPrettyPrint)` Should the server "pretty print" responses by default (requesting clients can always override this default by supplying an `Accept` header in the request, or a `_pretty` parameter in the request URL.
`void`	`setDefaultResponseEncoding(ca.uhn.fhir.rest.api.EncodingEnum theDefaultResponseEncoding)` Sets the default encoding to return (XML/JSON) if an incoming request does not specify a preference (either with the `_format` URL parameter, or with an `Accept` header in the request.
`void`	`setElementsSupport(ElementsSupportEnum theElementsSupport)` Sets the elements support mode.
`void`	`setETagSupport(ETagSupportEnum theETagSupport)` Sets (enables/disables) the server support for ETags.
`void`	`setFhirContext(ca.uhn.fhir.context.FhirContext theFhirContext)`
`void`	`setIgnoreServerParsedRequestParameters(boolean theIgnoreServerParsedRequestParameters)` If set to `true` (the default is `true`) this server will not use the parsed request parameters (URL parameters and HTTP POST form contents) but will instead parse these values manually from the request URL and request body.
`void`	`setImplementationDescription(String theImplementationDescription)`
`void`	`setInterceptors(IServerInterceptor... theInterceptors)` Deprecated. As of HAPI FHIR 3.8.0, use `getInterceptorService()` to access the interceptor service. You can register and unregister interceptors using this service.
`void`	`setInterceptors(List<?> theList)` Deprecated. As of HAPI FHIR 3.8.0, use `getInterceptorService()` to access the interceptor service. You can register and unregister interceptors using this service.
`void`	`setInterceptorService(ca.uhn.fhir.interceptor.api.IInterceptorService theInterceptorService)` Sets the interceptor registry for this service.
`void`	`setPagingProvider(IPagingProvider thePagingProvider)` Sets the paging provider to use, or `null` to use no paging (which is the default)
`void`	`setPlainProviders(Collection<Object> theProviders)` Deprecated. This method causes inconsistent behaviour depending on the order it is called in. Use `registerProviders(Object...)` instead.
`void`	`setPlainProviders(Object... theProv)` Deprecated. This method causes inconsistent behaviour depending on the order it is called in. Use `registerProviders(Object...)` instead.
`void`	`setProviders(Object... theProviders)` Sets the non-resource specific providers which implement method calls on this server
`void`	`setResourceProviders(Collection<IResourceProvider> theProviders)` Sets the resource providers for this server
`void`	`setResourceProviders(IResourceProvider... theResourceProviders)` Sets the resource providers for this server
`void`	`setServerAddressStrategy(IServerAddressStrategy theServerAddressStrategy)` Provide a server address strategy, which is used to determine what base URL to provide clients to refer to this server.
`void`	`setServerConformanceProvider(Object theServerConformanceProvider)` Returns the server conformance provider, which is the provider that is used to generate the server's conformance (metadata) statement.
`void`	`setServerName(String theServerName)` Sets the server's name, as exported in conformance profiles exported by the server.
`void`	`setServerVersion(String theServerVersion)` Gets the server's version, as exported in conformance profiles exported by the server.
`void`	`setTenantIdentificationStrategy(ITenantIdentificationStrategy theTenantIdentificationStrategy)` If provided (default is `null`), the tenant identification strategy provides a mechanism for a multitenant server to identify which tenant a given request corresponds to.
`void`	`setUncompressIncomingContents(boolean theUncompressIncomingContents)` Should the server attempt to decompress incoming request contents (default is `true`).
`protected void`	`throwUnknownFhirOperationException(RequestDetails requestDetails, String requestPath, ca.uhn.fhir.rest.api.RequestTypeEnum theRequestType)`
`static void`	`throwUnknownFhirOperationException(RequestDetails requestDetails, String requestPath, ca.uhn.fhir.rest.api.RequestTypeEnum theRequestType, ca.uhn.fhir.context.FhirContext theFhirContext)`
`protected void`	`throwUnknownResourceTypeException(String theResourceName)`
`void`	`unregisterInterceptor(Object theInterceptor)` Unregisters an interceptor.
`void`	`unregisterProvider(Object provider)` Unregister one provider (either a Resource provider or a plain provider)
`void`	`unregisterProviders(Collection<?> providers)` Unregister a `Collection` of providers
`protected void`	`validateRequest(ServletRequestDetails theRequestDetails)`

Methods inherited from class javax.servlet.http.HttpServlet
doHead, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet
getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - REQUEST_START_TIME
```
public static final String REQUEST_START_TIME
```
    All incoming requests will have an attribute added to ServletRequest.getAttribute(String) with this key. The value will be a Java Date with the time that request processing began.
  - DEFAULT_ETAG_SUPPORT
```
public static final ETagSupportEnum DEFAULT_ETAG_SUPPORT
```
    Default setting for ETag Support: ETagSupportEnum.ENABLED
  - SERVLET_CONTEXT_ATTRIBUTE
```
public static final String SERVLET_CONTEXT_ATTRIBUTE
```
    Requests will have an HttpServletRequest attribute set with this name, containing the servlet context, in order to avoid a dependency on Servlet-API 3.0+
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PREFER_RETURN
```
public static final ca.uhn.fhir.rest.api.PreferReturnEnum DEFAULT_PREFER_RETURN
```
    Default value for setDefaultPreferReturn(PreferReturnEnum)
- Constructor Detail
  - RestfulServer
```
public RestfulServer()
```
    Constructor. Note that if no FhirContext is passed in to the server (either through the constructor, or through setFhirContext(FhirContext)) the server will determine which version of FHIR to support through classpath scanning. This is brittle, and it is highly recommended to explicitly specify a FHIR version.
  - RestfulServer
```
public RestfulServer(ca.uhn.fhir.context.FhirContext theCtx)
```
    Constructor
- Method Detail
  - addHeadersToResponse
```
public void addHeadersToResponse(javax.servlet.http.HttpServletResponse theHttpResponse)
```
    This method is called prior to sending a response to incoming requests. It is used to add custom headers.
    Use caution if overriding this method: it is recommended to call super.addHeadersToResponse to avoid inadvertently disabling functionality.
  - createConfiguration
```
public RestulfulServerConfiguration createConfiguration()
```
  - createPoweredByAttributes
```
protected List<String> createPoweredByAttributes()
```
  - createPoweredByHeader
```
protected String createPoweredByHeader()
```
    Subclasses may override to provide their own powered by header. Note that if you want to be nice and still credit HAPI FHIR you could consider overriding createPoweredByAttributes() instead and adding your own fragments to the list.
  - createPoweredByHeaderComponentName
```
protected String createPoweredByHeaderComponentName()
```
    Subclasses my override
    
    See Also:
    
    createPoweredByHeader()
  - createPoweredByHeaderProductName
```
protected String createPoweredByHeaderProductName()
```
    Subclasses my override
    
    See Also:
    
    createPoweredByHeader()
  - createPoweredByHeaderProductVersion
```
protected String createPoweredByHeaderProductVersion()
```
    Subclasses my override
    
    See Also:
    
    createPoweredByHeader()
  - destroy
```
public void destroy()
```
    Specified by:
    
    destroy in interface javax.servlet.Servlet
    
    Overrides:
    
    destroy in class javax.servlet.GenericServlet
  - determineResourceMethod
```
public BaseMethodBinding<?> determineResourceMethod(RequestDetails requestDetails,
                                                    String requestPath)
```
    Figure out and return whichever method binding is appropriate for the given request
  - doDelete
```
protected void doDelete(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws javax.servlet.ServletException,
                        IOException
```
    Overrides:
    
    doDelete in class javax.servlet.http.HttpServlet
    
    Throws:
    
    javax.servlet.ServletException
    
    IOException
  - doGet
```
protected void doGet(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     IOException
```
    Overrides:
    
    doGet in class javax.servlet.http.HttpServlet
    
    Throws:
    
    javax.servlet.ServletException
    
    IOException
  - doOptions
```
protected void doOptions(javax.servlet.http.HttpServletRequest theReq,
                         javax.servlet.http.HttpServletResponse theResp)
                  throws javax.servlet.ServletException,
                         IOException
```
    Overrides:
    
    doOptions in class javax.servlet.http.HttpServlet
    
    Throws:
    
    javax.servlet.ServletException
    
    IOException
  - doPost
```
protected void doPost(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws javax.servlet.ServletException,
                      IOException
```
    Overrides:
    
    doPost in class javax.servlet.http.HttpServlet
    
    Throws:
    
    javax.servlet.ServletException
    
    IOException
  - doPut
```
protected void doPut(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     IOException
```
    Overrides:
    
    doPut in class javax.servlet.http.HttpServlet
    
    Throws:
    
    javax.servlet.ServletException
    
    IOException
  - getAddProfileTag
```
@Deprecated
public ca.uhn.fhir.context.api.AddProfileTagEnum getAddProfileTag()
```
    Deprecated. As of HAPI FHIR 1.5, this property has been moved to FhirContext.setAddProfileTagWhenEncoding(AddProfileTagEnum)
    
    Specified by:
    
    getAddProfileTag in interface IRestfulServerDefaults
    
    Returns:
    
    Returns the setting for automatically adding profile tags
  - setAddProfileTag
```
@Deprecated
public void setAddProfileTag(ca.uhn.fhir.context.api.AddProfileTagEnum theAddProfileTag)
```
    Deprecated. As of HAPI FHIR 1.5, this property has been moved to FhirContext.setAddProfileTagWhenEncoding(AddProfileTagEnum)
    
    Sets the profile tagging behaviour for the server. When set to a value other than AddProfileTagEnum.NEVER (which is the default), the server will automatically add a profile tag based on the class of the resource(s) being returned.
    
    Parameters:
    
    theAddProfileTag - The behaviour enum (must not be null)
  - getBundleInclusionRule
```
public ca.uhn.fhir.context.api.BundleInclusionRule getBundleInclusionRule()
```
    Specified by:
    
    getBundleInclusionRule in interface IRestfulServer<ServletRequestDetails>
  - setBundleInclusionRule
```
public void setBundleInclusionRule(ca.uhn.fhir.context.api.BundleInclusionRule theBundleInclusionRule)
```
    Set how bundle factory should decide whether referenced resources should be included in bundles
    
    Parameters:
    
    theBundleInclusionRule - - inclusion rule (@see BundleInclusionRule for behaviors)
  - getDefaultResponseEncoding
```
public ca.uhn.fhir.rest.api.EncodingEnum getDefaultResponseEncoding()
```
    Returns the default encoding to return (XML/JSON) if an incoming request does not specify a preference (either with the _format URL parameter, or with an Accept header in the request. The default is EncodingEnum.XML. Will not return null.
    
    Specified by:
    
    getDefaultResponseEncoding in interface IRestfulServerDefaults
    
    Returns:
    
    Returns the default encoding to return (XML/JSON) if an incoming request does not specify a preference (either with the _format URL parameter, or with an Accept header in the request. The default is EncodingEnum.XML. Will not return null.
  - setDefaultResponseEncoding
```
public void setDefaultResponseEncoding(ca.uhn.fhir.rest.api.EncodingEnum theDefaultResponseEncoding)
```
    Sets the default encoding to return (XML/JSON) if an incoming request does not specify a preference (either with the _format URL parameter, or with an Accept header in the request. The default is EncodingEnum.XML.
    Note when testing this feature: Some browsers will include "application/xml" in their Accept header, which means that the
  - getETagSupport
```
public ETagSupportEnum getETagSupport()
```
    Specified by:
    
    getETagSupport in interface IRestfulServerDefaults
    
    Returns:
    
    Returns the server support for ETags (will not be null). Default is DEFAULT_ETAG_SUPPORT
  - setETagSupport
```
public void setETagSupport(ETagSupportEnum theETagSupport)
```
    Sets (enables/disables) the server support for ETags. Must not be null. Default is DEFAULT_ETAG_SUPPORT
    
    Parameters:
    
    theETagSupport - The ETag support mode
  - getElementsSupport
```
public ElementsSupportEnum getElementsSupport()
```
    Specified by:
    
    getElementsSupport in interface IRestfulServerDefaults
    
    Returns:
    
    Returns the support option for the _elements parameter on search and read operations.
    
    See Also:
    
    Extended Elements Support
  - setElementsSupport
```
public void setElementsSupport(ElementsSupportEnum theElementsSupport)
```
    Sets the elements support mode.
    
    See Also:
    
    Extended Elements Support
  - getFhirContext
```
public ca.uhn.fhir.context.FhirContext getFhirContext()
```
    Gets the FhirContext associated with this server. For efficient processing, resource providers and plain providers should generally use this context if one is needed, as opposed to creating their own.
    
    Specified by:
    
    getFhirContext in interface IRestfulServerDefaults
  - setFhirContext
```
public void setFhirContext(ca.uhn.fhir.context.FhirContext theFhirContext)
```
  - getImplementationDescription
```
public String getImplementationDescription()
```
  - setImplementationDescription
```
public void setImplementationDescription(String theImplementationDescription)
```
  - getInterceptors_
```
@Deprecated
public List<IServerInterceptor> getInterceptors_()
```
    Deprecated. As of HAPI FHIR 3.8.0, use getInterceptorService() to access the interceptor service. You can register and unregister interceptors using this service.
    
    Returns a list of all registered server interceptors
    
    Specified by:
    
    getInterceptors_ in interface IRestfulServerDefaults
  - getInterceptorService
```
public ca.uhn.fhir.interceptor.api.IInterceptorService getInterceptorService()
```
    Returns the interceptor registry for this service. Use this registry to register and unregister
    
    Specified by:
    
    getInterceptorService in interface IRestfulServerDefaults
    
    Since:
    
    3.8.0
  - setInterceptorService
```
public void setInterceptorService(@Nonnull
                                  ca.uhn.fhir.interceptor.api.IInterceptorService theInterceptorService)
```
    Sets the interceptor registry for this service. Use this registry to register and unregister
    
    Since:
    
    3.8.0
  - setInterceptors
```
@Deprecated
public void setInterceptors(@Nonnull
                                        List<?> theList)
```
    Deprecated. As of HAPI FHIR 3.8.0, use getInterceptorService() to access the interceptor service. You can register and unregister interceptors using this service.
    
    Sets (or clears) the list of interceptors
    
    Parameters:
    
    theList - The list of interceptors (may be null)
  - setInterceptors
```
@Deprecated
public void setInterceptors(IServerInterceptor... theInterceptors)
```
    Deprecated. As of HAPI FHIR 3.8.0, use getInterceptorService() to access the interceptor service. You can register and unregister interceptors using this service.
    
    Sets (or clears) the list of interceptors
    
    Parameters:
    
    theInterceptors - The list of interceptors (may be null)
  - getPagingProvider
```
public IPagingProvider getPagingProvider()
```
    Description copied from interface: IRestfulServerDefaults
    
    Returns the paging provider for this server
    
    Specified by:
    
    getPagingProvider in interface IRestfulServer<ServletRequestDetails>
    
    Specified by:
    
    getPagingProvider in interface IRestfulServerDefaults
  - setPagingProvider
```
public void setPagingProvider(IPagingProvider thePagingProvider)
```
    Sets the paging provider to use, or null to use no paging (which is the default)
  - getPlainProviders
```
public Collection<Object> getPlainProviders()
```
    Provides the non-resource specific providers which implement method calls on this server
    
    See Also:
    
    getResourceProviders()
  - setPlainProviders
```
@Deprecated
public void setPlainProviders(Object... theProv)
```
    Deprecated. This method causes inconsistent behaviour depending on the order it is called in. Use registerProviders(Object...) instead.
    
    Sets the non-resource specific providers which implement method calls on this server.
    
    See Also:
    
    setResourceProviders(Collection)
  - setPlainProviders
```
@Deprecated
public void setPlainProviders(Collection<Object> theProviders)
```
    Deprecated. This method causes inconsistent behaviour depending on the order it is called in. Use registerProviders(Object...) instead.
    
    Sets the non-resource specific providers which implement method calls on this server.
    
    See Also:
    
    setResourceProviders(Collection)
  - getRequestPath
```
protected String getRequestPath(String requestFullPath,
                                String servletContextPath,
                                String servletPath)
```
    Allows users of RestfulServer to override the getRequestPath method to let them build their custom request path implementation
    
    Parameters:
    
    requestFullPath - the full request path
    
    servletContextPath - the servelet context path
    
    servletPath - the servelet path
    
    Returns:
    
    created resource path
  - getResourceBindings
```
public Collection<ResourceBinding> getResourceBindings()
```
  - getResourceProviders
```
public Collection<IResourceProvider> getResourceProviders()
```
    Provides the resource providers for this server
  - setResourceProviders
```
public void setResourceProviders(IResourceProvider... theResourceProviders)
```
    Sets the resource providers for this server
  - setResourceProviders
```
public void setResourceProviders(Collection<IResourceProvider> theProviders)
```
    Sets the resource providers for this server
  - getServerAddressStrategy
```
public IServerAddressStrategy getServerAddressStrategy()
```
    Get the server address strategy, which is used to determine what base URL to provide clients to refer to this server. Defaults to an instance of IncomingRequestAddressStrategy
  - setServerAddressStrategy
```
public void setServerAddressStrategy(IServerAddressStrategy theServerAddressStrategy)
```
    Provide a server address strategy, which is used to determine what base URL to provide clients to refer to this server. Defaults to an instance of IncomingRequestAddressStrategy
  - getServerBaseForRequest
```
public String getServerBaseForRequest(ServletRequestDetails theRequest)
```
    Returns the server base URL (with no trailing '/') for a given request
  - getServerBindings
```
public List<BaseMethodBinding<?>> getServerBindings()
```
    Returns the method bindings for this server which are not specific to any particular resource type. This method is internal to HAPI and developers generally do not need to interact with it. Use with caution, as it may change.
  - getServerConformanceProvider
```
public Object getServerConformanceProvider()
```
    Returns the server conformance provider, which is the provider that is used to generate the server's conformance (metadata) statement if one has been explicitly defined.
    By default, the ServerConformanceProvider for the declared version of FHIR is used, but this can be changed, or set to null to use the appropriate one for the given FHIR version.
  - setServerConformanceProvider
```
public void setServerConformanceProvider(Object theServerConformanceProvider)
```
    Returns the server conformance provider, which is the provider that is used to generate the server's conformance (metadata) statement.
    By default, the ServerConformanceProvider implementation for the declared version of FHIR is used, but this can be changed, or set to null if you do not wish to export a conformance statement.
    Note that this method can only be called before the server is initialized.
    
    Throws:
    
    IllegalStateException - Note that this method can only be called prior to initialization and will throw an IllegalStateException if called after that.
  - getServerName
```
public String getServerName()
```
    Gets the server's name, as exported in conformance profiles exported by the server. This is informational only, but can be helpful to set with something appropriate.
    
    See Also:
    
    setServerName(String)
  - setServerName
```
public void setServerName(String theServerName)
```
    Sets the server's name, as exported in conformance profiles exported by the server. This is informational only, but can be helpful to set with something appropriate.
  - getServerProfilesProvider
```
public IResourceProvider getServerProfilesProvider()
```
  - getServerVersion
```
public String getServerVersion()
```
    Gets the server's version, as exported in conformance profiles exported by the server. This is informational only, but can be helpful to set with something appropriate.
  - setServerVersion
```
public void setServerVersion(String theServerVersion)
```
    Gets the server's version, as exported in conformance profiles exported by the server. This is informational only, but can be helpful to set with something appropriate.
  - handleRequest
```
protected void handleRequest(ca.uhn.fhir.rest.api.RequestTypeEnum theRequestType,
                             javax.servlet.http.HttpServletRequest theRequest,
                             javax.servlet.http.HttpServletResponse theResponse)
                      throws javax.servlet.ServletException,
                             IOException
```
    Throws:
    
    javax.servlet.ServletException
    
    IOException
  - validateRequest
```
protected void validateRequest(ServletRequestDetails theRequestDetails)
```
  - init
```
public final void init()
                throws javax.servlet.ServletException
```
    Initializes the server. Note that this method is final to avoid accidentally introducing bugs in implementations, but subclasses may put initialization code in initialize(), which is called immediately before beginning initialization of the restful server's internal init.
    
    Overrides:
    
    init in class javax.servlet.GenericServlet
    
    Throws:
    
    javax.servlet.ServletException
  - initialize
```
protected void initialize()
                   throws javax.servlet.ServletException
```
    This method may be overridden by subclasses to do perform initialization that needs to be performed prior to the server being used.
    
    Throws:
    
    javax.servlet.ServletException - If the initialization failed. Note that you should consider throwing UnavailableException (which extends ServletException), as this is a flag to the servlet container that the servlet is not usable.
  - isDefaultPrettyPrint
```
public boolean isDefaultPrettyPrint()
```
    Should the server "pretty print" responses by default (requesting clients can always override this default by supplying an Accept header in the request, or a _pretty parameter in the request URL.
    The default is false
    
    Note that this setting is ignored by ResponseHighlighterInterceptor when streaming HTML, although even when that interceptor it used this setting will still be honoured when streaming raw FHIR.
    
    Specified by:
    
    isDefaultPrettyPrint in interface IRestfulServerDefaults
    
    Returns:
    
    Returns the default pretty print setting
  - setDefaultPrettyPrint
```
public void setDefaultPrettyPrint(boolean theDefaultPrettyPrint)
```
    Should the server "pretty print" responses by default (requesting clients can always override this default by supplying an Accept header in the request, or a _pretty parameter in the request URL.
    The default is false
    
    Note that this setting is ignored by ResponseHighlighterInterceptor when streaming HTML, although even when that interceptor it used this setting will still be honoured when streaming raw FHIR.
    
    Parameters:
    
    theDefaultPrettyPrint - The default pretty print setting
  - isIgnoreServerParsedRequestParameters
```
public boolean isIgnoreServerParsedRequestParameters()
```
    If set to true (the default is true) this server will not use the parsed request parameters (URL parameters and HTTP POST form contents) but will instead parse these values manually from the request URL and request body.
    This is useful because many servlet containers (e.g. Tomcat, Glassfish) will use ISO-8859-1 encoding to parse escaped URL characters instead of using UTF-8 as is specified by FHIR.
  - setIgnoreServerParsedRequestParameters
```
public void setIgnoreServerParsedRequestParameters(boolean theIgnoreServerParsedRequestParameters)
```
    If set to true (the default is true) this server will not use the parsed request parameters (URL parameters and HTTP POST form contents) but will instead parse these values manually from the request URL and request body.
    This is useful because many servlet containers (e.g. Tomcat, Glassfish) will use ISO-8859-1 encoding to parse escaped URL characters instead of using UTF-8 as is specified by FHIR.
  - isUncompressIncomingContents
```
public boolean isUncompressIncomingContents()
```
    Should the server attempt to decompress incoming request contents (default is true). Typically this should be set to true unless the server has other configuration to deal with decompressing request bodies (e.g. a filter applied to the whole server).
  - setUncompressIncomingContents
```
public void setUncompressIncomingContents(boolean theUncompressIncomingContents)
```
    Should the server attempt to decompress incoming request contents (default is true). Typically this should be set to true unless the server has other configuration to deal with decompressing request bodies (e.g. a filter applied to the whole server).
  - populateRequestDetailsFromRequestPath
```
public void populateRequestDetailsFromRequestPath(RequestDetails theRequestDetails,
                                                  String theRequestPath)
```
  - registerInterceptor
```
public void registerInterceptor(Object theInterceptor)
```
    Registers an interceptor. This method is a convenience method which calls getInterceptorService().registerInterceptor(theInterceptor);
    
    Parameters:
    
    theInterceptor - The interceptor, must not be null
  - registerProvider
```
public void registerProvider(Object provider)
```
    Register a single provider. This could be a Resource Provider or a "plain" provider not associated with any resource.
  - registerProviders
```
public void registerProviders(Object... theProviders)
```
    Register a group of providers. These could be Resource Providers (classes implementing IResourceProvider) or "plain" providers, or a mixture of the two.
    
    Parameters:
    
    theProviders - a Collection of theProviders. The parameter could be null or an empty Collection
  - registerProviders
```
public void registerProviders(Collection<?> theProviders)
```
    Register a group of theProviders. These could be Resource Providers, "plain" theProviders or a mixture of the two.
    
    Parameters:
    
    theProviders - a Collection of theProviders. The parameter could be null or an empty Collection
  - registerProviders
```
protected void registerProviders(Collection<?> theProviders,
                                 boolean inInit)
```
  - returnResponse
```
public Object returnResponse(ServletRequestDetails theRequest,
                             ParseAction<?> outcome,
                             int operationStatus,
                             boolean allowPrefer,
                             ca.uhn.fhir.rest.api.MethodOutcome response,
                             String resourceName)
                      throws IOException
```
    Throws:
    
    IOException
  - service
```
protected void service(javax.servlet.http.HttpServletRequest theReq,
                       javax.servlet.http.HttpServletResponse theResp)
                throws javax.servlet.ServletException,
                       IOException
```
    Overrides:
    
    service in class javax.servlet.http.HttpServlet
    
    Throws:
    
    javax.servlet.ServletException
    
    IOException
  - setProviders
```
public void setProviders(Object... theProviders)
```
    Sets the non-resource specific providers which implement method calls on this server
    
    See Also:
    
    setResourceProviders(Collection)
  - setTenantIdentificationStrategy
```
public void setTenantIdentificationStrategy(ITenantIdentificationStrategy theTenantIdentificationStrategy)
```
    If provided (default is null), the tenant identification strategy provides a mechanism for a multitenant server to identify which tenant a given request corresponds to.
  - throwUnknownFhirOperationException
```
protected void throwUnknownFhirOperationException(RequestDetails requestDetails,
                                                  String requestPath,
                                                  ca.uhn.fhir.rest.api.RequestTypeEnum theRequestType)
```
  - throwUnknownResourceTypeException
```
protected void throwUnknownResourceTypeException(String theResourceName)
```
  - unregisterInterceptor
```
public void unregisterInterceptor(Object theInterceptor)
```
    Unregisters an interceptor. This method is a convenience method which calls getInterceptorService().unregisterInterceptor(theInterceptor);
    
    Parameters:
    
    theInterceptor - The interceptor, must not be null
  - unregisterProvider
```
public void unregisterProvider(Object provider)
```
    Unregister one provider (either a Resource provider or a plain provider)
  - unregisterProviders
```
public void unregisterProviders(Collection<?> providers)
```
    Unregister a Collection of providers
  - getDefaultPreferReturn
```
public ca.uhn.fhir.rest.api.PreferReturnEnum getDefaultPreferReturn()
```
    By default, server create/update/patch/transaction methods return a copy of the resource as it was stored. This may be overridden by the client using the Prefer header.
    This setting changes the default behaviour if no Prefer header is supplied by the client. The default is PreferReturnEnum.REPRESENTATION
    
    Specified by:
    
    getDefaultPreferReturn in interface IRestfulServer<ServletRequestDetails>
    
    See Also:
    
    HL7 FHIR Specification section on the Prefer header
  - setDefaultPreferReturn
```
public void setDefaultPreferReturn(ca.uhn.fhir.rest.api.PreferReturnEnum theDefaultPreferReturn)
```
    By default, server create/update/patch/transaction methods return a copy of the resource as it was stored. This may be overridden by the client using the Prefer header.
    This setting changes the default behaviour if no Prefer header is supplied by the client. The default is PreferReturnEnum.REPRESENTATION
    
    See Also:
    
    HL7 FHIR Specification section on the Prefer header
  - escapedLength
```
protected static int escapedLength(String theServletPath)
```
    Count length of URL string, but treating unescaped sequences (e.g. ' ') as their unescaped equivalent (%20)
  - throwUnknownFhirOperationException
```
public static void throwUnknownFhirOperationException(RequestDetails requestDetails,
                                                      String requestPath,
                                                      ca.uhn.fhir.rest.api.RequestTypeEnum theRequestType,
                                                      ca.uhn.fhir.context.FhirContext theFhirContext)
```

Class RestfulServer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javax.servlet.http.HttpServlet

Methods inherited from class javax.servlet.GenericServlet

Methods inherited from class java.lang.Object

Field Detail

REQUEST_START_TIME

DEFAULT_ETAG_SUPPORT

SERVLET_CONTEXT_ATTRIBUTE

DEFAULT_PREFER_RETURN

Constructor Detail

RestfulServer

RestfulServer

Method Detail

addHeadersToResponse

createConfiguration

createPoweredByAttributes

createPoweredByHeader

createPoweredByHeaderComponentName

createPoweredByHeaderProductName

createPoweredByHeaderProductVersion

destroy

determineResourceMethod

doDelete

doGet

doOptions

doPost

doPut

getAddProfileTag

setAddProfileTag

getBundleInclusionRule

setBundleInclusionRule

getDefaultResponseEncoding

setDefaultResponseEncoding

getETagSupport

setETagSupport

getElementsSupport

setElementsSupport

getFhirContext

setFhirContext

getImplementationDescription

setImplementationDescription

getInterceptors_

getInterceptorService

setInterceptorService

setInterceptors

setInterceptors

getPagingProvider

setPagingProvider

getPlainProviders

setPlainProviders

setPlainProviders

getRequestPath

getResourceBindings

getResourceProviders

setResourceProviders

setResourceProviders

getServerAddressStrategy

setServerAddressStrategy

getServerBaseForRequest

getServerBindings

getServerConformanceProvider

setServerConformanceProvider

getServerName

setServerName

getServerProfilesProvider

getServerVersion

setServerVersion

handleRequest

validateRequest

init

initialize

isDefaultPrettyPrint

setDefaultPrettyPrint

isIgnoreServerParsedRequestParameters

setIgnoreServerParsedRequestParameters

isUncompressIncomingContents

setUncompressIncomingContents