Package org.citrusframework.http.interceptor

Class LoggingHandlerInterceptor

java.lang.Object

org.citrusframework.http.interceptor.LoggingHandlerInterceptor

All Implemented Interfaces:

org.springframework.web.servlet.HandlerInterceptor

public class LoggingHandlerInterceptor
extends Object
implements org.springframework.web.servlet.HandlerInterceptor

Logging interceptor called by Spring MVC for each controller handling a RESTful Http request as a server. Interceptor is capable of informing message tracing test listener on the request and response messages arriving and leaving Citrus.

Since:

1.2

Author:

Christoph Deppisch

Constructor Summary

Constructors

Constructor	Description
LoggingHandlerInterceptor()

Method Summary

Modifier and Type	Method	Description
void	afterCompletion(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Object handler, Exception ex)
void	handleRequest(String request)	Handle request message and write request to logger.
void	handleResponse(String response)	Handle response message and write content to logger.
boolean	hasMessageListeners()	Checks if message listeners are present on this interceptor.
void	postHandle(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Object handler, org.springframework.web.servlet.ModelAndView modelAndView)
boolean	preHandle(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Object handler)
void	setMessageListener(MessageListeners messageListener)	Specifies the message listeners.

Methods inherited from class java.lang.Object

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

Constructor Details

LoggingHandlerInterceptor

public LoggingHandlerInterceptor()

Method Details

preHandle

public boolean preHandle(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Object handler)
                  throws Exception

Specified by:

preHandle in interface org.springframework.web.servlet.HandlerInterceptor

Throws:

Exception

postHandle

public void postHandle(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Object handler,
 org.springframework.web.servlet.ModelAndView modelAndView)
                throws Exception

Specified by:

postHandle in interface org.springframework.web.servlet.HandlerInterceptor

Throws:

Exception

afterCompletion

public void afterCompletion(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Object handler,
 Exception ex)
                     throws Exception

Specified by:

afterCompletion in interface org.springframework.web.servlet.HandlerInterceptor

Throws:

Exception

handleRequest

public void handleRequest(String request)

Handle request message and write request to logger.

Parameters:

request -

handleResponse

public void handleResponse(String response)

Handle response message and write content to logger.

Parameters:

response -

hasMessageListeners

public boolean hasMessageListeners()

Checks if message listeners are present on this interceptor.

Returns:

setMessageListener

public void setMessageListener(MessageListeners messageListener)

Specifies the message listeners.

Parameters:

messageListener -