com.atlassian.oai.validator.springmvc

Class DefaultValidationReportHandler

java.lang.Object

com.atlassian.oai.validator.springmvc.DefaultValidationReportHandler

All Implemented Interfaces:

ValidationReportHandler

public class DefaultValidationReportHandler
extends Object
implements ValidationReportHandler

Default implementation of ValidationReportHandler. It logs request/response validation findings to project logger. In case of:

• error - throws InvalidRequestException for request or InvalidResponseException for response and write messages to log.error
• info/warn/ignore - write messages to log.info
• no issue - log.debug end of validation

When you would like to modify messages format you can implement your own ValidationReportFormat and inject it to constructor.

Constructor Summary

Constructors

Constructor and Description
DefaultValidationReportHandler()
DefaultValidationReportHandler(ValidationReportFormat validationReportFormat)

Method Summary

Modifier and Type	Method and Description
protected RuntimeException	createValidationException(ValidationReport validationReport, ValidationReport.MessageContext.Location location)
void	handleRequestReport(String loggingKey, ValidationReport validationReport) Method which gives you way how to override logging of request validation issues.
void	handleResponseReport(String loggingKey, ValidationReport validationReport) Method which gives you way how to override logging of response validation issues.
protected void	logApiValidation(BiConsumer<String,String[]> logConsumer, ValidationReport.MessageContext.Location location, String loggingKey, Set<ValidationReport.Level> validationLevels, String message)
protected void	processApiValidationReport(ValidationReport.MessageContext.Location location, String loggingKey, ValidationReport validationReport)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultValidationReportHandler

public DefaultValidationReportHandler()

DefaultValidationReportHandler

public DefaultValidationReportHandler(@Nonnull
                                      ValidationReportFormat validationReportFormat)

Method Detail

handleRequestReport

public void handleRequestReport(String loggingKey,
                                ValidationReport validationReport)

Description copied from interface: ValidationReportHandler

Method which gives you way how to override logging of request validation issues.

Specified by:

handleRequestReport in interface ValidationReportHandler

Parameters:

loggingKey - request identifier - method and request path

validationReport - result of validation

handleResponseReport

public void handleResponseReport(String loggingKey,
                                 ValidationReport validationReport)

Description copied from interface: ValidationReportHandler

Method which gives you way how to override logging of response validation issues.

Specified by:

handleResponseReport in interface ValidationReportHandler

Parameters:

loggingKey - request identifier - method and request path

validationReport - result of validation

processApiValidationReport

protected void processApiValidationReport(ValidationReport.MessageContext.Location location,
                                          String loggingKey,
                                          ValidationReport validationReport)

logApiValidation

protected void logApiValidation(BiConsumer<String,String[]> logConsumer,
                                ValidationReport.MessageContext.Location location,
                                String loggingKey,
                                Set<ValidationReport.Level> validationLevels,
                                String message)

createValidationException

protected RuntimeException createValidationException(ValidationReport validationReport,
                                                     ValidationReport.MessageContext.Location location)