Package org.alfresco.maven.plugin

Class ValidateMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.alfresco.maven.plugin.ValidateMojo

All Implemented Interfaces:

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

public class ValidateMojo
extends org.apache.maven.plugin.AbstractMojo

This goal provides the EXPERIMENTAL feature of validating your AMP module (source and binaries) against Alfresco (Repository and Share) development best practices, providing validation and alerts that can be used to improve quality, longevity and supportability of your code. It uses the ATV (Alfresco Technical Validation https://github.com/AlfrescoLabs/technical-validation)

Since:

2.0.0-beta-2

Version:

$Id:$

Goal:

validate

Description:

Invokes the Alfresco Technical Validation (https://github.com/AlfrescoLabs/technical-validation) of your customization

Phase:

verify

Requires Project:

Thread-Safe:

Field Summary

Fields

Modifier and Type	Field	Description
protected String	binaryLocation	The directory where the binary AMP package is to be found
protected String	neo4jUrl	The directory where the binary AMP package is to be found
protected org.apache.maven.project.MavenProject	project	[Read Only] The Maven project.
protected boolean	skip	This parameter skips validation (the feature is experimental so disabled by default)
protected String	sourceLocation	The directory where the source project is stored.

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

ROLE

Constructor Summary

Constructors

Constructor	Description
ValidateMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()

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, toString, wait, wait, wait

Field Detail

skip

protected boolean skip

This parameter skips validation (the feature is experimental so disabled by default)

Required:

Parameter:

property="maven.alfresco.validation.skip" default-value="true"

sourceLocation

protected String sourceLocation

The directory where the source project is stored. Should not include /target otherwise checks will be duplicated.

Required:

Parameter:

property="maven.alfresco.validation.sourceLocation" default-value="${project.build.directory}/${project.build.finalName}-src"

binaryLocation

protected String binaryLocation

The directory where the binary AMP package is to be found

Required:

Parameter:

property="maven.alfresco.validation.binaryLocation" default-value="${project.build.directory}/${project.build.finalName}.amp"

neo4jUrl

protected String neo4jUrl

The directory where the binary AMP package is to be found

Required:

Parameter:

property="maven.alfresco.validation.neo4jUrl" default-value="http://localhost:7474/db/data/"

project

protected org.apache.maven.project.MavenProject project

[Read Only] The Maven project.

Required:

Read only:

Parameter:

default-value="${project}"

Constructor Detail

ValidateMojo

public ValidateMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException