org.forgerock.openicf.maven

Class DocBookResourceMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.forgerock.openicf.maven.DocBookResourceMojo

All Implemented Interfaces:

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

@Mojo(name="docbkx",
      defaultPhase=PACKAGE,
      threadSafe=true,
      requiresDependencyResolution=TEST,
      configurator="override")
public class DocBookResourceMojo
extends org.apache.maven.plugin.AbstractMojo

A DocBookResourceMojo generate the DocBook xml.

To debug execute this command: mvnDebug org.forgerock.maven.plugins:openicf-maven-plugin:docbkx

Author:

Laszlo Hordos

Field Summary

Fields

Modifier and Type	Field and Description
protected File	basedir The current project base directory.
protected boolean	failOnError
protected org.apache.maven.execution.MavenSession	session The Maven Session Object

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

ROLE

Constructor Summary

Constructors

Constructor and Description
DocBookResourceMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
protected void	failOnError(String prefix, Exception e)
void	generate(ConnectorDocBuilder builder, org.apache.velocity.context.Context context, String connectorName)
protected void	generateDocument(ConnectorDocBuilder builder, org.apache.velocity.context.Context context, String connectorName, File rootDirectory, String templateFile)
File	getBasedir()
File	getBuildOutputDirectory()
PropertyBag	getConfigurationProperties()
String[]	getExcludes()
org.codehaus.plexus.i18n.I18N	getI18N()
String[]	getIncludes()
org.apache.maven.project.MavenProject	getMavenProject()
RemoteFrameworkConnectionInfo	getRemoteFrameworkConnectionInfo()
String	getSourceEncoding()
protected String	getTargetDirectoryName()
String	getTemplateDirectory()

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

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

getLog, setLog

Methods inherited from interface org.apache.maven.plugin.ContextEnabled

getPluginContext, setPluginContext

Field Detail

session

@Parameter(property="session",
           readonly=true)
protected org.apache.maven.execution.MavenSession session

The Maven Session Object

basedir

@Parameter(defaultValue="${basedir}",
           readonly=true,
           required=true)
protected File basedir

The current project base directory.

failOnError

@Parameter(property="openicf.failOnError",
           defaultValue="true")
protected boolean failOnError

Constructor Detail

DocBookResourceMojo

public DocBookResourceMojo()

Method Detail

getBuildOutputDirectory

public File getBuildOutputDirectory()

getIncludes

public String[] getIncludes()

getExcludes

public String[] getExcludes()

getConfigurationProperties

public PropertyBag getConfigurationProperties()

getRemoteFrameworkConnectionInfo

public RemoteFrameworkConnectionInfo getRemoteFrameworkConnectionInfo()

getBasedir

public File getBasedir()

getSourceEncoding

public String getSourceEncoding()

getTemplateDirectory

public String getTemplateDirectory()

getI18N

public org.codehaus.plexus.i18n.I18N getI18N()

getMavenProject

public org.apache.maven.project.MavenProject getMavenProject()

generate

public void generate(ConnectorDocBuilder builder,
                     org.apache.velocity.context.Context context,
                     String connectorName)
              throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

generateDocument

protected void generateDocument(ConnectorDocBuilder builder,
                                org.apache.velocity.context.Context context,
                                String connectorName,
                                File rootDirectory,
                                String templateFile)
                         throws IOException,
                                org.apache.maven.plugin.MojoExecutionException

Throws:

IOException

org.apache.maven.plugin.MojoExecutionException

getTargetDirectoryName

protected String getTargetDirectoryName()

execute

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

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

failOnError

protected void failOnError(String prefix,
                           Exception e)
                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException