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

Class BaseValidatingInterceptor<T>

java.lang.Object

ca.uhn.fhir.rest.server.interceptor.ValidationResultEnrichingInterceptor

ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor<T>

Direct Known Subclasses:

RequestValidatingInterceptor, ResponseValidatingInterceptor

public abstract class BaseValidatingInterceptor<T>
extends ValidationResultEnrichingInterceptor

This interceptor intercepts each incoming request 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 final String	DEFAULT_RESPONSE_HEADER_VALUE	Default value: ${row}:${col} ${severity} ${message} (${location})

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

REQUEST_VALIDATION_RESULT

Constructor Summary

Constructors

Constructor	Description
BaseValidatingInterceptor()

Method Summary

Modifier and Type	Method	Description
BaseValidatingInterceptor<T>	addValidatorModule(ca.uhn.fhir.validation.IValidatorModule theModule)	Specify a validator module to use.
protected void	fail(RequestDetails theRequestDetails, ca.uhn.fhir.validation.ValidationResult theValidationResult)	Fail the request by throwing an UnprocessableEntityException as a result of a validation failure.
ca.uhn.fhir.validation.ResultSeverityEnum	getAddResponseOutcomeHeaderOnSeverity()	If the validation produces a result with at least the given severity, a header with the name specified by setResponseOutcomeHeaderName(String) will be added containing a JSON encoded OperationOutcome resource containing the validation results.
int	getMaximumHeaderLength()	The maximum length for an individual header.
String	getResponseOutcomeHeaderName()	The name of the header specified by setAddResponseOutcomeHeaderOnSeverity(ResultSeverityEnum)
List<ca.uhn.fhir.validation.IValidatorModule>	getValidatorModules()
boolean	isIgnoreValidatorExceptions()	If set to true (default is false) this interceptor will exit immediately and allow processing to continue if the validator throws any exceptions.
protected void	postProcessResult(RequestDetails theRequestDetails, ca.uhn.fhir.validation.ValidationResult theValidationResult)	Hook for subclasses (e.g.
protected void	postProcessResultOnFailure(RequestDetails theRequestDetails, ca.uhn.fhir.validation.ValidationResult theValidationResult)	Hook for subclasses on failure (e.g.
void	setAddResponseHeaderOnSeverity(ca.uhn.fhir.validation.ResultSeverityEnum theSeverity)	Sets the minimum severity at which an issue detected by the validator will result in a header being added to the response.
void	setAddResponseOutcomeHeaderOnSeverity(ca.uhn.fhir.validation.ResultSeverityEnum theAddResponseOutcomeHeaderOnSeverity)	If the validation produces a result with at least the given severity, a header with the name specified by setResponseOutcomeHeaderName(String) will be added containing a JSON encoded OperationOutcome resource containing the validation results.
void	setFailOnSeverity(ca.uhn.fhir.validation.ResultSeverityEnum theSeverity)	Sets the minimum severity at which an issue detected by the validator will fail/reject the request.
void	setIgnoreValidatorExceptions(boolean theIgnoreValidatorExceptions)	If set to true (default is false) this interceptor will exit immediately and allow processing to continue if the validator throws any exceptions.
void	setMaximumHeaderLength(int theMaximumHeaderLength)	The maximum length for an individual header.
protected void	setResponseHeaderName(String theResponseHeaderName)	Sets the name of the response header to add validation failures to
void	setResponseHeaderValue(String theResponseHeaderValue)	Sets the value to add to the response header with the name specified by setResponseHeaderName(String) when validation produces a message of severity equal to or greater than setAddResponseHeaderOnSeverity(ResultSeverityEnum)
void	setResponseHeaderValueNoIssues(String theResponseHeaderValueNoIssues)	Sets the header value to add when no issues are found at or exceeding the threshold specified by setAddResponseHeaderOnSeverity(ResultSeverityEnum)
void	setResponseOutcomeHeaderName(String theResponseOutcomeHeaderName)	The name of the header specified by setAddResponseOutcomeHeaderOnSeverity(ResultSeverityEnum)
void	setValidator(ca.uhn.fhir.validation.FhirValidator theValidator)	Provides the validator to use.
void	setValidatorModules(List<ca.uhn.fhir.validation.IValidatorModule> theValidatorModules)
protected ca.uhn.fhir.validation.ValidationResult	validate(T theRequest, RequestDetails theRequestDetails)	Note: May return null

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

addValidationResultsToOperationOutcome, addValidationResultToRequestDetails

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_RESPONSE_HEADER_VALUE

public static final String DEFAULT_RESPONSE_HEADER_VALUE

Default value:
${row}:${col} ${severity} ${message} (${location})

See Also:

• Constant Field Values

Constructor Details

BaseValidatingInterceptor

public BaseValidatingInterceptor()

Method Details

addValidatorModule

public BaseValidatingInterceptor<T> addValidatorModule(ca.uhn.fhir.validation.IValidatorModule theModule)

Specify a validator module to use.

See Also:

• setValidator(FhirValidator)

setValidator

public void setValidator(ca.uhn.fhir.validation.FhirValidator theValidator)

Provides the validator to use. This can be used as an alternative to addValidatorModule(IValidatorModule)

See Also:

• addValidatorModule(IValidatorModule)
• setValidatorModules(List)

fail

protected void fail(RequestDetails theRequestDetails,
 ca.uhn.fhir.validation.ValidationResult theValidationResult)

Fail the request by throwing an UnprocessableEntityException as a result of a validation failure. Subclasses may change this behaviour by providing alternate behaviour.

getAddResponseOutcomeHeaderOnSeverity

public ca.uhn.fhir.validation.ResultSeverityEnum getAddResponseOutcomeHeaderOnSeverity()

If the validation produces a result with at least the given severity, a header with the name specified by setResponseOutcomeHeaderName(String) will be added containing a JSON encoded OperationOutcome resource containing the validation results.

setAddResponseOutcomeHeaderOnSeverity

public void setAddResponseOutcomeHeaderOnSeverity(ca.uhn.fhir.validation.ResultSeverityEnum theAddResponseOutcomeHeaderOnSeverity)

If the validation produces a result with at least the given severity, a header with the name specified by setResponseOutcomeHeaderName(String) will be added containing a JSON encoded OperationOutcome resource containing the validation results.

getMaximumHeaderLength

public int getMaximumHeaderLength()

The maximum length for an individual header. If an individual header would be written exceeding this length, the header value will be truncated.

setMaximumHeaderLength

public void setMaximumHeaderLength(int theMaximumHeaderLength)

The maximum length for an individual header. If an individual header would be written exceeding this length, the header value will be truncated. Value must be greater than 100.

getResponseOutcomeHeaderName

public String getResponseOutcomeHeaderName()

The name of the header specified by setAddResponseOutcomeHeaderOnSeverity(ResultSeverityEnum)

setResponseOutcomeHeaderName

public void setResponseOutcomeHeaderName(String theResponseOutcomeHeaderName)

The name of the header specified by setAddResponseOutcomeHeaderOnSeverity(ResultSeverityEnum)

getValidatorModules

public List<ca.uhn.fhir.validation.IValidatorModule> getValidatorModules()

setValidatorModules

public void setValidatorModules(List<ca.uhn.fhir.validation.IValidatorModule> theValidatorModules)

isIgnoreValidatorExceptions

public boolean isIgnoreValidatorExceptions()

If set to true (default is false) this interceptor will exit immediately and allow processing to continue if the validator throws any exceptions.

This setting is mostly useful in testing situations

setIgnoreValidatorExceptions

public void setIgnoreValidatorExceptions(boolean theIgnoreValidatorExceptions)

If set to true (default is false) this interceptor will exit immediately and allow processing to continue if the validator throws any exceptions.

This setting is mostly useful in testing situations

setAddResponseHeaderOnSeverity

public void setAddResponseHeaderOnSeverity(ca.uhn.fhir.validation.ResultSeverityEnum theSeverity)

Sets the minimum severity at which an issue detected by the validator will result in a header being added to the response. Default is ResultSeverityEnum.INFORMATION. Set to null to disable this behaviour.

See Also:

• setResponseHeaderName(String)
• setResponseHeaderValue(String)

setFailOnSeverity

public void setFailOnSeverity(ca.uhn.fhir.validation.ResultSeverityEnum theSeverity)

Sets the minimum severity at which an issue detected by the validator will fail/reject the request. Default is ResultSeverityEnum.ERROR. Set to null to disable this behaviour.

setResponseHeaderName

protected void setResponseHeaderName(String theResponseHeaderName)

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

See Also:

• setAddResponseHeaderOnSeverity(ResultSeverityEnum)

setResponseHeaderValue

public void setResponseHeaderValue(String theResponseHeaderValue)

Sets the value to add to the response header with the name specified by setResponseHeaderName(String) when validation produces a message of severity equal to or greater than setAddResponseHeaderOnSeverity(ResultSeverityEnum)

This field allows the following substitutions:

Name	Value
${line}	The line in the request
${col}	The column in the request
${location}	The location in the payload as a string (typically this will be a path)
${severity}	The severity of the issue
${message}	The validation message

See Also:

• DEFAULT_RESPONSE_HEADER_VALUE
• setAddResponseHeaderOnSeverity(ResultSeverityEnum)

setResponseHeaderValueNoIssues

public void setResponseHeaderValueNoIssues(String theResponseHeaderValueNoIssues)

Sets the header value to add when no issues are found at or exceeding the threshold specified by setAddResponseHeaderOnSeverity(ResultSeverityEnum)

postProcessResult

protected void postProcessResult(RequestDetails theRequestDetails,
 ca.uhn.fhir.validation.ValidationResult theValidationResult)

Hook for subclasses (e.g. add a tag (coding) to an incoming resource when a given severity appears in the ValidationResult).

postProcessResultOnFailure

protected void postProcessResultOnFailure(RequestDetails theRequestDetails,
 ca.uhn.fhir.validation.ValidationResult theValidationResult)

Hook for subclasses on failure (e.g. add a response header to an incoming resource upon rejection).

validate

protected ca.uhn.fhir.validation.ValidationResult validate(T theRequest,
 RequestDetails theRequestDetails)

Note: May return null