com.sun.enterprise.build
Class DistributionDashboardMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      com.sun.enterprise.build.DistributionDashboardMojo

All Implemented Interfaces:

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

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

Create a wiki style document listing interesting information

Author:

Jerome Dochez

Nested Class Summary

protected static interface

AbstractGlassfishMojo.ArtifactFilter

Field Summary

protected org.apache.maven.artifact.factory.ArtifactFactory	artifactFactory
protected Map<String,List<org.apache.maven.artifact.Artifact>>	dependentsXRef
protected String	finalName The file name of the created distribution image.
protected String	generatorName The generator
protected File	outputDirectory The directory where the final image will be created.
protected org.apache.maven.project.MavenProject	project The maven project.
protected org.apache.maven.project.MavenProjectBuilder	projectBuilder
protected org.apache.maven.project.MavenProjectHelper	projectHelper
protected Pattern	scmURLPattern

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

ROLE

Constructor Summary

DistributionDashboardMojo()

Method Summary

void	execute() Mojo execution
protected Set<org.apache.maven.artifact.Artifact>	findArtifacts(Set<org.apache.maven.artifact.Artifact> artifacts, AbstractGlassfishMojo.ArtifactFilter filter) Finds artifacts that match the given filter.
protected Set<org.apache.maven.artifact.Artifact>	findArtifactsOfScope(Set<org.apache.maven.artifact.Artifact> artifacts, String scope)
protected Set<org.apache.maven.artifact.Artifact>	findArtifactsOfType(Set<org.apache.maven.artifact.Artifact> artifacts, String type) Returns a set of Artifacts that have the given type.
protected List<org.apache.maven.artifact.Artifact>	getImporting(org.apache.maven.artifact.Artifact module)
protected String	getSCMSpecficPart(String scmConnection)
protected String	getSCMType(String scmConnection)
protected void	initXRefs(Set<org.apache.maven.artifact.Artifact> modules)
protected boolean	isModule(org.apache.maven.artifact.Artifact a)
protected org.apache.maven.project.MavenProject	loadPom(org.apache.maven.artifact.Artifact artifact) Resolves the POM of the given artifact and parses it into MavenProject.

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

projectHelper

protected org.apache.maven.project.MavenProjectHelper projectHelper

artifactFactory

protected org.apache.maven.artifact.factory.ArtifactFactory artifactFactory

outputDirectory

protected File outputDirectory

The directory where the final image will be created.

finalName

protected String finalName

The file name of the created distribution image.

generatorName

protected String generatorName

The generator

dependentsXRef

protected Map<String,List<org.apache.maven.artifact.Artifact>> dependentsXRef

scmURLPattern

protected final Pattern scmURLPattern

project

protected org.apache.maven.project.MavenProject project

The maven project.

projectBuilder

protected org.apache.maven.project.MavenProjectBuilder projectBuilder

Constructor Detail

DistributionDashboardMojo

public DistributionDashboardMojo()

Method Detail

execute

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

Mojo execution

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

initXRefs

protected void initXRefs(Set<org.apache.maven.artifact.Artifact> modules)

getImporting

protected List<org.apache.maven.artifact.Artifact> getImporting(org.apache.maven.artifact.Artifact module)

getSCMType

protected String getSCMType(String scmConnection)

getSCMSpecficPart

protected String getSCMSpecficPart(String scmConnection)

isModule

protected boolean isModule(org.apache.maven.artifact.Artifact a)
                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

loadPom

protected org.apache.maven.project.MavenProject loadPom(org.apache.maven.artifact.Artifact artifact)
                                                 throws org.apache.maven.project.ProjectBuildingException

Resolves the POM of the given artifact and parses it into MavenProject.

Throws:

org.apache.maven.project.ProjectBuildingException

findArtifacts

protected Set<org.apache.maven.artifact.Artifact> findArtifacts(Set<org.apache.maven.artifact.Artifact> artifacts,
                                                                AbstractGlassfishMojo.ArtifactFilter filter)

Finds artifacts that match the given filter.

findArtifactsOfType

protected Set<org.apache.maven.artifact.Artifact> findArtifactsOfType(Set<org.apache.maven.artifact.Artifact> artifacts,
                                                                      String type)

Returns a set of Artifacts that have the given type.

findArtifactsOfScope

protected Set<org.apache.maven.artifact.Artifact> findArtifactsOfScope(Set<org.apache.maven.artifact.Artifact> artifacts,
                                                                       String scope)