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

Class ResponseValidatingInterceptor

java.lang.Object

ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor<org.hl7.fhir.instance.model.api.IBaseResource>

ca.uhn.fhir.rest.server.interceptor.ResponseValidatingInterceptor

public class ResponseValidatingInterceptor
extends BaseValidatingInterceptor<org.hl7.fhir.instance.model.api.IBaseResource>

This interceptor intercepts each outgoing response and if it contains a FHIR resource, validates that resource. The interceptor may be configured to run any validator modules, and will then add headers to the response or fail the request with an HTTP 422 Unprocessable Entity.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_RESPONSE_HEADER_NAME	X-HAPI-Request-Validation

Fields inherited from class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

DEFAULT_RESPONSE_HEADER_VALUE

Constructor Summary

Constructors

Constructor	Description
ResponseValidatingInterceptor()

Method Summary

Modifier and Type	Method	Description
void	addExcludeOperationType(ca.uhn.fhir.rest.api.RestOperationTypeEnum theOperationType)	Do not validate the following operations.
boolean	outgoingResponse(RequestDetails theRequestDetails, org.hl7.fhir.instance.model.api.IBaseResource theResponseObject)
void	setResponseHeaderName(String theResponseHeaderName)	Sets the name of the response header to add validation failures to

Methods inherited from class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

addValidatorModule, fail, getAddResponseOutcomeHeaderOnSeverity, getMaximumHeaderLength, getResponseOutcomeHeaderName, getValidatorModules, isIgnoreValidatorExceptions, postProcessResult, postProcessResultOnFailure, setAddResponseHeaderOnSeverity, setAddResponseOutcomeHeaderOnSeverity, setFailOnSeverity, setIgnoreValidatorExceptions, setMaximumHeaderLength, setResponseHeaderValue, setResponseHeaderValueNoIssues, setResponseOutcomeHeaderName, setValidatorModules, validate

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RESPONSE_HEADER_NAME

public static final String DEFAULT_RESPONSE_HEADER_NAME

X-HAPI-Request-Validation

See Also:

Constant Field Values

Constructor Detail

ResponseValidatingInterceptor

public ResponseValidatingInterceptor()

Method Detail

addExcludeOperationType

public void addExcludeOperationType(ca.uhn.fhir.rest.api.RestOperationTypeEnum theOperationType)

Do not validate the following operations. A common use for this is to exclude RestOperationTypeEnum.METADATA so that this operation will execute as quickly as possible.

outgoingResponse

public boolean outgoingResponse(RequestDetails theRequestDetails,
                                org.hl7.fhir.instance.model.api.IBaseResource theResponseObject)

setResponseHeaderName

public void setResponseHeaderName(String theResponseHeaderName)

Sets the name of the response header to add validation failures to

Overrides:

setResponseHeaderName in class BaseValidatingInterceptor<org.hl7.fhir.instance.model.api.IBaseResource>

See Also:

DEFAULT_RESPONSE_HEADER_NAME, BaseValidatingInterceptor.setAddResponseHeaderOnSeverity(ResultSeverityEnum)