RestfulServer (HAPI FHIR - Core Library 1.4 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 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(FhirContext theCtx)
Constructor

Constructors
Constructor and Description
`RestfulServer()` Constructor.
`RestfulServer(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()`
`void`	`destroy()`
`BaseMethodBinding<?>`	`determineResourceMethod(RequestDetails requestDetails, String requestPath)`
`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 int`	`escapedLength(String theServletPath)` Count length of URL string, but treating unescaped sequences (e.g.
`AddProfileTagEnum`	`getAddProfileTag()`
`BundleInclusionRule`	`getBundleInclusionRule()`
`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.
`ETagSupportEnum`	`getETagSupport()`
`FhirContext`	`getFhirContext()` Gets the `FhirContext` associated with this server.
`String`	`getImplementationDescription()`
`List<IServerInterceptor>`	`getInterceptors()` Returns a ist of all registered server interceptors
`IPagingProvider`	`getPagingProvider()`
`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(javax.servlet.http.HttpServletRequest 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(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`	`isUncompressIncomingContents()` Should the server attempt to decompress incoming request contents (default is `true`).
`boolean`	`isUseBrowserFriendlyContentTypes()` Deprecated. This feature did not work well, and will be removed. Use `ResponseHighlighterInterceptor` instead as an interceptor on your server and it will provide more useful syntax highlighting. Deprocated in 1.4
`void`	`populateRequestDetailsFromRequestPath(RequestDetails theRequestDetails, String theRequestPath)`
`void`	`registerInterceptor(IServerInterceptor theInterceptor)`
`void`	`registerProvider(Object provider)` Register a single provider.
`void`	`registerProviders(Collection<? extends Object> providers)` Register a group of providers.
`protected void`	`registerProviders(Collection<? extends Object> providers, boolean inInit)`
`static boolean`	`requestIsBrowser(javax.servlet.http.HttpServletRequest theRequest)`
`Object`	`returnResponse(ServletRequestDetails theRequest, ParseAction<?> outcome, int operationStatus, boolean allowPrefer, MethodOutcome response, String resourceName)`
`void`	`setAddProfileTag(AddProfileTagEnum theAddProfileTag)` Sets the profile tagging behaviour for the server.
`void`	`setBundleInclusionRule(BundleInclusionRule theBundleInclusionRule)` Set how bundle factory should decide whether referenced resources should be included in bundles
`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(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`	`setETagSupport(ETagSupportEnum theETagSupport)` Sets (enables/disables) the server support for ETags.
`void`	`setFhirContext(FhirContext theFhirContext)`
`void`	`setImplementationDescription(String theImplementationDescription)`
`void`	`setInterceptors(IServerInterceptor... theList)` Sets (or clears) the list of interceptors
`void`	`setInterceptors(List<IServerInterceptor> theList)` Sets (or clears) the list of interceptors
`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)` Sets the non-resource specific providers which implement method calls on this server.
`void`	`setPlainProviders(Object... theProv)` Sets the non-resource specific providers which implement method calls on this server.
`void`	`setProviders(Object... theProviders)` Sets the non-resource specific providers which implement method calls on this server
`void`	`setResourceProviders(Collection<IResourceProvider> theResourceProviders)` 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`	`setUncompressIncomingContents(boolean theUncompressIncomingContents)` Should the server attempt to decompress incoming request contents (default is `true`).
`void`	`setUseBrowserFriendlyContentTypes(boolean theUseBrowserFriendlyContentTypes)` Deprecated. This feature did not work well, and will be removed. Use `ResponseHighlighterInterceptor` instead as an interceptor on your server and it will provide more useful syntax highlighting. Deprocated in 1.4
`void`	`unregisterInterceptor(IServerInterceptor theInterceptor)`
`void`	`unregisterProvider(Object provider)` Unregister one provider (either a Resource provider or a plain provider)
`void`	`unregisterProviders(Collection<? extends Object> providers)` Unregister a `Collection` of providers

Methods inherited from class javax.servlet.http.HttpServlet
doHead, doTrace, getLastModified, service, 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
  - 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_ETAG_SUPPORT
```
public static final ETagSupportEnum DEFAULT_ETAG_SUPPORT
```
    Default setting for ETag Support: ETagSupportEnum.ENABLED
- 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(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 inadvertantly disabling functionality.
  - createConfiguration
```
public RestulfulServerConfiguration createConfiguration()
```
  - 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)
```
  - 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
  - escapedLength
```
protected int escapedLength(String theServletPath)
```
    Count length of URL string, but treating unescaped sequences (e.g. ' ') as their unescaped equivalent (%20)
  - getAddProfileTag
```
public AddProfileTagEnum getAddProfileTag()
```
    Specified by:
    
    getAddProfileTag in interface IRestfulServerDefaults
    
    Returns:
    
    Returns the setting for automatically adding profile tags
  - getBundleInclusionRule
```
public BundleInclusionRule getBundleInclusionRule()
```
    Specified by:
    
    getBundleInclusionRule in interface IRestfulServer<ServletRequestDetails>
  - getDefaultResponseEncoding
```
public 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.
  - 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
  - getFhirContext
```
public 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
  - getImplementationDescription
```
public String getImplementationDescription()
```
  - getInterceptors
```
public List<IServerInterceptor> getInterceptors()
```
    Returns a ist of all registered server interceptors
    
    Specified by:
    
    getInterceptors in interface IRestfulServer<ServletRequestDetails>
  - getPagingProvider
```
public IPagingProvider getPagingProvider()
```
    Specified by:
    
    getPagingProvider in interface IRestfulServer<ServletRequestDetails>
  - getPlainProviders
```
public Collection<Object> getPlainProviders()
```
    Provides the non-resource specific providers which implement method calls on this server
    
    See Also:
    
    getResourceProviders()
  - 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
  - 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
  - getServerBaseForRequest
```
public String getServerBaseForRequest(javax.servlet.http.HttpServletRequest 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.
  - 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)
  - 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.
  - handleRequest
```
protected void handleRequest(RequestTypeEnum theRequestType,
                             javax.servlet.http.HttpServletRequest theRequest,
                             javax.servlet.http.HttpServletResponse theResponse)
                      throws javax.servlet.ServletException,
                             IOException
```
    Throws:
    
    javax.servlet.ServletException
    
    IOException
  - 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
    
    Specified by:
    
    isDefaultPrettyPrint in interface IRestfulServerDefaults
    
    Returns:
    
    Returns the default pretty print setting
  - 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).
  - isUseBrowserFriendlyContentTypes
```
@Deprecated
public boolean isUseBrowserFriendlyContentTypes()
```
    Deprecated. This feature did not work well, and will be removed. Use ResponseHighlighterInterceptor instead as an interceptor on your server and it will provide more useful syntax highlighting. Deprocated in 1.4
    
    Specified by:
    
    isUseBrowserFriendlyContentTypes in interface IRestfulServerDefaults
    
    Returns:
    
    If true the server will use browser friendly content-types (instead of standard FHIR ones) when it detects that the request is coming from a browser instead of a FHIR
  - populateRequestDetailsFromRequestPath
```
public void populateRequestDetailsFromRequestPath(RequestDetails theRequestDetails,
                                                  String theRequestPath)
```
  - registerInterceptor
```
public void registerInterceptor(IServerInterceptor theInterceptor)
```
  - registerProvider
```
public void registerProvider(Object provider)
                      throws Exception
```
    Register a single provider. This could be a Resource Provider or a "plain" provider not associated with any resource.
    
    Parameters:
    
    provider -
    
    Throws:
    
    Exception
  - registerProviders
```
public void registerProviders(Collection<? extends Object> providers)
                       throws Exception
```
    Register a group of providers. These could be Resource Providers, "plain" providers or a mixture of the two.
    
    Parameters:
    
    providers - a Collection of providers. The parameter could be null or an empty Collection
    
    Throws:
    
    Exception
  - registerProviders
```
protected void registerProviders(Collection<? extends Object> providers,
                                 boolean inInit)
                          throws Exception
```
    Throws:
    
    Exception
  - returnResponse
```
public Object returnResponse(ServletRequestDetails theRequest,
                             ParseAction<?> outcome,
                             int operationStatus,
                             boolean allowPrefer,
                             MethodOutcome response,
                             String resourceName)
                      throws IOException
```
    Throws:
    
    IOException
  - setAddProfileTag
```
public void setAddProfileTag(AddProfileTagEnum theAddProfileTag)
```
    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)
  - setBundleInclusionRule
```
public void setBundleInclusionRule(BundleInclusionRule theBundleInclusionRule)
```
    Set how bundle factory should decide whether referenced resources should be included in bundles
    
    Parameters:
    
    theBundleInclusionRule - - inclusion rule (@see BundleInclusionRule for behaviors)
  - 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
    
    Parameters:
    
    theDefaultPrettyPrint - The default pretty print setting
  - setDefaultResponseEncoding
```
public void setDefaultResponseEncoding(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
  - 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
  - setFhirContext
```
public void setFhirContext(FhirContext theFhirContext)
```
  - setImplementationDescription
```
public void setImplementationDescription(String theImplementationDescription)
```
  - setInterceptors
```
public void setInterceptors(IServerInterceptor... theList)
```
    Sets (or clears) the list of interceptors
    
    Parameters:
    
    theList - The list of interceptors (may be null)
  - setInterceptors
```
public void setInterceptors(List<IServerInterceptor> theList)
```
    Sets (or clears) the list of interceptors
    
    Parameters:
    
    theList - The list of interceptors (may be null)
  - setPagingProvider
```
public void setPagingProvider(IPagingProvider thePagingProvider)
```
    Sets the paging provider to use, or null to use no paging (which is the default)
  - setPlainProviders
```
public void setPlainProviders(Collection<Object> theProviders)
```
    Sets the non-resource specific providers which implement method calls on this server.
    
    See Also:
    
    setResourceProviders(Collection)
  - setPlainProviders
```
public void setPlainProviders(Object... theProv)
```
    Sets the non-resource specific providers which implement method calls on this server.
    
    See Also:
    
    setResourceProviders(Collection)
  - setProviders
```
public void setProviders(Object... theProviders)
```
    Sets the non-resource specific providers which implement method calls on this server
    
    See Also:
    
    setResourceProviders(Collection)
  - setResourceProviders
```
public void setResourceProviders(Collection<IResourceProvider> theResourceProviders)
```
    Sets the resource providers for this server
  - setResourceProviders
```
public void setResourceProviders(IResourceProvider... theResourceProviders)
```
    Sets the resource providers for this server
  - 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
  - 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.
  - 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.
  - 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.
  - 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).
  - setUseBrowserFriendlyContentTypes
```
@Deprecated
public void setUseBrowserFriendlyContentTypes(boolean theUseBrowserFriendlyContentTypes)
```
    Deprecated. This feature did not work well, and will be removed. Use ResponseHighlighterInterceptor instead as an interceptor on your server and it will provide more useful syntax highlighting. Deprocated in 1.4
  - unregisterInterceptor
```
public void unregisterInterceptor(IServerInterceptor theInterceptor)
```
  - unregisterProvider
```
public void unregisterProvider(Object provider)
                        throws Exception
```
    Unregister one provider (either a Resource provider or a plain provider)
    
    Parameters:
    
    provider -
    
    Throws:
    
    Exception
  - unregisterProviders
```
public void unregisterProviders(Collection<? extends Object> providers)
                         throws Exception
```
    Unregister a Collection of providers
    
    Parameters:
    
    providers -
    
    Throws:
    
    Exception
  - requestIsBrowser
```
public static boolean requestIsBrowser(javax.servlet.http.HttpServletRequest theRequest)
```

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

SERVLET_CONTEXT_ATTRIBUTE

DEFAULT_ETAG_SUPPORT

Constructor Detail

RestfulServer

RestfulServer

Method Detail

addHeadersToResponse

createConfiguration

destroy

determineResourceMethod

doDelete

doGet

doOptions

doPost

doPut

escapedLength

getAddProfileTag

getBundleInclusionRule

getDefaultResponseEncoding

getETagSupport

getFhirContext

getImplementationDescription

getInterceptors

getPagingProvider

getPlainProviders

getRequestPath

getResourceBindings

getResourceProviders

getServerAddressStrategy

getServerBaseForRequest

getServerBindings

getServerConformanceProvider

getServerName

getServerProfilesProvider

getServerVersion

handleRequest

init

initialize

isDefaultPrettyPrint

isUncompressIncomingContents

isUseBrowserFriendlyContentTypes

populateRequestDetailsFromRequestPath

registerInterceptor

registerProvider

registerProviders

registerProviders

returnResponse

setAddProfileTag

setBundleInclusionRule

setDefaultPrettyPrint

setDefaultResponseEncoding

setETagSupport

setFhirContext

setImplementationDescription

setInterceptors

setInterceptors

setPagingProvider

setPlainProviders

setPlainProviders

setProviders

setResourceProviders

setResourceProviders

setServerAddressStrategy

setServerConformanceProvider

setServerName

setServerVersion

setUncompressIncomingContents

setUseBrowserFriendlyContentTypes

unregisterInterceptor

unregisterProvider

unregisterProviders

requestIsBrowser