public class ExceptionHandlingInterceptor extends InterceptorAdapter
IServerInterceptor.ActionRequestDetails| Modifier and Type | Field and Description |
|---|---|
static String |
PROCESSING |
| Constructor and Description |
|---|
ExceptionHandlingInterceptor() |
| Modifier and Type | Method and Description |
|---|---|
Object |
handleException(RequestDetails theRequestDetails,
BaseServerResponseException theException) |
boolean |
handleException(RequestDetails theRequestDetails,
BaseServerResponseException theException,
javax.servlet.http.HttpServletRequest theRequest,
javax.servlet.http.HttpServletResponse theResponse)
This method is called upon any exception being thrown within the server's request processing code.
|
BaseServerResponseException |
preProcessOutgoingException(RequestDetails theRequestDetails,
Throwable theException,
javax.servlet.http.HttpServletRequest theServletRequest)
This method is called upon any exception being thrown within the server's request processing code.
|
ExceptionHandlingInterceptor |
setReturnStackTracesForExceptionTypes(Class<?>... theExceptionTypes)
If any server methods throw an exception which extends any of the given exception types, the exception stack trace will be returned to the user.
|
incomingRequestPostProcessed, incomingRequestPreHandled, incomingRequestPreProcessed, outgoingResponse, outgoingResponse, outgoingResponse, outgoingResponse, outgoingResponse, outgoingResponse, outgoingResponse, outgoingResponsepublic static final String PROCESSING
public ExceptionHandlingInterceptor()
public boolean handleException(RequestDetails theRequestDetails, BaseServerResponseException theException, javax.servlet.http.HttpServletRequest theRequest, javax.servlet.http.HttpServletResponse theResponse) throws javax.servlet.ServletException, IOException
IServerInterceptorSearch and Read methods) as well as
any runtime exceptions thrown by the server itself. This also includes any AuthenticationExceptions
thrown.
Implementations of this method may choose to ignore/log/count/etc exceptions, and return true. In
this case, processing will continue, and the server will automatically generate an OperationOutcome. Implementations may also choose to provide their own response to the client. In this case, they
should return false, to indicate that they have handled the request and processing should stop.
handleException in interface IServerInterceptorhandleException in class InterceptorAdaptertheRequestDetails - 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. Note that the bean
properties are not all guaranteed to be populated, depending on how early during processing the
exception occurred.theRequest - The incoming requesttheResponse - 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.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.javax.servlet.ServletException - If this exception is thrown, it will be re-thrown up to the container for handling.IOException - If this exception is thrown, it will be re-thrown up to the container for handling.public Object handleException(RequestDetails theRequestDetails, BaseServerResponseException theException) throws javax.servlet.ServletException, IOException
javax.servlet.ServletExceptionIOExceptionpublic BaseServerResponseException preProcessOutgoingException(RequestDetails theRequestDetails, Throwable theException, javax.servlet.http.HttpServletRequest theServletRequest) throws javax.servlet.ServletException
IServerInterceptorSearch and Read methods) as well as
any runtime exceptions thrown by the server itself. This method is invoked for each interceptor (until one of them
returns a non-null response or the end of the list is reached), after which
IServerInterceptor.handleException(RequestDetails, BaseServerResponseException, HttpServletRequest, HttpServletResponse) is
called for each interceptor.
This may be used to add an OperationOutcome to a response, or to convert between exception types for any reason.
Implementations of this method may choose to ignore/log/count/etc exceptions, and return null. In
this case, processing will continue, and the server will automatically generate an OperationOutcome. Implementations may also choose to provide their own response to the client. In this case, they
should return a non-null, to indicate that they have handled the request and processing should stop.
preProcessOutgoingException in interface IServerInterceptorpreProcessOutgoingException in class InterceptorAdapternull if this interceptor is not trying to
modify the exception. For example, if this interceptor has nothing to do with exception processing, it
should always return null. If this interceptor adds an OperationOutcome to the exception, it
should return an exception.javax.servlet.ServletExceptionpublic ExceptionHandlingInterceptor setReturnStackTracesForExceptionTypes(Class<?>... theExceptionTypes)
theExceptionTypes - The exception types for which to return the stack trace to the user.Copyright © 2014–2016 University Health Network. All rights reserved.