org.openehealth.ipf.commons.ihe.fhir

Class CamelFhirServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

ca.uhn.fhir.rest.server.RestfulServer

org.openehealth.ipf.commons.ihe.fhir.CamelFhirServlet

All Implemented Interfaces:

ca.uhn.fhir.rest.server.IRestfulServer<ca.uhn.fhir.rest.server.servlet.ServletRequestDetails>, ca.uhn.fhir.rest.server.IRestfulServerDefaults, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class CamelFhirServlet
extends ca.uhn.fhir.rest.server.RestfulServer

HAPI FHIR RestfulServer implementation, adding a few configuration bits using servlet init parameters:

• logging (boolean): add global logging interceptor
• highlight (boolean)
: add response formatting if request was issued from a browser
• pretty (boolean)
: pretty-print the response
• pagingProviderSize (integer)
: maximum number of concurrent paging requests

Since:

3.1

Author:

Christian Ohr

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVLET_NAME

Fields inherited from class ca.uhn.fhir.rest.server.RestfulServer

DEFAULT_ETAG_SUPPORT, SERVLET_CONTEXT_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
CamelFhirServlet()

Method Summary

Modifier and Type	Method and Description
protected ca.uhn.fhir.narrative.INarrativeGenerator	getDefaultNarrativeGenerator()
protected int	getDefaultPageSize()
protected ca.uhn.fhir.rest.server.IPagingProvider	getDefaultPagingProvider(int pagingProviderSize) Returns the instance of IPagingProvider to be used.
protected int	getMaximumPageSize()
protected int	getPagingProviderSize()
String	getServletName()
void	init(javax.servlet.ServletConfig config) RestfulServer assumes that all resource providers are known at init time, which is not the case here.
protected void	initialize() Called upon initialization of the servlet, which is too early to know about the existing FHIR consumers initialization of Camel routes and endpoints.
static void	registerProvider(String name, AbstractPlainProvider provider)
static void	unregisterProvider(String name, AbstractPlainProvider provider)

Methods inherited from class ca.uhn.fhir.rest.server.RestfulServer

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, 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

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, log, log

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SERVLET_NAME

public static final String DEFAULT_SERVLET_NAME

See Also:

Constant Field Values

Constructor Detail

CamelFhirServlet

public CamelFhirServlet()

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

RestfulServer assumes that all resource providers are known at init time, which is not the case here.

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Parameters:

config - servlet config

Throws:

javax.servlet.ServletException

getDefaultPagingProvider

protected ca.uhn.fhir.rest.server.IPagingProvider getDefaultPagingProvider(int pagingProviderSize)

Returns the instance of IPagingProvider to be used. This implemention returns FifoMemoryPagingProvider, you may overwrite this e.g. to add a provider backed by a decent Cache implementation. In this case, not forget to set the paging parameters accessible via getPagingProviderSize(), getDefaultPageSize() and getMaximumPageSize().

You can also return null in order to disable paging.

The way how paging is actually implemented depends on the respective FHIR consumer endpoints

Parameters:

pagingProviderSize - maximum number of parallel paged requests. Note that each request may have an aribitrary number of result resources though.

Returns:

implementation of IPagingProvider

See Also:

IPagingProvider, getPagingProviderSize(), getMaximumPageSize(), getDefaultPageSize()

getDefaultNarrativeGenerator

protected ca.uhn.fhir.narrative.INarrativeGenerator getDefaultNarrativeGenerator()

Returns:

the narrative generator, null by default

initialize

protected void initialize()
                   throws javax.servlet.ServletException

Called upon initialization of the servlet, which is too early to know about the existing FHIR consumers initialization of Camel routes and endpoints.

Overrides:

initialize in class ca.uhn.fhir.rest.server.RestfulServer

Throws:

javax.servlet.ServletException

registerProvider

public static void registerProvider(String name,
                                    AbstractPlainProvider provider)

unregisterProvider

public static void unregisterProvider(String name,
                                      AbstractPlainProvider provider)
                               throws Exception

Throws:

Exception

getServletName

public String getServletName()

Specified by:

getServletName in interface javax.servlet.ServletConfig

Overrides:

getServletName in class javax.servlet.GenericServlet

getMaximumPageSize

protected int getMaximumPageSize()

Returns:

the maximum page size (even if the client requested more). Default is 100.

getDefaultPageSize

protected int getDefaultPageSize()

Returns:

the default page size (if the client did not request anything). Default is 20.

getPagingProviderSize

protected int getPagingProviderSize()

Returns:

the number of concurrently maintained page caches. Default is 50.