org.spf4j.maven.plugin.avro.avscp

Class SchemaValidatorMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.spf4j.maven.plugin.avro.avscp.SchemaMojoBase

org.spf4j.maven.plugin.avro.avscp.SchemaValidatorMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, ValidatorMojo

@Mojo(name="avro-validate",
      defaultPhase=TEST,
      requiresProject=true)
public final class SchemaValidatorMojo
extends SchemaMojoBase
implements ValidatorMojo

Mojo that runs all Schema validators on this project schemas

Built in validators:

• docValidator (schema documentation),
• compatibility (schema compatibility),
• namesValidator (schema named types and field name validation)

By default validation issues will fail the build. This can be disabled at validator level with:

 
 <validatorConfigs>
  <[validatorName].failOnIssue></[validatorName].failOnIssue>
 </validatorConfigs>
 
 

A particular validator can be sckipped at schema level with:

  @ignoreValidators(["validatorname"])

 

Custom validators can be built and used. A custom validator, will need to implement the org.spf4j.maven.plugin.avro.avscp.validation.Validator interface, and will be loaded via the java Service Loader api.

See Also:

Interface to implement a custom validator., Built in validator implementations.

Field Summary

Fields inherited from class org.spf4j.maven.plugin.avro.avscp.SchemaMojoBase

dependenciesDirectory, generatedAvscTarget, generatedJavaTarget, mavenProject, mavenSession, repoSystem, sourceDirectory, target

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
SchemaValidatorMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
String[]	getSchemaFiles()
Map<String,String>	getValidatorConfigs()
void	handleValidation(Map<String,Validator.Result> vresult, org.apache.maven.plugin.logging.Log logger, String detail)
String	toString() will be overwritten as needed, and override will include this result.

Methods inherited from class org.spf4j.maven.plugin.avro.avscp.SchemaMojoBase

getGeneratedAvscTarget, getMavenProject, getMavenSession, getRepoSystem, getTarget

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.spf4j.maven.plugin.avro.avscp.ValidatorMojo

getGeneratedAvscTarget, getLog, getMavenProject, getMavenSession, getRepoSystem, getTarget

Constructor Detail

SchemaValidatorMojo

public SchemaValidatorMojo()

Method Detail

getValidatorConfigs

public Map<String,String> getValidatorConfigs()

Specified by:

getValidatorConfigs in interface ValidatorMojo

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

handleValidation

public void handleValidation(Map<String,Validator.Result> vresult,
                             org.apache.maven.plugin.logging.Log logger,
                             String detail)
                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getSchemaFiles

public String[] getSchemaFiles()

toString

public String toString()

Description copied from class: SchemaMojoBase

will be overwritten as needed, and override will include this result.

Overrides:

toString in class SchemaMojoBase