Package ca.uhn.fhir.rest.openapi

Class OpenApiInterceptor

java.lang.Object

ca.uhn.fhir.rest.openapi.OpenApiInterceptor

public class OpenApiInterceptor
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final ca.uhn.fhir.context.FhirContext	FHIR_CONTEXT_CANONICAL
static final String	FHIR_JSON_RESOURCE
static final String	FHIR_XML_RESOURCE
static final String	PAGE_ALL
static final String	PAGE_SYSTEM
static final String	RACCOON_PNG
static final String	REQUEST_DETAILS

Constructor Summary

Constructors

Constructor	Description
OpenApiInterceptor()	Constructor

Method Summary

Modifier and Type	Method	Description
protected void	addResourcePathToClasspath(String thePath, String theClasspath)
protected void	addSearchOperation(io.swagger.v3.oas.models.OpenAPI openApi, io.swagger.v3.oas.models.Operation operation, ca.uhn.fhir.context.FhirContext ctx, String resourceType, org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementRestResourceComponent nextResource)
protected String	createResourceDescription(org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementRestResourceComponent theResource)
protected io.swagger.v3.oas.models.OpenAPI	generateOpenApi(ca.uhn.fhir.rest.server.servlet.ServletRequestDetails theRequestDetails)
String	getBannerImage()
String	getCssText()	If supplied, this field can be used to provide additional CSS text that should be loaded by the swagger-ui page.
protected org.thymeleaf.templateresource.ClassLoaderTemplateResource	getIndexTemplate()
protected io.swagger.v3.oas.models.Operation	getPathItem(io.swagger.v3.oas.models.Paths thePaths, String thePath, io.swagger.v3.oas.models.PathItem.HttpMethod theMethod)
protected boolean	handleResourceRequest(jakarta.servlet.http.HttpServletResponse theResponse, ca.uhn.fhir.rest.server.servlet.ServletRequestDetails theRequestDetails, String requestPath)
boolean	isUseResourcePages()
protected void	populateOIDCVariables(ca.uhn.fhir.rest.server.servlet.ServletRequestDetails theRequestDetails, org.thymeleaf.context.WebContext theContext)
String	removeTrailingSlash(String theUrl)
boolean	serveSwaggerUi(jakarta.servlet.http.HttpServletRequest theRequest, jakarta.servlet.http.HttpServletResponse theResponse, ca.uhn.fhir.rest.server.servlet.ServletRequestDetails theRequestDetails)
OpenApiInterceptor	setBannerImage(String theBannerImage)
void	setCssText(String theCssText)	If supplied, this field can be used to provide additional CSS text that should be loaded by the swagger-ui page.
void	setUseResourcePages(boolean theUseResourcePages)

Methods inherited from class java.lang.Object

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

Field Details

FHIR_JSON_RESOURCE

public static final String FHIR_JSON_RESOURCE

See Also:

• Constant Field Values

FHIR_XML_RESOURCE

public static final String FHIR_XML_RESOURCE

See Also:

• Constant Field Values

PAGE_SYSTEM

public static final String PAGE_SYSTEM

See Also:

• Constant Field Values

PAGE_ALL

public static final String PAGE_ALL

See Also:

• Constant Field Values

FHIR_CONTEXT_CANONICAL

public static final ca.uhn.fhir.context.FhirContext FHIR_CONTEXT_CANONICAL

REQUEST_DETAILS

public static final String REQUEST_DETAILS

See Also:

• Constant Field Values

RACCOON_PNG

public static final String RACCOON_PNG

See Also:

• Constant Field Values

Constructor Details

OpenApiInterceptor

public OpenApiInterceptor()

Constructor

Method Details

addResourcePathToClasspath

protected void addResourcePathToClasspath(String thePath,
 String theClasspath)

serveSwaggerUi

public boolean serveSwaggerUi(jakarta.servlet.http.HttpServletRequest theRequest,
 jakarta.servlet.http.HttpServletResponse theResponse,
 ca.uhn.fhir.rest.server.servlet.ServletRequestDetails theRequestDetails)
                       throws IOException

Throws:

IOException

handleResourceRequest

protected boolean handleResourceRequest(jakarta.servlet.http.HttpServletResponse theResponse,
 ca.uhn.fhir.rest.server.servlet.ServletRequestDetails theRequestDetails,
 String requestPath)
                                 throws IOException

Throws:

IOException

removeTrailingSlash

public String removeTrailingSlash(String theUrl)

getCssText

public String getCssText()

If supplied, this field can be used to provide additional CSS text that should be loaded by the swagger-ui page. The contents should be raw CSS text, e.g. BODY { font-size: 1.1em; }

setCssText

public void setCssText(String theCssText)

If supplied, this field can be used to provide additional CSS text that should be loaded by the swagger-ui page. The contents should be raw CSS text, e.g. BODY { font-size: 1.1em; }

populateOIDCVariables

protected void populateOIDCVariables(ca.uhn.fhir.rest.server.servlet.ServletRequestDetails theRequestDetails,
 org.thymeleaf.context.WebContext theContext)

generateOpenApi

protected io.swagger.v3.oas.models.OpenAPI generateOpenApi(ca.uhn.fhir.rest.server.servlet.ServletRequestDetails theRequestDetails)

createResourceDescription

@Nonnull
protected String createResourceDescription(org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementRestResourceComponent theResource)

addSearchOperation

protected void addSearchOperation(io.swagger.v3.oas.models.OpenAPI openApi,
 io.swagger.v3.oas.models.Operation operation,
 ca.uhn.fhir.context.FhirContext ctx,
 String resourceType,
 org.hl7.fhir.r4.model.CapabilityStatement.CapabilityStatementRestResourceComponent nextResource)

getPathItem

protected io.swagger.v3.oas.models.Operation getPathItem(io.swagger.v3.oas.models.Paths thePaths,
 String thePath,
 io.swagger.v3.oas.models.PathItem.HttpMethod theMethod)

getIndexTemplate

protected org.thymeleaf.templateresource.ClassLoaderTemplateResource getIndexTemplate()

getBannerImage

public String getBannerImage()

setBannerImage

public OpenApiInterceptor setBannerImage(String theBannerImage)

isUseResourcePages

public boolean isUseResourcePages()

setUseResourcePages

public void setUseResourcePages(boolean theUseResourcePages)