Package org.openehealth.ipf.boot.fhir

Class IpfBootFhirServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

ca.uhn.fhir.rest.server.RestfulServer

org.openehealth.ipf.commons.ihe.fhir.IpfFhirServlet

org.openehealth.ipf.boot.fhir.IpfBootFhirServlet

All Implemented Interfaces:

IRestfulServer<ServletRequestDetails>, IRestfulServerDefaults, jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable

public class IpfBootFhirServlet
extends IpfFhirServlet

Author:

Christian Ohr

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.openehealth.ipf.commons.ihe.fhir.IpfFhirServlet

DEFAULT_SERVLET_NAME

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

DEFAULT_ETAG_SUPPORT, DEFAULT_PREFER_RETURN, REQUEST_START_TIME, SERVLET_CONTEXT_ATTRIBUTE

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
IpfBootFhirServlet(FhirContext fhirContext, boolean caching, ObjectProvider<IPagingProvider> pagingProvider)

Method Summary

Modifier and Type	Method	Description
protected IPagingProvider	getDefaultPagingProvider(int pagingProviderSize)	Returns the instance of IPagingProvider to be used.

Methods inherited from class org.openehealth.ipf.commons.ihe.fhir.IpfFhirServlet

destroy, getDefaultNarrativeGenerator, getDefaultPageSize, getFhirVersion, getLoggingInterceptor, getMaximumPageSize, getNarrativeGenerator, getPagingProviderSize, getServletName, init, initialize, isLogging, isPrettyPrint, isResponseHighlighting, isStrictErrorHandler, setDefaultPageSize, setFhirContext, setFhirVersion, setLogging, setMaximumPageSize, setNarrativeGenerator, setPagingProviderSize, setPrettyPrint, setResponseHighlighting, setServletName, setStrictErrorHandler

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

addHeadersToResponse, addRequestIdToResponse, createConfiguration, createPoweredByAttributes, createPoweredByHeader, createPoweredByHeaderComponentName, createPoweredByHeaderProductName, createPoweredByHeaderProductVersion, determineResourceMethod, doDelete, doGet, doOptions, doPost, doPut, escapedLength, getAddProfileTag, getBundleInclusionRule, getCapabilityStatement, getCopyright, getDefaultPreferReturn, getDefaultResponseEncoding, getElementsSupport, getETagSupport, getFhirContext, getImplementationDescription, getInterceptors_, getInterceptorService, getOrCreateRequestId, getPagingProvider, getPlainProviders, getProviderMethodBindings, getRequestPath, getResourceBindings, getResourceProviders, getServerAddressStrategy, getServerBaseForRequest, getServerBindings, getServerConformanceMethod, getServerConformanceProvider, getServerName, getServerVersion, handleRequest, init, isDefaultPrettyPrint, isIgnoreServerParsedRequestParameters, isUncompressIncomingContents, newRequestDetails, newRequestDetails, newRequestId, populateRequestDetailsFromRequestPath, registerInterceptor, registerProvider, registerProviders, registerProviders, registerProviders, returnResponse, service, setAddProfileTag, setBundleInclusionRule, setCopyright, setDefaultPreferReturn, setDefaultPrettyPrint, setDefaultResponseEncoding, setElementsSupport, setETagSupport, setIgnoreServerParsedRequestParameters, setImplementationDescription, setInterceptors, setInterceptors, setInterceptorService, setPagingProvider, setPlainProviders, setPlainProviders, setProviders, setResourceProviders, setResourceProviders, setServerAddressStrategy, setServerConformanceProvider, setServerName, setServerVersion, setTenantIdentificationStrategy, setUncompressIncomingContents, throwUnknownFhirOperationException, throwUnknownFhirOperationException, throwUnknownResourceTypeException, unregisterAllProviders, unregisterInterceptor, unregisterProvider, unregisterProviders, validateRequest

Methods inherited from class jakarta.servlet.http.HttpServlet

doHead, doTrace, getLastModified, service

Methods inherited from class jakarta.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

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

canStoreSearchResults

Constructor Details

IpfBootFhirServlet

public IpfBootFhirServlet(FhirContext fhirContext,
 boolean caching,
 ObjectProvider<IPagingProvider> pagingProvider)

Method Details

getDefaultPagingProvider

protected IPagingProvider getDefaultPagingProvider(int pagingProviderSize)

Description copied from class: IpfFhirServlet

Returns the instance of IPagingProvider to be used. This implementation 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 IpfFhirServlet.getPagingProviderSize(), IpfFhirServlet.getDefaultPageSize() and IpfFhirServlet.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

Overrides:

getDefaultPagingProvider in class IpfFhirServlet

Parameters:

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

Returns:

implementation of IPagingProvider

See Also:

• IPagingProvider
• IpfFhirServlet.getPagingProviderSize()
• IpfFhirServlet.getMaximumPageSize()
• IpfFhirServlet.getDefaultPageSize()