Package ca.uhn.fhir.test.utilities.server

Class RestfulServerExtension

java.lang.Object

ca.uhn.fhir.test.utilities.server.BaseJettyServerExtension<RestfulServerExtension>

ca.uhn.fhir.test.utilities.server.RestfulServerExtension

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension

public class RestfulServerExtension
extends BaseJettyServerExtension<RestfulServerExtension>

Constructor Summary

Constructors

Constructor	Description
RestfulServerExtension(ca.uhn.fhir.context.FhirContext theFhirContext, Object... theProviders)	Constructor
RestfulServerExtension(ca.uhn.fhir.context.FhirVersionEnum theFhirVersionEnum)	Constructor: If this is used, it will create and tear down a FhirContext which is good for memory

Method Summary

Modifier and Type	Method	Description
void	beforeEach(org.junit.jupiter.api.extension.ExtensionContext theContext)
Integer	getDefaultPageSize()
ca.uhn.fhir.rest.client.api.IGenericClient	getFhirClient()	Creates a new client for each callof this method
ca.uhn.fhir.context.FhirContext	getFhirContext()
ca.uhn.fhir.interceptor.api.IInterceptorService	getInterceptorService()
ca.uhn.fhir.rest.server.RestfulServer	getRestfulServer()
Map<String,Object>	getRunningServerUserData()	User data map which is automatically cleared when the server is stopped
protected javax.servlet.http.HttpServlet	provideServlet()
RestfulServerExtension	registerAnonymousInterceptor(ca.uhn.fhir.interceptor.api.Pointcut thePointcut, ca.uhn.fhir.interceptor.api.IAnonymousInterceptor theInterceptor)
RestfulServerExtension	registerInterceptor(Object theInterceptor)
RestfulServerExtension	registerProvider(Object theProvider)
void	setDefaultPageSize(Integer theInitialDefaultPageSize)
protected void	startServer()
void	stopServer()
void	unregisterAllInterceptors()
RestfulServerExtension	unregisterInterceptor(Object theInterceptor)
void	unregisterProvider(Object theProvider)
RestfulServerExtension	withDefaultResponseEncoding(ca.uhn.fhir.rest.api.EncodingEnum theEncodingEnum)
RestfulServerExtension	withPagingProvider(ca.uhn.fhir.rest.server.IPagingProvider thePagingProvider)
RestfulServerExtension	withServer(Consumer<ca.uhn.fhir.rest.server.RestfulServer> theConsumer)
RestfulServerExtension	withValidationMode(ca.uhn.fhir.rest.client.api.ServerValidationModeEnum theValidationMode)

Methods inherited from class ca.uhn.fhir.test.utilities.server.BaseJettyServerExtension

afterAll, afterEach, getBaseUrl, getConnectionsOpenedCount, getHttpClient, getPort, getRequestContentTypes, getRequestHeaders, getWebsocketContextPath, isRunning, keepAliveBetweenTests, resetConnectionsOpenedCount, withContextPath, withIdleTimeout, withPort, withServletPath, withSpringWebsocketSupport

Methods inherited from class java.lang.Object

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

Constructor Details

RestfulServerExtension

public RestfulServerExtension(ca.uhn.fhir.context.FhirContext theFhirContext,
 Object... theProviders)

Constructor

RestfulServerExtension

public RestfulServerExtension(ca.uhn.fhir.context.FhirVersionEnum theFhirVersionEnum)

Constructor: If this is used, it will create and tear down a FhirContext which is good for memory

Method Details

getRunningServerUserData

public Map<String,Object> getRunningServerUserData()

User data map which is automatically cleared when the server is stopped

startServer

protected void startServer()
                    throws Exception

Overrides:

startServer in class BaseJettyServerExtension<RestfulServerExtension>

Throws:

Exception

provideServlet

protected javax.servlet.http.HttpServlet provideServlet()

Specified by:

provideServlet in class BaseJettyServerExtension<RestfulServerExtension>

stopServer

public void stopServer()
                throws Exception

Overrides:

stopServer in class BaseJettyServerExtension<RestfulServerExtension>

Throws:

Exception

getFhirClient

public ca.uhn.fhir.rest.client.api.IGenericClient getFhirClient()

Creates a new client for each callof this method

getFhirContext

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

getRestfulServer

public ca.uhn.fhir.rest.server.RestfulServer getRestfulServer()

beforeEach

public void beforeEach(org.junit.jupiter.api.extension.ExtensionContext theContext)
                throws Exception

Specified by:

beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

Overrides:

beforeEach in class BaseJettyServerExtension<RestfulServerExtension>

Throws:

Exception

registerProvider

public RestfulServerExtension registerProvider(Object theProvider)

withServer

public RestfulServerExtension withServer(Consumer<ca.uhn.fhir.rest.server.RestfulServer> theConsumer)

registerInterceptor

public RestfulServerExtension registerInterceptor(Object theInterceptor)

withValidationMode

public RestfulServerExtension withValidationMode(ca.uhn.fhir.rest.client.api.ServerValidationModeEnum theValidationMode)

unregisterAllInterceptors

public void unregisterAllInterceptors()

withPagingProvider

public RestfulServerExtension withPagingProvider(ca.uhn.fhir.rest.server.IPagingProvider thePagingProvider)

unregisterInterceptor

public RestfulServerExtension unregisterInterceptor(Object theInterceptor)

unregisterProvider

public void unregisterProvider(Object theProvider)

getDefaultPageSize

public Integer getDefaultPageSize()

setDefaultPageSize

public void setDefaultPageSize(Integer theInitialDefaultPageSize)

getInterceptorService

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

registerAnonymousInterceptor

public RestfulServerExtension registerAnonymousInterceptor(ca.uhn.fhir.interceptor.api.Pointcut thePointcut,
 ca.uhn.fhir.interceptor.api.IAnonymousInterceptor theInterceptor)

withDefaultResponseEncoding

public RestfulServerExtension withDefaultResponseEncoding(ca.uhn.fhir.rest.api.EncodingEnum theEncodingEnum)