org.apache.camel.maven

Class DotMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.apache.camel.maven.DotMojo

All Implemented Interfaces:

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

public class DotMojo
extends org.apache.maven.reporting.AbstractMavenReport

Runs Camel embedded with META-INF/services/*.xml spring files to try create DOT files for the routing rules, then converts the DOT files into another format such as PNG

Version:

See Also:

GraphViz

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	applicationContextUri The classpath based application context uri that spring wants to get.
static java.lang.String[]	DEFAULT_GRAPHVIZ_OUTPUT_TYPES
protected java.lang.String	duration The duration to run the application for which by default is in milliseconds.
protected java.lang.String	fileApplicationContextUri The filesystem based application context uri that spring wants to get.
protected boolean	runCamel Whether we should boot up camel with the META-INF/services/*.xml to generate the DOT file
protected static java.lang.String	SUBDIRECTORY Subdirectory for report.
protected boolean	useDot Should we try run the DOT executable on the generated .DOT file to generate images

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

Constructor and Description
DotMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	close(java.io.Closeable closeable, java.lang.String description)
protected java.lang.String	convertFile(java.io.File file, java.lang.String format)
void	execute()
protected void	execute(java.io.File outputDir, java.util.Locale locale) Executes DOT generator.
protected void	executeReport(java.util.Locale locale)
java.lang.String	getAggregate()
protected java.util.ResourceBundle	getBundle(java.util.Locale locale) Gets resource bundle for given locale.
java.lang.String	getDescription(java.util.Locale locale)
java.lang.String	getName(java.util.Locale locale)
protected java.lang.String	getOutputDirectory()
java.lang.String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
boolean	isUseDot()
protected void	printHtmlFileFooter(java.io.PrintWriter out, java.io.File file)
protected void	printHtmlFileHeader(java.io.PrintWriter out, java.io.File file)
protected void	printHtmlFooter(java.io.PrintWriter out)
protected void	printHtmlHeader(java.io.PrintWriter out, java.lang.String contextName)
protected java.lang.String	removeFileExtension(java.lang.String name)
protected void	runCamelEmbedded(java.io.File outputDir)
void	setAggregate(java.lang.String aggregate)
void	setUseDot(boolean useDot)
protected void	writeIndexHtmlFile(java.io.File dir, java.lang.String fileName, java.lang.String content)

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

canGenerateReport, closeReport, generate, getCategoryName, getReportOutputDirectory, getSink, isExternalReport, 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

DEFAULT_GRAPHVIZ_OUTPUT_TYPES

public static final java.lang.String[] DEFAULT_GRAPHVIZ_OUTPUT_TYPES

SUBDIRECTORY

protected static final java.lang.String SUBDIRECTORY

Subdirectory for report.

See Also:

Constant Field Values

duration

protected java.lang.String duration

The duration to run the application for which by default is in milliseconds. A value <= 0 will run forever. Adding a s indicates seconds - eg "5s" means 5 seconds.

runCamel

protected boolean runCamel

Whether we should boot up camel with the META-INF/services/*.xml to generate the DOT file

useDot

protected boolean useDot

Should we try run the DOT executable on the generated .DOT file to generate images

applicationContextUri

protected java.lang.String applicationContextUri

The classpath based application context uri that spring wants to get.

fileApplicationContextUri

protected java.lang.String fileApplicationContextUri

The filesystem based application context uri that spring wants to get.

Constructor Detail

DotMojo

public DotMojo()

Method Detail

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Parameters:

locale - report locale.

Returns:

report description.

See Also:

MavenReport.getDescription(Locale)

getName

public java.lang.String getName(java.util.Locale locale)

See Also:

MavenReport.getName(Locale)

getOutputName

public java.lang.String getOutputName()

getAggregate

public java.lang.String getAggregate()

setAggregate

public void setAggregate(java.lang.String aggregate)

isUseDot

public boolean isUseDot()

setUseDot

public void setUseDot(boolean useDot)

execute

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

Specified by:

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

Overrides:

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

Throws:

org.apache.maven.plugin.MojoExecutionException

executeReport

protected void executeReport(java.util.Locale locale)
                      throws org.apache.maven.reporting.MavenReportException

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

execute

protected void execute(java.io.File outputDir,
           java.util.Locale locale)
                throws org.apache.maven.plugin.MojoExecutionException

Executes DOT generator.

Parameters:

outputDir - report output directory.

locale - report locale.

Throws:

org.apache.maven.plugin.MojoExecutionException - if there were any execution errors.

runCamelEmbedded

protected void runCamelEmbedded(java.io.File outputDir)
                         throws DependencyResolutionRequiredException

Throws:

DependencyResolutionRequiredException

writeIndexHtmlFile

protected void writeIndexHtmlFile(java.io.File dir,
                      java.lang.String fileName,
                      java.lang.String content)
                           throws java.io.IOException

Throws:

java.io.IOException

printHtmlHeader

protected void printHtmlHeader(java.io.PrintWriter out,
                   java.lang.String contextName)

printHtmlFileHeader

protected void printHtmlFileHeader(java.io.PrintWriter out,
                       java.io.File file)

printHtmlFileFooter

protected void printHtmlFileFooter(java.io.PrintWriter out,
                       java.io.File file)

printHtmlFooter

protected void printHtmlFooter(java.io.PrintWriter out)

close

protected void close(java.io.Closeable closeable,
         java.lang.String description)

convertFile

protected java.lang.String convertFile(java.io.File file,
                           java.lang.String format)
                                throws org.codehaus.plexus.util.cli.CommandLineException

Throws:

org.codehaus.plexus.util.cli.CommandLineException

removeFileExtension

protected java.lang.String removeFileExtension(java.lang.String name)

getBundle

protected java.util.ResourceBundle getBundle(java.util.Locale locale)

Gets resource bundle for given locale.

Parameters:

locale - locale

Returns:

resource bundle

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Specified by:

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

getOutputDirectory

protected java.lang.String getOutputDirectory()

Specified by:

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

getProject

protected org.apache.maven.project.MavenProject getProject()

Specified by:

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