org.codehaus.mojo.versions

Class DependencyUpdatesReportMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.codehaus.mojo.versions.AbstractVersionsReport<DependencyUpdatesModel>

org.codehaus.mojo.versions.DependencyUpdatesReportMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport

@Mojo(name="dependency-updates-report",
      requiresDependencyResolution=RUNTIME,
      threadSafe=true)
public class DependencyUpdatesReportMojo
extends AbstractVersionsReport<DependencyUpdatesModel>

Generates a report of available updates for the dependencies of a project.

Since:

1.0-beta-1

Author:

Stephen Connolly

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	formats Report formats (html and/or xml).
protected boolean	onlyProjectDependencies If true, only shows the subsection of the dependencyManagement artifacts that are actually used in the project's dependency graph.
protected boolean	onlyUpgradable If true, only shows upgradable dependencies in the report.
protected boolean	processDependencyManagement Whether to process the dependencyManagement in pom or not.
protected boolean	processDependencyManagementTransitive Whether to process the dependencyManagement part transitive or not.

Fields inherited from class org.codehaus.mojo.versions.AbstractVersionsReport

allowSnapshots, artifactMetadataSource, artifactResolver, comparisonMethod, i18n, ignoredVersions, remoteArtifactRepositories, remotePluginRepositories, rendererFactory, repositorySystem, ruleSet, session

Fields inherited from class org.apache.maven.reporting.AbstractMavenReport

localRepository, outputDirectory, project, remoteRepositories, siteRenderer, siteTool

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

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

ROLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DependencyUpdatesReportMojo(org.codehaus.plexus.i18n.I18N i18n, org.apache.maven.repository.RepositorySystem repositorySystem, org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver, org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource, org.apache.maven.artifact.manager.WagonManager wagonManager, ReportRendererFactory rendererFactory)

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected void	doGenerateReport(Locale locale, org.apache.maven.doxia.sink.Sink sink) generates an empty report in case there are no sources to generate a report with
String	getOutputName()
boolean	isExternalReport()

Methods inherited from class org.codehaus.mojo.versions.AbstractVersionsReport

executeReport, findLatestVersion, getAllowSnapshots, getComparisonMethod, getDescription, getHelper, getI18n, getName, getOutputDirectory, getProject, getSiteRenderer, getText

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

closeReport, execute, generate, generate, generate, getCategoryName, getInputEncoding, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, setReportOutputDirectory

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

processDependencyManagement

@Parameter(property="processDependencyManagement",
           defaultValue="true")
protected boolean processDependencyManagement

Whether to process the dependencyManagement in pom or not.

Since:

2.5

processDependencyManagementTransitive

@Parameter(property="processDependencyManagementTransitive",
           defaultValue="true")
protected boolean processDependencyManagementTransitive

Whether to process the dependencyManagement part transitive or not. In case of <type>pom</type>and <scope>import</scope> this means by default to report also the imported dependencies. If processTransitive is set to false the report will only show updates of the imported pom itself.

Since:

2.5 Note: Currently in experimental state.

formats

@Parameter(property="dependencyUpdatesReportFormats",
           defaultValue="html")
protected String[] formats

Report formats (html and/or xml). HTML by default.

onlyProjectDependencies

@Parameter(property="onlyProjectDependencies",
           defaultValue="false")
protected boolean onlyProjectDependencies

If true, only shows the subsection of the dependencyManagement artifacts that are actually used in the project's dependency graph. false by default.

Since:

2.12

onlyUpgradable

@Parameter(property="onlyUpgradable",
           defaultValue="false")
protected boolean onlyUpgradable

If true, only shows upgradable dependencies in the report. false by default.

Since:

2.12

Constructor Detail

DependencyUpdatesReportMojo

@Inject
protected DependencyUpdatesReportMojo(org.codehaus.plexus.i18n.I18N i18n,
                                              org.apache.maven.repository.RepositorySystem repositorySystem,
                                              org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver,
                                              org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource,
                                              org.apache.maven.artifact.manager.WagonManager wagonManager,
                                              ReportRendererFactory rendererFactory)

Method Detail

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.reporting.MavenReport

Overrides:

isExternalReport in class org.apache.maven.reporting.AbstractMavenReport

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

Overrides:

canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport

doGenerateReport

protected void doGenerateReport(Locale locale,
                                org.apache.maven.doxia.sink.Sink sink)
                         throws org.apache.maven.reporting.MavenReportException

generates an empty report in case there are no sources to generate a report with

Specified by:

doGenerateReport in class AbstractVersionsReport<DependencyUpdatesModel>

Parameters:

locale - the locale to generate the report for.

sink - the report formatting tool

Throws:

org.apache.maven.reporting.MavenReportException - when things go wrong.

getOutputName

public String getOutputName()