ca.uhn.fhir.rest.server.interceptor

Class RequestValidatingInterceptor

java.lang.Object

ca.uhn.fhir.rest.server.interceptor.InterceptorAdapter

ca.uhn.fhir.rest.server.interceptor.RequestValidatingInterceptor

All Implemented Interfaces:

IServerInterceptor

public class RequestValidatingInterceptor
extends InterceptorAdapter

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.

Nested Class Summary

Nested classes/interfaces inherited from interface ca.uhn.fhir.rest.server.interceptor.IServerInterceptor

IServerInterceptor.ActionRequestDetails

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_RESPONSE_HEADER_NAME X-HAPI-Request-Validation
static String	DEFAULT_RESPONSE_HEADER_VALUE Default value: ${row}:${col} ${severity} ${message} (${location})

Constructor Summary

Constructors

Constructor and Description
RequestValidatingInterceptor()

Method Summary

Modifier and Type	Method and Description
ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor<T>	addValidatorModule(IValidatorModule theModule)
protected void	fail(RequestDetails theRequestDetails, ValidationResult theValidationResult) Fail the request by throwing an UnprocessableEntityException as a result of a validation failure.
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<IValidatorModule>	getValidatorModules()
boolean	incomingRequestPostProcessed(RequestDetails theRequestDetails, javax.servlet.http.HttpServletRequest theRequest, javax.servlet.http.HttpServletResponse theResponse) This method is called just before the actual implementing server method is invoked.
void	setAddResponseHeaderOnSeverity(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(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(ResultSeverityEnum theSeverity) Sets the minimum severity at which an issue detected by the validator will fail/reject the request.
void	setMaximumHeaderLength(int theMaximumHeaderLength) The maximum length for an individual header.
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	setValidatorModules(List<IValidatorModule> theValidatorModules)
protected void	validate(T theRequest, RequestDetails theRequestDetails)

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

handleException, incomingRequestPreHandled, incomingRequestPreProcessed, outgoingResponse, outgoingResponse, outgoingResponse, outgoingResponse, outgoingResponse, outgoingResponse, outgoingResponse, outgoingResponse, preProcessOutgoingException

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

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 Detail

RequestValidatingInterceptor

public RequestValidatingInterceptor()

Method Detail

incomingRequestPostProcessed

public boolean incomingRequestPostProcessed(RequestDetails theRequestDetails,
                                            javax.servlet.http.HttpServletRequest theRequest,
                                            javax.servlet.http.HttpServletResponse theResponse)
                                     throws AuthenticationException

Description copied from interface: IServerInterceptor

This method is called just before the actual implementing server method is invoked.

Note about exceptions:

Specified by:

incomingRequestPostProcessed in interface IServerInterceptor

Overrides:

incomingRequestPostProcessed in class InterceptorAdapter

Parameters:

theRequestDetails - A bean containing details about the request that is about to be processed, including details such as the resource type and logical ID (if any) and other FHIR-specific aspects of the request which have been pulled out of the servlet request.

theRequest - The incoming request

theResponse - The response. Note that interceptors may choose to provide a response (i.e. by calling ServletResponse.getWriter()) but in that case it is important to return false to indicate that the server itself should not also provide a response.

Returns:

Return true if processing should continue normally. This is generally the right thing to do. If your interceptor is providing a response rather than letting HAPI handle the response normally, you must return false. In this case, no further processing will occur and no further interceptors will be called.

Throws:

AuthenticationException - This exception may be thrown to indicate that the interceptor has detected an unauthorized access attempt. If thrown, processing will stop and an HTTP 401 will be returned to the client.

setResponseHeaderName

public void setResponseHeaderName(String theResponseHeaderName)

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

See Also:

DEFAULT_RESPONSE_HEADER_NAME, setAddResponseHeaderOnSeverity(ResultSeverityEnum)

addValidatorModule

public ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor<T> addValidatorModule(IValidatorModule theModule)

fail

protected void fail(RequestDetails theRequestDetails,
                    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 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.

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.

getResponseOutcomeHeaderName

public String getResponseOutcomeHeaderName()

The name of the header specified by setAddResponseOutcomeHeaderOnSeverity(ResultSeverityEnum)

getValidatorModules

public List<IValidatorModule> getValidatorModules()

setAddResponseHeaderOnSeverity

public void setAddResponseHeaderOnSeverity(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)

setAddResponseOutcomeHeaderOnSeverity

public void setAddResponseOutcomeHeaderOnSeverity(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.

setFailOnSeverity

public void setFailOnSeverity(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.

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.

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)

setResponseOutcomeHeaderName

public void setResponseOutcomeHeaderName(String theResponseOutcomeHeaderName)

The name of the header specified by setAddResponseOutcomeHeaderOnSeverity(ResultSeverityEnum)

setValidatorModules

public void setValidatorModules(List<IValidatorModule> theValidatorModules)

validate

protected void validate(T theRequest,
                        RequestDetails theRequestDetails)