org.datanucleus.maven

Class AbstractDataNucleusMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.datanucleus.maven.AbstractDataNucleusMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractEnhancerMojo, AbstractSchemaToolMojo

public abstract class AbstractDataNucleusMojo
extends org.apache.maven.plugin.AbstractMojo

Convenience base class for DataNucleus Mojo extensions.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	api
protected boolean	fork
protected boolean	ignoreMetaDataForMissingClasses
protected String	jdkLogConfiguration
protected String	log4jConfiguration
protected File	metadataDirectory
protected String	metadataExcludes
protected String	metadataIncludes
protected String	persistenceUnitName
protected List	pluginArtifacts
protected boolean	verbose

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractDataNucleusMojo()

Method Summary

Modifier and Type	Method and Description
void	execute() Method to execute a goal.
protected void	executeCommandLine(org.codehaus.plexus.util.cli.Commandline cl) Method to execute a command line.
protected abstract void	executeDataNucleusTool(List pluginArtifacts, List files) Template method expected to be implemented by extensions.
protected void	executeInJvm(String className, List args, List cpEntries, boolean quiet)
protected List	findMetadataFiles() Locates and builds a list of all metadata files under the build output directory.
protected URL	getJdkLogConfiguration() Accessor for the JDK1.4 logging configuration URL.
protected URL	getLog4JConfiguration() Accessor for the Log4J configuration URL.
protected abstract String	getToolName() Returns the DataNucleus tool name being invoked by this plugin's execution.
protected List	getUniqueClasspathElements() Return the set of classpath elements, ensuring that metadataDirectory location is first, and that no entry is duplicated in the classpath.

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

metadataDirectory

protected File metadataDirectory

metadataIncludes

protected String metadataIncludes

metadataExcludes

protected String metadataExcludes

ignoreMetaDataForMissingClasses

protected boolean ignoreMetaDataForMissingClasses

pluginArtifacts

protected List pluginArtifacts

log4jConfiguration

protected String log4jConfiguration

jdkLogConfiguration

protected String jdkLogConfiguration

verbose

protected boolean verbose

fork

protected boolean fork

persistenceUnitName

protected String persistenceUnitName

api

protected String api

Constructor Detail

AbstractDataNucleusMojo

public AbstractDataNucleusMojo()

Method Detail

execute

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

Method to execute a goal.

Throws:

org.apache.maven.plugin.MojoExecutionException - If an error occurs in execution

getLog4JConfiguration

protected URL getLog4JConfiguration()

Accessor for the Log4J configuration URL.

Returns:

Log4J config URL (if provided)

getJdkLogConfiguration

protected URL getJdkLogConfiguration()

Accessor for the JDK1.4 logging configuration URL.

Returns:

JDK1.4 logging config URL (if provided)

findMetadataFiles

protected List findMetadataFiles()
                          throws org.apache.maven.plugin.MojoExecutionException

Locates and builds a list of all metadata files under the build output directory.

Throws:

org.apache.maven.plugin.MojoExecutionException

getUniqueClasspathElements

protected List getUniqueClasspathElements()

Return the set of classpath elements, ensuring that metadataDirectory location is first, and that no entry is duplicated in the classpath.

The ability of the user to specify an alternate metadataDirectory location facilitates the need for this.
Example: Users that want to DataNucleusEnhance their test classes.

Returns:

the list of unique classpath elements.

executeDataNucleusTool

protected abstract void executeDataNucleusTool(List pluginArtifacts,
                                               List files)
                                        throws org.codehaus.plexus.util.cli.CommandLineException,
                                               org.apache.maven.plugin.MojoExecutionException

Template method expected to be implemented by extensions. This acts as hook to invoke custom DataNucleus tool.

Parameters:

pluginArtifacts - The artifacts

files - The files

Throws:

org.codehaus.plexus.util.cli.CommandLineException

org.apache.maven.plugin.MojoExecutionException

getToolName

protected abstract String getToolName()

Returns the DataNucleus tool name being invoked by this plugin's execution.

Returns:

DataNucleus tool/utility name being invoked.

executeCommandLine

protected void executeCommandLine(org.codehaus.plexus.util.cli.Commandline cl)
                           throws org.codehaus.plexus.util.cli.CommandLineException,
                                  org.apache.maven.plugin.MojoExecutionException

Method to execute a command line.

Parameters:

cl - CommandLine

Throws:

org.codehaus.plexus.util.cli.CommandLineException - Thrown if an error occurs invoking the command line

org.apache.maven.plugin.MojoExecutionException - Thrown if the command line executes but with error return code

executeInJvm

protected void executeInJvm(String className,
                            List args,
                            List cpEntries,
                            boolean quiet)
                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException