Package org.apache.camel.kafkaconnector.maven.docs

Class UpdateDocComponentsListMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.camel.kafkaconnector.maven.docs.UpdateDocComponentsListMojo

All Implemented Interfaces:

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

@Mojo(name="update-doc-connectors-list",
      threadSafe=true)
public class UpdateDocComponentsListMojo
extends org.apache.maven.plugin.AbstractMojo

Generates the table of connectors in: - docs/modules/ROOT/pages/reference/index.adoc

Field Summary

Fields

Modifier and Type	Field	Description
protected File	connectorsDir	The directory for components catalog
protected String	connectorsProjectName	The maven project.
protected String	lastReleasedVersion	The Last Released version
protected org.apache.maven.project.MavenProject	project	The maven project.
protected File	projectBaseDir	The project directory
protected String	repositoryPath	The Apache Repository

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

ROLE

Constructor Summary

Constructors

Constructor	Description
UpdateDocComponentsListMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()	Execute goal.
protected void	executeComponentsReadme()

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 Details

project

@Parameter(property="project",
           required=true,
           readonly=true)
protected org.apache.maven.project.MavenProject project

The maven project.

connectorsDir

@Parameter(defaultValue="${project.directory}/../../connectors/")
protected File connectorsDir

The directory for components catalog

projectBaseDir

@Parameter(defaultValue="${basedir}/../")
protected File projectBaseDir

The project directory

repositoryPath

@Parameter(defaultValue="https://repo.maven.apache.org/maven2/org/apache/camel/kafkaconnector/")
protected String repositoryPath

The Apache Repository

lastReleasedVersion

@Parameter
protected String lastReleasedVersion

The Last Released version

connectorsProjectName

@Parameter(property="connectors-project-name",
           defaultValue="connectors",
           readonly=true)
protected String connectorsProjectName

The maven project.

Constructor Details

UpdateDocComponentsListMojo

public UpdateDocComponentsListMojo()

Method Details

execute

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

Execute goal.

Throws:

org.apache.maven.plugin.MojoExecutionException - execution of the main class or one of the threads it generated failed.

org.apache.maven.plugin.MojoFailureException - something bad happened...

executeComponentsReadme

protected void executeComponentsReadme()
                                throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException