com.alipay.sofa.ark.plugin.mojo

Class ArkPluginMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.alipay.sofa.ark.plugin.mojo.ArkPluginMojo

All Implemented Interfaces:

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

@Mojo(name="ark-plugin",
      defaultPhase=PACKAGE,
      requiresDependencyResolution=RUNTIME)
public class ArkPluginMojo
extends org.apache.maven.plugin.AbstractMojo

Since:

0.1.0

Author:

qilong.zql

Field Summary

Fields

Modifier and Type	Field and Description
protected String	activator
protected org.codehaus.plexus.archiver.manager.ArchiverManager	archiverManager
protected String	artifactId
protected String	description
protected LinkedHashSet<String>	excludeArtifactIds list of artifact names to exclude (exact match).
protected LinkedHashSet<String>	excludeGroupIds list of groupId names to exclude (exact match).
protected LinkedHashSet<String>	excludes Colon separated groupId, artifactId [and classifier] to exclude (exact match)
protected ExportConfig	exported
protected Boolean	exportPluginClass Export plugin project classes by default
protected String	groupId The configuration of ark plugin
protected ImportConfig	imported
protected File	outputDirectory The location of the generated ark plugin
String	pluginName
protected Integer	priority
protected org.apache.maven.project.MavenProject	project
protected org.apache.maven.project.MavenProjectHelper	projectHelper
protected LinkedHashSet<String>	shades Colon separated groupId, artifactId, classifier(optional), version.
protected String	version
protected File	workDirectory The location of sofa-ark-maven-plugin temporary file

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

ROLE

Constructor Summary

Constructors

Constructor and Description
ArkPluginMojo()

Method Summary

Modifier and Type	Method and Description
protected void	addArkPluginArtifact(org.codehaus.plexus.archiver.Archiver archiver, Set<org.apache.maven.artifact.Artifact> dependencies, Set<org.apache.maven.artifact.Artifact> conflicts) put all dependencies together into archive
protected void	addArkPluginConfig(org.codehaus.plexus.archiver.Archiver archiver) generate ark.plugin configuration file archive
protected void	addArtifact(org.codehaus.plexus.archiver.Archiver archiver, org.apache.maven.artifact.Artifact artifact, boolean artifactIdConflict) add a artifact into archiver
void	execute()
protected Set<org.apache.maven.artifact.Artifact>	filterConflictArtifacts(Set<org.apache.maven.artifact.Artifact> artifacts) compute conflict artifacts
protected Set<org.apache.maven.artifact.Artifact>	filterExcludeArtifacts(Set<org.apache.maven.artifact.Artifact> artifacts) filter the excluded dependencies
protected org.codehaus.plexus.archiver.Archiver	getArchiver() create a zip archiver
protected boolean	getExportPluginClass() check whether to export plugin project default true.
protected String	getFileName() repackage jar name
LinkedHashSet<String>	getShades()
protected String	getTempFileName()
protected boolean	isAttach() check whether install ark plugin install local repo default true.
boolean	isShadeJar(org.apache.maven.artifact.Artifact artifact)
void	setProject(org.apache.maven.project.MavenProject project)
void	setShades(LinkedHashSet<String> shades)
void	shadeJarIntoArkPlugin(File pluginFile, File tmpPluginFile, Set<org.apache.maven.artifact.Artifact> artifacts)

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

project

@Component
protected org.apache.maven.project.MavenProject project

archiverManager

@Component
protected org.codehaus.plexus.archiver.manager.ArchiverManager archiverManager

projectHelper

@Component
protected org.apache.maven.project.MavenProjectHelper projectHelper

outputDirectory

@Parameter(defaultValue="${project.build.directory}",
           property="sofa.ark.plugin.repository")
protected File outputDirectory

The location of the generated ark plugin

workDirectory

@Parameter(defaultValue="${project.build.directory}/sofa-ark-maven-plugin")
protected File workDirectory

The location of sofa-ark-maven-plugin temporary file

groupId

@Parameter(defaultValue="${project.groupId}",
           readonly=true)
protected String groupId

The configuration of ark plugin

artifactId

@Parameter(defaultValue="${project.artifactId}",
           readonly=true)
protected String artifactId

version

@Parameter(defaultValue="${project.version}",
           readonly=true)
protected String version

pluginName

@Parameter(defaultValue="${project.artifactId}")
public String pluginName

description

@Parameter(defaultValue=" ")
protected String description

priority

@Parameter(defaultValue="100",
           property="sofa.ark.plugin.priority")
protected Integer priority

activator

@Parameter
protected String activator

exported

@Parameter
protected ExportConfig exported

imported

@Parameter
protected ImportConfig imported

excludes

@Parameter(defaultValue="")
protected LinkedHashSet<String> excludes

Colon separated groupId, artifactId [and classifier] to exclude (exact match)

excludeGroupIds

@Parameter(defaultValue="")
protected LinkedHashSet<String> excludeGroupIds

list of groupId names to exclude (exact match).

excludeArtifactIds

@Parameter(defaultValue="")
protected LinkedHashSet<String> excludeArtifactIds

list of artifact names to exclude (exact match).

shades

@Parameter(defaultValue="")
protected LinkedHashSet<String> shades

Colon separated groupId, artifactId, classifier(optional), version.

exportPluginClass

@Parameter(defaultValue="true")
protected Boolean exportPluginClass

Export plugin project classes by default

Constructor Detail

ArkPluginMojo

public ArkPluginMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

shadeJarIntoArkPlugin

public void shadeJarIntoArkPlugin(File pluginFile,
                                  File tmpPluginFile,
                                  Set<org.apache.maven.artifact.Artifact> artifacts)
                           throws IOException

Throws:

IOException

getShades

public LinkedHashSet<String> getShades()

setShades

public void setShades(LinkedHashSet<String> shades)

setProject

public void setProject(org.apache.maven.project.MavenProject project)

isShadeJar

public boolean isShadeJar(org.apache.maven.artifact.Artifact artifact)

addArkPluginArtifact

protected void addArkPluginArtifact(org.codehaus.plexus.archiver.Archiver archiver,
                                    Set<org.apache.maven.artifact.Artifact> dependencies,
                                    Set<org.apache.maven.artifact.Artifact> conflicts)

put all dependencies together into archive

Parameters:

archiver - ark plugin archiver

dependencies - all dependencies of ark plugin

conflicts - dependencies whose jar name (artifact id) is conflict

addArtifact

protected void addArtifact(org.codehaus.plexus.archiver.Archiver archiver,
                           org.apache.maven.artifact.Artifact artifact,
                           boolean artifactIdConflict)

add a artifact into archiver

Parameters:

archiver - archiver which represents a ark plugin

artifact - artifact which will be put into archiver

artifactIdConflict - whether artifact is conflicted, it will determine the final jar name.

filterConflictArtifacts

protected Set<org.apache.maven.artifact.Artifact> filterConflictArtifacts(Set<org.apache.maven.artifact.Artifact> artifacts)

compute conflict artifacts

Parameters:

artifacts - all dependencies of project

Returns:

artifacts whose jar name (artifact id) is conflict

filterExcludeArtifacts

protected Set<org.apache.maven.artifact.Artifact> filterExcludeArtifacts(Set<org.apache.maven.artifact.Artifact> artifacts)

filter the excluded dependencies

Parameters:

artifacts - all dependencies of project

Returns:

dependencies excluded the excludes config

getArchiver

protected org.codehaus.plexus.archiver.Archiver getArchiver()
                                                     throws org.codehaus.plexus.archiver.manager.NoSuchArchiverException

create a zip archiver

Returns:

a un-compress zip archiver

Throws:

org.codehaus.plexus.archiver.manager.NoSuchArchiverException

getFileName

protected String getFileName()

repackage jar name

Returns:

ark plugin name

getTempFileName

protected String getTempFileName()

isAttach

protected boolean isAttach()

check whether install ark plugin install local repo default true.

Returns:

whether install local repo

getExportPluginClass

protected boolean getExportPluginClass()

check whether to export plugin project default true.

Returns:

whether to export plugin project

addArkPluginConfig

protected void addArkPluginConfig(org.codehaus.plexus.archiver.Archiver archiver)
                           throws org.apache.maven.plugin.MojoExecutionException

generate ark.plugin configuration file archive

Parameters:

archiver -

Throws:

org.apache.maven.plugin.MojoExecutionException