ca.uhn.fhir.rest.server.interceptor

Class ResponseHighlighterInterceptor

java.lang.Object

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

ca.uhn.fhir.rest.server.interceptor.ResponseHighlighterInterceptor

All Implemented Interfaces:

IServerInterceptor

public class ResponseHighlighterInterceptor
extends InterceptorAdapter

This interceptor detects when a request is coming from a browser, and automatically returns a response with syntax highlighted (coloured) HTML for the response instead of just returning raw XML/JSON.

Since:

1.0

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	PARAM_RAW
static String	PARAM_RAW_TRUE

Constructor Summary

Constructors

Constructor and Description
ResponseHighlighterInterceptor()

Method Summary

Modifier and Type	Method and Description
boolean	handleException(RequestDetails theRequestDetails, BaseServerResponseException theException, javax.servlet.http.HttpServletRequest theServletRequest, javax.servlet.http.HttpServletResponse theServletResponse) This method is called upon any exception being thrown within the server's request processing code.
boolean	outgoingResponse(RequestDetails theRequestDetails, IBaseResource theResponseObject, javax.servlet.http.HttpServletRequest theServletRequest, javax.servlet.http.HttpServletResponse theServletResponse) This method is called after the server implementation method has been called, but before any attempt to stream the response back to the client

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

incomingRequestPostProcessed, incomingRequestPreHandled, incomingRequestPreProcessed, 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

PARAM_RAW_TRUE

public static final String PARAM_RAW_TRUE

See Also:

Constant Field Values

PARAM_RAW

public static final String PARAM_RAW

See Also:

Constant Field Values

Constructor Detail

ResponseHighlighterInterceptor

public ResponseHighlighterInterceptor()

Method Detail

outgoingResponse

public boolean outgoingResponse(RequestDetails theRequestDetails,
                                IBaseResource theResponseObject,
                                javax.servlet.http.HttpServletRequest theServletRequest,
                                javax.servlet.http.HttpServletResponse theServletResponse)
                         throws AuthenticationException

Description copied from interface: IServerInterceptor

This method is called after the server implementation method has been called, but before any attempt to stream the response back to the client

Specified by:

outgoingResponse in interface IServerInterceptor

Overrides:

outgoingResponse 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.

theResponseObject - The actual object which is being streamed to the client as a response

theServletRequest - The incoming request

theServletResponse - 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.

handleException

public boolean handleException(RequestDetails theRequestDetails,
                               BaseServerResponseException theException,
                               javax.servlet.http.HttpServletRequest theServletRequest,
                               javax.servlet.http.HttpServletResponse theServletResponse)
                        throws javax.servlet.ServletException,
                               IOException

Description copied from interface: IServerInterceptor

This method is called upon any exception being thrown within the server's request processing code. This includes any exceptions thrown within resource provider methods (e.g. Search 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.

Specified by:

handleException in interface IServerInterceptor

Overrides:

handleException 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. Note that the bean properties are not all guaranteed to be populated, depending on how early during processing the exception occurred.

theServletRequest - The incoming request

theServletResponse - 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:

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.