io.apicurio.datamodels.core.validation

Class ValidationRule

java.lang.Object

io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor

io.apicurio.datamodels.core.validation.ValidationRule

All Implemented Interfaces:

IAai20Visitor, IAaiVisitor, IVisitor, IOas20Visitor, IOas30Visitor, IOasVisitor

Direct Known Subclasses:

OasBodyAndFormDataMutualExclusivityRule, OasBodyParameterUniquenessValidationRule, OasExampleValueMutualExclusivityRule, OasHeaderExamplesMutualExclusivityRule, OasHeaderSchemaContentMutualExclusivityRule, OasIgnoredContentTypeHeaderRule, OasIgnoredHeaderParameterRule, OasInvalidApiBasePathRule, OasInvalidApiDescriptionRule, OasInvalidApiHostRule, OasInvalidCallbackReferenceRule, OasInvalidContactEmailRule, OasInvalidContactUrlRule, OasInvalidExampleDescriptionRule, OasInvalidExampleReferenceRule, OasInvalidExternalDocsDescriptionRule, OasInvalidExternalDocsUrlRule, OasInvalidHeaderDefaultValueRule, OasInvalidHeaderDescriptionRule, OasInvalidHeaderReferenceRule, OasInvalidLicenseUrlRule, OasInvalidLinkDescriptionRule, OasInvalidLinkOperationReferenceRule, OasInvalidLinkReferenceRule, OasInvalidOAuthAuthorizationUrlRule, OasInvalidOAuthRefreshUrlRule, OasInvalidOAuthTokenUrlRule, OasInvalidOpenIDConnectUrlRule, OasInvalidOperationConsumesRule, OasInvalidOperationDescriptionRule, OasInvalidOperationProducesRule, OasInvalidParameterDescriptionRule, OasInvalidParameterReferenceRule, OasInvalidPathItemDescriptionRule, OasInvalidPathItemReferenceRule, OasInvalidPropertyNameRule, OasInvalidPropertyTypeValidationRule, OasInvalidPropertyValueRule, OasInvalidRequestBodyDescriptionRule, OasInvalidRequestBodyReferenceRule, OasInvalidResponseDescriptionRule, OasInvalidResponseReferenceRule, OasInvalidSchemaItemsDefaultValueRule, OasInvalidSchemaReferenceRule, OasInvalidSecurityRequirementNameRule, OasInvalidSecuritySchemeAuthUrlRule, OasInvalidSecuritySchemeDescriptionRule, OasInvalidSecuritySchemeReferenceRule, OasInvalidSecuritySchemeTokenUrlRule, OasInvalidServerDescriptionRule, OasInvalidServerUrlRule, OasInvalidServerVariableDescriptionRule, OasInvalidTagDescriptionRule, OasInvalidTermsOfServiceUrlRule, OasInvalidXmlNamespaceUrlRule, OasLinkOperationRefMutualExclusivityRule, OasMediaTypeExamplesMutualExclusivityRule, OasOperationIdUniquenessValidationRule, OasParameterExamplesMutualExclusivityRule, OasParameterSchemaContentMutualExclusivityRule, OasParameterUniquenessValidationRule, OasRequiredPropertyValidationRule, OasTagUniquenessValidationRule, OasUnknownPropertyRule, RequiredPropertyValidationRule

public abstract class ValidationRule
extends CombinedAllNodeVisitor
implements IVisitor

Base class for all validation rule implementations.

Author:

eric.wittmann@gmail.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValidationRule.PathSegment Type encapsulating information about a path segment.

Constructor Summary

Constructors

Constructor and Description
ValidationRule(ValidationRuleMetaData ruleInfo) Constructor.

Method Summary

Modifier and Type	Method and Description
protected String[]	array(String... args) Creates an array.
protected boolean	equals(Object value1, Object value2) Returns true if the two values are equal.
protected List<ValidationRule.PathSegment>	getPathSegments(String pathTemplate) Finds all occurences of path segment patterns in a path template.
protected boolean	hasValue(Object propertyValue) Check if the property value exists (is not undefined and is not null).
protected boolean	isDefined(Object propertyValue) Check if a property was defined.
protected boolean	isNullOrUndefined(Object value) Check if a value is either null or undefined.
protected boolean	isPathWellFormed(String pathTemplate) Checks the path template against the regular expression and returns match result.
protected boolean	isValidCommonMark(String propertyValue) Returns true only if the given value is valid CommonMark style markup.
protected boolean	isValidEmailAddress(String propertyValue) Returns true only if the given value is a valid email address.
protected boolean	isValidEnumItem(String value, String[] items) Returns true if the given value is an item in the enum list.
protected boolean	isValidForType(Object value, Node node) Returns true if the given value is valid according to the schema provided.
protected boolean	isValidGFM(String propertyValue) Returns true only if the given value is valid GFM style markup.
protected boolean	isValidHttpCode(String statusCode) Returns true if the given status code is a valid HTTP response code.
protected boolean	isValidMimeType(List<String> propertyValue) Returns true only if the given value is a valid mime-type.
protected boolean	isValidUrl(String propertyValue) Returns true only if the given value is a valid URL.
protected boolean	isValidUrlTemplate(String propertyValue) Returns true only if the given value is a valid URL template.
protected Map<String,String>	map(String... args) Turns a list of args into a map suitable for use as template arguments.
protected void	report(Node node, String property, Map<String,String> messageParams) Called by validation rules to report an error.
protected void	reportIf(boolean condition, Node node, String property, Map<String,String> messageParams) Reports a validation error if the given condition is true.
protected void	reportIfInvalid(boolean isValid, Node node, String property, Map<String,String> messageParams) Reports a validation error if the property is not valid.
protected void	reportPathError(Node node, Map<String,String> messageParams) Utility function to report path related errors.
void	setReporter(IValidationProblemReporter reporter) Sets the validation problem reporter.

Methods inherited from class io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor

visitAaiParameter, visitAdditionalPropertiesSchema, visitAllOfSchema, visitAnyOfSchema, visitAuthorizationCodeOAuthFlow, visitAuthorizationCodeOAuthFlow, visitCallback, visitCallbackDefinition, visitCallbackPathItem, visitChannelItem, visitClientCredentialsOAuthFlow, visitClientCredentialsOAuthFlow, visitComponents, visitContact, visitCorrelationId, visitDefinitions, visitDiscriminator, visitDocument, visitEncoding, visitExample, visitExample, visitExampleDefinition, visitExtension, visitExternalDocumentation, visitHeader, visitHeaderDefinition, visitHeaderItem, visitHeaders, visitImplicitOAuthFlow, visitImplicitOAuthFlow, visitInfo, visitItems, visitItemsSchema, visitLicense, visitLink, visitLinkDefinition, visitLinkParameterExpression, visitLinkRequestBodyExpression, visitLinkServer, visitMediaType, visitMessage, visitMessageTrait, visitMessageTraitExtendedItem, visitMessageTraitItems, visitNode, visitNotSchema, visitOAuthFlows, visitOAuthFlows, visitOneOfSchema, visitOperation, visitOperationTrait, visitOperationTraitExtendedItem, visitOperationTraitItems, visitParameter, visitParameterDefinition, visitParameterDefinitions, visitPasswordOAuthFlow, visitPasswordOAuthFlow, visitPathItem, visitPaths, visitPropertySchema, visitProtocolInfo, visitRequestBody, visitRequestBodyDefinition, visitResponse, visitResponseDefinition, visitResponseDefinitions, visitResponses, visitSchema, visitSchemaDefinition, visitScopes, visitSecurityDefinitions, visitSecurityRequirement, visitSecurityScheme, visitServer, visitServerVariable, visitTag, visitUnknownTrait, visitValidationProblem, visitXML

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.apicurio.datamodels.core.visitors.IVisitor

visitContact, visitDocument, visitExtension, visitExternalDocumentation, visitInfo, visitLicense, visitOperation, visitParameter, visitParameterDefinition, visitSchema, visitSchemaDefinition, visitSecurityRequirement, visitSecurityScheme, visitTag, visitValidationProblem

Constructor Detail

ValidationRule

public ValidationRule(ValidationRuleMetaData ruleInfo)

Constructor.

Parameters:

ruleInfo -

Method Detail

setReporter

public void setReporter(IValidationProblemReporter reporter)

Sets the validation problem reporter.

Parameters:

reporter -

report

protected void report(Node node,
                      String property,
                      Map<String,String> messageParams)

Called by validation rules to report an error.

Parameters:

node -

property -

messageParams -

reportIfInvalid

protected void reportIfInvalid(boolean isValid,
                               Node node,
                               String property,
                               Map<String,String> messageParams)

Reports a validation error if the property is not valid.

Parameters:

isValid -

node -

property -

messageParams -

reportIf

protected void reportIf(boolean condition,
                        Node node,
                        String property,
                        Map<String,String> messageParams)

Reports a validation error if the given condition is true.

Parameters:

condition -

node -

property -

messageParams -

reportPathError

protected void reportPathError(Node node,
                               Map<String,String> messageParams)

Utility function to report path related errors.

Parameters:

node -

messageParams -

isDefined

protected boolean isDefined(Object propertyValue)

Check if a property was defined.

Parameters:

propertyValue -

Returns:

{boolean}

hasValue

protected boolean hasValue(Object propertyValue)

Check if the property value exists (is not undefined and is not null).

Parameters:

propertyValue -

Returns:

{boolean}

isPathWellFormed

protected boolean isPathWellFormed(String pathTemplate)

Checks the path template against the regular expression and returns match result.

Parameters:

pathTemplate -

Returns:

{boolean}

getPathSegments

protected List<ValidationRule.PathSegment> getPathSegments(String pathTemplate)

Finds all occurences of path segment patterns in a path template.

Parameters:

pathTemplate -

Returns:

{PathSegment[]}

isNullOrUndefined

protected boolean isNullOrUndefined(Object value)

Check if a value is either null or undefined.

Parameters:

value -

Returns:

{boolean}

isValidUrl

protected boolean isValidUrl(String propertyValue)

Returns true only if the given value is a valid URL.

Parameters:

propertyValue -

Returns:

{boolean}

isValidUrlTemplate

protected boolean isValidUrlTemplate(String propertyValue)

Returns true only if the given value is a valid URL template.

Parameters:

propertyValue -

isValidGFM

protected boolean isValidGFM(String propertyValue)

Returns true only if the given value is valid GFM style markup.

Parameters:

propertyValue -

isValidCommonMark

protected boolean isValidCommonMark(String propertyValue)

Returns true only if the given value is valid CommonMark style markup.

Parameters:

propertyValue -

isValidEmailAddress

protected boolean isValidEmailAddress(String propertyValue)

Returns true only if the given value is a valid email address.

Parameters:

propertyValue -

isValidMimeType

protected boolean isValidMimeType(List<String> propertyValue)

Returns true only if the given value is a valid mime-type.

Parameters:

propertyValue -

isValidEnumItem

protected boolean isValidEnumItem(String value,
                                  String[] items)

Returns true if the given value is an item in the enum list.

Parameters:

value -

items -

isValidForType

protected boolean isValidForType(Object value,
                                 Node node)

Returns true if the given value is valid according to the schema provided.

Parameters:

value -

node -

isValidHttpCode

protected boolean isValidHttpCode(String statusCode)

Returns true if the given status code is a valid HTTP response code.

Parameters:

statusCode -

map

protected Map<String,String> map(String... args)

Turns a list of args into a map suitable for use as template arguments. The args must come in pairs of "key, value". For example: map("key1", "value1", "key2", Boolean.TRUE); That would return a Map two mappings.

array

protected String[] array(String... args)

Creates an array.

Parameters:

args -

equals

protected boolean equals(Object value1,
                         Object value2)

Returns true if the two values are equal.

Parameters:

value1 -

value2 -