com.atlassian.oai.validator.springmvc

Class OpenApiValidationInterceptor

java.lang.Object

org.springframework.web.servlet.handler.HandlerInterceptorAdapter

com.atlassian.oai.validator.springmvc.OpenApiValidationInterceptor

All Implemented Interfaces:

org.springframework.web.servlet.AsyncHandlerInterceptor, org.springframework.web.servlet.HandlerInterceptor

public class OpenApiValidationInterceptor
extends org.springframework.web.servlet.handler.HandlerInterceptorAdapter

An Interceptor which validates incoming requests against the defined OpenAPI / Swagger specification.

You can customize logging output of interceptor by implementing interface ValidationReportHandler and providing instance to constructor.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.atlassian.oai.validator.springmvc.OpenApiValidationService	openApiValidationService

Constructor Summary

Constructors

Constructor and Description
OpenApiValidationInterceptor(org.springframework.core.io.support.EncodedResource apiSpecification)
OpenApiValidationInterceptor(OpenApiInteractionValidator validator)
OpenApiValidationInterceptor(OpenApiInteractionValidator validator, ValidationReportHandler validationReportHandler)
OpenApiValidationInterceptor(com.atlassian.oai.validator.springmvc.OpenApiValidationService openApiValidationService)
OpenApiValidationInterceptor(com.atlassian.oai.validator.springmvc.OpenApiValidationService openApiValidationService, ValidationReportHandler validationReportHandler)

Method Summary

Modifier and Type	Method and Description
void	postHandle(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse, Object handler, org.springframework.web.servlet.ModelAndView modelAndView) Validates the given response.
boolean	preHandle(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse, Object handler) Validates the given requests.

Methods inherited from class org.springframework.web.servlet.handler.HandlerInterceptorAdapter

afterCompletion, afterConcurrentHandlingStarted

Methods inherited from class java.lang.Object

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

Field Detail

openApiValidationService

protected final com.atlassian.oai.validator.springmvc.OpenApiValidationService openApiValidationService

Constructor Detail

OpenApiValidationInterceptor

public OpenApiValidationInterceptor(@Nonnull
                                    org.springframework.core.io.support.EncodedResource apiSpecification)
                             throws IOException

Throws:

IOException

OpenApiValidationInterceptor

public OpenApiValidationInterceptor(@Nonnull
                                    OpenApiInteractionValidator validator)

OpenApiValidationInterceptor

public OpenApiValidationInterceptor(@Nonnull
                                    OpenApiInteractionValidator validator,
                                    @Nonnull
                                    ValidationReportHandler validationReportHandler)

OpenApiValidationInterceptor

public OpenApiValidationInterceptor(@Nonnull
                                    com.atlassian.oai.validator.springmvc.OpenApiValidationService openApiValidationService)

OpenApiValidationInterceptor

public OpenApiValidationInterceptor(@Nonnull
                                    com.atlassian.oai.validator.springmvc.OpenApiValidationService openApiValidationService,
                                    @Nonnull
                                    ValidationReportHandler validationReportHandler)

Method Detail

preHandle

public boolean preHandle(javax.servlet.http.HttpServletRequest servletRequest,
                         javax.servlet.http.HttpServletResponse servletResponse,
                         Object handler)
                  throws Exception

Validates the given requests. If a request is defined but invalid against the OpenAPI / Swagger specification an InvalidRequestException will be thrown leading to an error response.

Only ResettableRequestServletWrapper can be validated. Wrapping is done within the OpenApiValidationFilter.

Specified by:

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

Overrides:

preHandle in class org.springframework.web.servlet.handler.HandlerInterceptorAdapter

Parameters:

servletRequest - the HttpServletRequest to validate

servletResponse - the servlet response

handler - a handler

Returns:

true if the request is valid against or not defined in the API specification or the servlet is not a ResettableRequestServletWrapper

Throws:

Exception - if the request is invalid against the API specification or the requests body can't be read

postHandle

public void postHandle(javax.servlet.http.HttpServletRequest servletRequest,
                       javax.servlet.http.HttpServletResponse servletResponse,
                       Object handler,
                       org.springframework.web.servlet.ModelAndView modelAndView)
                throws Exception

Validates the given response. If a request is defined but its response is invalid against the OpenAPI / Swagger specification an InvalidResponseException will be thrown leading to an error response.

Only ContentCachingResponseWrapper can be validated. Wrapping is done within the OpenApiValidationFilter.

Specified by:

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

Overrides:

postHandle in class org.springframework.web.servlet.handler.HandlerInterceptorAdapter

Parameters:

servletRequest - the servlet request

servletResponse - the HttpServletResponse to validate

handler - a handler

modelAndView - a model and view

Throws:

Exception - if the response is invalid against the API specification or the response body can't be read