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

Class BanUnsupportedHttpMethodsInterceptor

java.lang.Object

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

ca.uhn.fhir.rest.server.interceptor.BanUnsupportedHttpMethodsInterceptor

All Implemented Interfaces:

IServerInterceptor

public class BanUnsupportedHttpMethodsInterceptor
extends InterceptorAdapter

This interceptor causes the server to reject invocations for HTTP methods other than those supported by the server with an HTTP 405. This is a requirement of some security assessments.

Nested Class Summary

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

IServerInterceptor.ActionRequestDetails

Constructor Summary

Constructors

Constructor	Description
BanUnsupportedHttpMethodsInterceptor()

Method Summary

Modifier and Type	Method	Description
boolean	incomingRequestPreProcessed(javax.servlet.http.HttpServletRequest theRequest, javax.servlet.http.HttpServletResponse theResponse)	This method is called before any other processing takes place for each incoming request.

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

handleException, incomingRequestPostProcessed, incomingRequestPreHandled, outgoingResponse, outgoingResponse, outgoingResponse, outgoingResponse, outgoingResponse, outgoingResponse, outgoingResponse, preProcessOutgoingException, processingCompletedNormally

Methods inherited from class java.lang.Object

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

Constructor Detail

BanUnsupportedHttpMethodsInterceptor

public BanUnsupportedHttpMethodsInterceptor()

Method Detail

incomingRequestPreProcessed

public boolean incomingRequestPreProcessed(javax.servlet.http.HttpServletRequest theRequest,
                                           javax.servlet.http.HttpServletResponse theResponse)

Description copied from interface: IServerInterceptor

This method is called before any other processing takes place for each incoming request. It may be used to provide alternate handling for some requests, or to screen requests before they are handled, etc.

Note that any exceptions thrown by this method will not be trapped by HAPI (they will be passed up to the server)

Specified by:

incomingRequestPreProcessed in interface IServerInterceptor

Overrides:

incomingRequestPreProcessed in class InterceptorAdapter

Parameters:

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.