org.datanucleus.maven

Class AbstractSchemaToolMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.datanucleus.maven.AbstractDataNucleusMojo

org.datanucleus.maven.AbstractSchemaToolMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

SchemaToolCreateMojo, SchemaToolCreateSchemaMojo, SchemaToolDatabaseInfoMojo, SchemaToolDeleteCreateMojo, SchemaToolDeleteMojo, SchemaToolDeleteSchemaMojo, SchemaToolInfoMojo, SchemaToolValidateMojo

public abstract class AbstractSchemaToolMojo
extends AbstractDataNucleusMojo

Extensions of this class implement the prepareModeSpecificCommandLineArguments(Commandline, java.util.List) method and provide mode-specific arguments to the SchemaTool invocation.

Following properties are at least required for the SchemaTool to execute:

• javax.jdo.option.ConnectionDriverName
• javax.jdo.option.ConnectionURL
• javax.jdo.option.ConnectionUserName
• javax.jdo.option.ConnectionPassword

SchemaTool properties can be specified in the POM configuration, or from command line. In case of conflicts, property values specified from command line take precedence.

An example DataNucleus-maven-plugin configuration can look like below:

    <plugin>
      <groupId>org.datanucleus.maven</groupId>
      <artifactId>datanucleus-maven-plugin</artifactId>
      <version>${datanucleus.plugin.version}</version>            
      <configuration>
        <outputFile>${project.build.directory}/schema.sql</outputFile>
        <toolProperties>
          <property>
            <name>javax.jdo.option.ConnectionDriverName</name>
            <value>org.hsqldb.jdbcDriver</value>
          </property>
          <property>
            <name>javax.jdo.option.ConnectionURL</name>
            <value>jdbc:hsqldb:mem:continuum</value>
          </property>
          <property>
            <name>javax.jdo.option.ConnectionUserName</name>
            <value>sa</value>
          </property>                
          <property>
            <name>javax.jdo.option.ConnectionPassword</name>
            <value></value>
          </property>
          <property>
            <name>datanucleus.autoCreateTables</name>
            <value>true</value>
          </property>
        </toolProperties>              
      </configuration>            
    </plugin>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	completeDdl
protected String	ddlFile File to which DDL SQL is written.
protected boolean	includeAutoStart
protected String	schemaName Schema name (to be used with "createSchema"/"deleteSchema" modes).

Fields inherited from class org.datanucleus.maven.AbstractDataNucleusMojo

api, fork, ignoreMetaDataForMissingClasses, jdkLogConfiguration, log4jConfiguration, metadataDirectory, metadataExcludes, metadataIncludes, persistenceUnitName, pluginArtifacts, verbose

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractSchemaToolMojo()

Method Summary

Modifier and Type	Method and Description
protected void	executeDataNucleusTool(List pluginArtifacts, List files) Template method expected to be implemented by extensions.
protected String	getToolName() Returns the DataNucleus tool name being invoked by this plugin's execution.
protected abstract void	prepareModeSpecificCommandLineArguments(org.codehaus.plexus.util.cli.Commandline cl, List args) Template method that sets up arguments for SchemaTool depending upon the mode invoked.

Methods inherited from class org.datanucleus.maven.AbstractDataNucleusMojo

execute, executeCommandLine, executeInJvm, findMetadataFiles, getJdkLogConfiguration, getLog4JConfiguration, getUniqueClasspathElements

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

schemaName

protected String schemaName

Schema name (to be used with "createSchema"/"deleteSchema" modes).

ddlFile

protected String ddlFile

File to which DDL SQL is written.

completeDdl

protected boolean completeDdl

includeAutoStart

protected boolean includeAutoStart

Constructor Detail

AbstractSchemaToolMojo

public AbstractSchemaToolMojo()

Method Detail

executeDataNucleusTool

protected 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.

Specified by:

executeDataNucleusTool in class AbstractDataNucleusMojo

Parameters:

pluginArtifacts - The artifacts

files - The files

Throws:

org.codehaus.plexus.util.cli.CommandLineException

org.apache.maven.plugin.MojoExecutionException

See Also:

AbstractDataNucleusMojo.executeDataNucleusTool(java.util.List, java.util.List)

prepareModeSpecificCommandLineArguments

protected abstract void prepareModeSpecificCommandLineArguments(org.codehaus.plexus.util.cli.Commandline cl,
                                                                List args)

Template method that sets up arguments for SchemaTool depending upon the mode invoked. This is expected to be implemented by extensions.

Parameters:

cl - Commandline instance to set up arguments for.

args - Arguments list generated by this call (appended to)

getToolName

protected String getToolName()

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

Specified by:

getToolName in class AbstractDataNucleusMojo

Returns:

DataNucleus tool/utility name being invoked.

See Also:

AbstractDataNucleusMojo.getToolName()