Package ca.uhn.fhir.rest.server.interceptor

Class ResponseHighlighterInterceptor

java.lang.Object

ca.uhn.fhir.rest.server.interceptor.ResponseHighlighterInterceptor

public class ResponseHighlighterInterceptor
extends Object

This interceptor detects when a request is coming from a browser, and automatically returns a response with syntax highlighted (coloured) HTML for the response instead of just returning raw XML/JSON.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_RAW	TODO: As of HAPI 1.6 (2016-06-10) this parameter has been replaced with simply requesting _format=json or xml so eventually this parameter should be removed
static final String	PARAM_RAW_TRUE

Constructor Summary

Constructors

Constructor	Description
ResponseHighlighterInterceptor()	Constructor

Method Summary

Modifier and Type	Method	Description
void	capabilityStatementGenerated(RequestDetails theRequestDetails, org.hl7.fhir.instance.model.api.IBaseConformance theCapabilityStatement)
boolean	handleException(RequestDetails theRequestDetails, ca.uhn.fhir.rest.server.exceptions.BaseServerResponseException theException, javax.servlet.http.HttpServletRequest theServletRequest, javax.servlet.http.HttpServletResponse theServletResponse)
boolean	isShowRequestHeaders()	If set to true (default is false) response will include the request headers
boolean	isShowResponseHeaders()	If set to true (default is true) response will include the response headers
boolean	outgoingGraphqlResponse(RequestDetails theRequestDetails, String theRequest, String theResponse, javax.servlet.http.HttpServletRequest theServletRequest, javax.servlet.http.HttpServletResponse theServletResponse)
boolean	outgoingResponse(RequestDetails theRequestDetails, ResponseDetails theResponseObject, javax.servlet.http.HttpServletRequest theServletRequest, javax.servlet.http.HttpServletResponse theServletResponse)
ResponseHighlighterInterceptor	setShowRequestHeaders(boolean theShowRequestHeaders)	If set to true (default is false) response will include the request headers
ResponseHighlighterInterceptor	setShowResponseHeaders(boolean theShowResponseHeaders)	If set to true (default is true) response will include the response headers

Methods inherited from class java.lang.Object

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

Field Details

PARAM_RAW

public static final String PARAM_RAW

TODO: As of HAPI 1.6 (2016-06-10) this parameter has been replaced with simply requesting _format=json or xml so eventually this parameter should be removed

See Also:

• Constant Field Values

PARAM_RAW_TRUE

public static final String PARAM_RAW_TRUE

See Also:

• Constant Field Values

Constructor Details

ResponseHighlighterInterceptor

public ResponseHighlighterInterceptor()

Constructor

Method Details

handleException

public boolean handleException(RequestDetails theRequestDetails,
 ca.uhn.fhir.rest.server.exceptions.BaseServerResponseException theException,
 javax.servlet.http.HttpServletRequest theServletRequest,
 javax.servlet.http.HttpServletResponse theServletResponse)

isShowRequestHeaders

public boolean isShowRequestHeaders()

If set to true (default is false) response will include the request headers

setShowRequestHeaders

public ResponseHighlighterInterceptor setShowRequestHeaders(boolean theShowRequestHeaders)

If set to true (default is false) response will include the request headers

Returns:

Returns a reference to this for easy method chaining

isShowResponseHeaders

public boolean isShowResponseHeaders()

If set to true (default is true) response will include the response headers

setShowResponseHeaders

public ResponseHighlighterInterceptor setShowResponseHeaders(boolean theShowResponseHeaders)

If set to true (default is true) response will include the response headers

Returns:

Returns a reference to this for easy method chaining

outgoingGraphqlResponse

public boolean outgoingGraphqlResponse(RequestDetails theRequestDetails,
 String theRequest,
 String theResponse,
 javax.servlet.http.HttpServletRequest theServletRequest,
 javax.servlet.http.HttpServletResponse theServletResponse)
                                throws ca.uhn.fhir.rest.server.exceptions.AuthenticationException

Throws:

ca.uhn.fhir.rest.server.exceptions.AuthenticationException

outgoingResponse

public boolean outgoingResponse(RequestDetails theRequestDetails,
 ResponseDetails theResponseObject,
 javax.servlet.http.HttpServletRequest theServletRequest,
 javax.servlet.http.HttpServletResponse theServletResponse)
                         throws ca.uhn.fhir.rest.server.exceptions.AuthenticationException

Throws:

ca.uhn.fhir.rest.server.exceptions.AuthenticationException

capabilityStatementGenerated

public void capabilityStatementGenerated(RequestDetails theRequestDetails,
 org.hl7.fhir.instance.model.api.IBaseConformance theCapabilityStatement)