ca.uhn.fhir.rest.server.interceptor

Class LoggingInterceptor

java.lang.Object

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

ca.uhn.fhir.rest.server.interceptor.LoggingInterceptor

All Implemented Interfaces:

IServerInterceptor

public class LoggingInterceptor
extends InterceptorAdapter

Server interceptor which logs each request using a defined format

The following substitution variables are supported:

${id}	The resource ID associated with this request (or "" if none)
${idOrResourceName}	The resource ID associated with this request, or the resource name if the request applies to a type but not an instance, or "" otherwise
${operationName}	If the request is an extended operation (e.g. "$validate") this value will be the operation name, or "" otherwise
${operationType}	A code indicating the operation type for this request, e.g. "read", "history-instance", "extended-operation-instance", etc.)
${remoteAddr}	The originaring IP of the request
${requestHeader.XXXX}	The value of the HTTP request header named XXXX. For example, a substitution variable named "${requestHeader.x-forwarded-for} will yield the value of the first header named "x-forwarded-for ", or "" if none.
${requestParameters}	The HTTP request parameters (or "")
${responseEncodingNoDefault}	The encoding format requested by the client via the _format parameter or the Accept header. Value will be "json" or "xml", or "" if the client did not explicitly request a format
${servletPath}	The part of thre requesting URL that corresponds to the particular Servlet being called (see HttpServletRequest.getServletPath())
${requestUrl}	The complete URL of the request
${requestVerb}	The HTTP verb of the request
${exceptionMessage}	Applies only to an error message: The message from Throwable.getMessage()

Nested Class Summary

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

IServerInterceptor.ActionRequestDetails

Constructor Summary

Constructors

Constructor and Description
LoggingInterceptor()

Method Summary

Modifier and Type	Method and Description
String	getErrorMessageFormat() Get the log message format to be used when logging exceptions
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	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.
boolean	isLogExceptions() Should exceptions be logged by this logger
void	setErrorMessageFormat(String theErrorMessageFormat) Set the log message format to be used when logging exceptions
void	setLogExceptions(boolean theLogExceptions) Should exceptions be logged by this logger
void	setLogger(org.slf4j.Logger theLogger)
void	setLoggerName(String theLoggerName)
void	setMessageFormat(String theMessageFormat) Sets the message format itself.

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

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

Constructor Detail

LoggingInterceptor

public LoggingInterceptor()

Method Detail

getErrorMessageFormat

public String getErrorMessageFormat()

Get the log message format to be used when logging exceptions

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.

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.

isLogExceptions

public boolean isLogExceptions()

Should exceptions be logged by this logger

setErrorMessageFormat

public void setErrorMessageFormat(String theErrorMessageFormat)

Set the log message format to be used when logging exceptions

setLogExceptions

public void setLogExceptions(boolean theLogExceptions)

Should exceptions be logged by this logger

setLogger

public void setLogger(org.slf4j.Logger theLogger)

setLoggerName

public void setLoggerName(String theLoggerName)

setMessageFormat

public void setMessageFormat(String theMessageFormat)

Sets the message format itself. See the class documentation for information on the format