org.wisdom.openjpa.enhancer

Class OpenJPAEnhancerMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.wisdom.maven.mojos.AbstractWisdomMojo

org.wisdom.maven.mojos.AbstractWisdomWatcherMojo

org.wisdom.openjpa.enhancer.OpenJPAEnhancerMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.wisdom.maven.MavenWatcher, org.wisdom.maven.Watcher

@Mojo(name="enhance-entities",
      threadSafe=false,
      requiresDependencyResolution=COMPILE,
      requiresProject=true,
      defaultPhase=PROCESS_CLASSES)
public class OpenJPAEnhancerMojo
extends org.wisdom.maven.mojos.AbstractWisdomWatcherMojo

A Mojo enhancing entity classes for OpenJPA.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addDefaultConstructor The JPA spec requires that all persistent classes define a no-arg constructor.
protected java.io.File	classes Location where persistence-enabled classes are located.
protected java.util.List<java.lang.String>	compileClasspathElements List of all class path elements that will be searched for the persistence-enabled classes and resources expected by PCEnhancer.
private java.lang.String	connectionDriverName This setting can be used to override any openjpa.ConnectionDriverName set in the persistence.xml.
private java.lang.String	connectionProperties Used to define the credentials or any other connection properties.
protected boolean	enforcePropertyRestrictions Whether to throw an exception when it appears that a property access entity is not obeying the restrictions placed on property access.
private java.lang.String	excludes Comma separated list of excludes to scan searchDir to pass to the jobs.
private java.lang.String	includes Comma separated list of includes to scan searchDir to pass to the jobs.
private static java.lang.String	META_PERSISTENCE_HEADER
private static java.lang.String	OPTION_ADD_DEFAULT_CONSTRUCTOR used for passing the addDefaultConstructor parameter to the enhancer tool
static java.lang.String	OPTION_CONNECTION_DRIVER_NAME The string used for passing information about the connectionDriverName.
static java.lang.String	OPTION_CONNECTION_PROPERTIES the string used for passing information about the connectionProperties.
private static java.lang.String	OPTION_ENFORCE_PROPERTY_RESTRICTION used for passing the enforcePropertyRestrictions parameter to the enhnacer tool
static java.lang.String	OPTION_PROPERTIES_FILE The properties option is used for passing information about the persistence.xml file location.
private static java.lang.String	OPTION_USE_TEMP_CLASSLOADER used for passing the tmpClassLoader parameter to the enhnacer tool
private java.lang.String	persistenceXmlFile Used if a non-default file location for the persistence.xml should be used If not specified, the default one in META-INF/persistence.xml will be used.
protected boolean	tmpClassLoader Tell the PCEnhancer to use a temporary classloader for enhancement.
private java.util.Properties	toolProperties Additional properties passed to the OpenJPA tools.
protected java.io.File	workDir The working directory for putting persistence.xml and other stuff into if we need to.

Fields inherited from class org.wisdom.maven.mojos.AbstractWisdomMojo

basedir, buildDirectory, javaHome, plugin, pluginDependencies, pluginManager, project, projectHelper, remoteRepos, repoSession, repoSystem, session, wisdomDirectory

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

ROLE

Constructor Summary

Constructors

Constructor and Description
OpenJPAEnhancerMojo()

Method Summary

Modifier and Type	Method and Description
boolean	accept(java.io.File file) Checks whether the given file is managed by the current watcher.
private void	enhance(java.util.List<java.io.File> files) Processes a list of class file resources that are to be enhanced.
private java.io.File	ensurePersistenceXml()
void	execute() Perform whatever build-process behavior this Mojo implements.
protected void	extendRealmClasspath() This will prepare the current ClassLoader and add all jars and local classpaths (e.g.
boolean	fileCreated(java.io.File file) Notifies the watcher that a new file is created.
boolean	fileDeleted(java.io.File file) Notifies the watcher that a file was deleted.
boolean	fileUpdated(java.io.File file) Notifies the watcher that a file has been modified.
protected java.util.List<java.io.File>	findEntityClassFiles() Locates and returns a list of class files found under specified class directory.
protected java.lang.String[]	getFilePaths(java.util.List<java.io.File> files)
protected org.apache.openjpa.lib.util.Options	getOptions() Get the options for the OpenJPA enhancer tool.
private java.lang.String	getPathInBundle(java.io.File persistence)

Methods inherited from class org.wisdom.maven.mojos.AbstractWisdomWatcherMojo

getFilteredVersion, getOutputFile, getOutputFile, getResources, project, removeFromWatching, session, setSession

Methods inherited from class org.wisdom.maven.mojos.AbstractWisdomMojo

getExternalAssetsDirectory, getExternalAssetsOutputDirectory, getInternalAssetOutputDirectory, getInternalAssetsDirectory, getNodeManager, getWisdomRootDirectory, setNodeManager

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

workDir

@Parameter(defaultValue="${project.build.directory}/openjpa-work",
           required=true)
protected java.io.File workDir

The working directory for putting persistence.xml and other stuff into if we need to.

classes

@Parameter(defaultValue="${project.build.outputDirectory}",
           readonly=true)
protected java.io.File classes

Location where persistence-enabled classes are located.

includes

@Parameter(defaultValue="**/*.class")
private java.lang.String includes

Comma separated list of includes to scan searchDir to pass to the jobs. This may be used to restrict the OpenJPA tasks to e.g. a single package which contains all the entities.

excludes

@Parameter(defaultValue="")
private java.lang.String excludes

Comma separated list of excludes to scan searchDir to pass to the jobs. This option may be used to stop OpenJPA tasks from scanning non-JPA classes (which usually leads to warnings such as "Type xxx has no metadata")

toolProperties

@Parameter
private java.util.Properties toolProperties

Additional properties passed to the OpenJPA tools.

persistenceXmlFile

@Parameter(defaultValue="target/classes/META-INF/persistence.xml")
private java.lang.String persistenceXmlFile

Used if a non-default file location for the persistence.xml should be used If not specified, the default one in META-INF/persistence.xml will be used.

connectionDriverName

@Parameter
private java.lang.String connectionDriverName

This setting can be used to override any openjpa.ConnectionDriverName set in the persistence.xml. It can also be used if the persistence.xml contains no connection information at all.

Sample:

 <connectionDriverName>com.mchange.v2.c3p0.ComboPooledDataSource</connectionDriverName>
 

This is most times used in conjunction with connectionProperties.

OPTION_CONNECTION_DRIVER_NAME

public static final java.lang.String OPTION_CONNECTION_DRIVER_NAME

The string used for passing information about the connectionDriverName.

See Also:

Constant Field Values

connectionProperties

@Parameter
private java.lang.String connectionProperties

Used to define the credentials or any other connection properties.

Sample:

 <connectionProperties>
   driverClass=com.mysql.jdbc.Driver,
   jdbcUrl=jdbc:mysql://localhost/mydatabase,
   user=root,
   password=,
   minPoolSize=5,
   acquireRetryAttempts=3,
   maxPoolSize=20
 </connectionProperties>
 

This is most times used in conjunction with connectionDriverName.

OPTION_CONNECTION_PROPERTIES

public static final java.lang.String OPTION_CONNECTION_PROPERTIES

the string used for passing information about the connectionProperties.

See Also:

Constant Field Values

compileClasspathElements

@Parameter(defaultValue="${project.compileClasspathElements}",
           required=true,
           readonly=true)
protected java.util.List<java.lang.String> compileClasspathElements

List of all class path elements that will be searched for the persistence-enabled classes and resources expected by PCEnhancer.

OPTION_PROPERTIES_FILE

public static final java.lang.String OPTION_PROPERTIES_FILE

The properties option is used for passing information about the persistence.xml file location.

See Also:

Constant Field Values

addDefaultConstructor

@Parameter(defaultValue="true")
protected boolean addDefaultConstructor

The JPA spec requires that all persistent classes define a no-arg constructor. This flag tells the enhancer whether to add a protected no-arg constructor to any persistent classes that don't already have one.

OPTION_ADD_DEFAULT_CONSTRUCTOR

private static final java.lang.String OPTION_ADD_DEFAULT_CONSTRUCTOR

used for passing the addDefaultConstructor parameter to the enhancer tool

See Also:

Constant Field Values

enforcePropertyRestrictions

@Parameter(defaultValue="false")
protected boolean enforcePropertyRestrictions

Whether to throw an exception when it appears that a property access entity is not obeying the restrictions placed on property access.

OPTION_ENFORCE_PROPERTY_RESTRICTION

private static final java.lang.String OPTION_ENFORCE_PROPERTY_RESTRICTION

used for passing the enforcePropertyRestrictions parameter to the enhnacer tool

See Also:

Constant Field Values

tmpClassLoader

@Parameter(defaultValue="false")
protected boolean tmpClassLoader

Tell the PCEnhancer to use a temporary classloader for enhancement. If you enable this feature, then no depending artifacts from the classpath will be used! Please note that you have to disable the tmpClassLoader for some cases in OpenJPA-1.2.1 due to an extended parsing strategy.

OPTION_USE_TEMP_CLASSLOADER

private static final java.lang.String OPTION_USE_TEMP_CLASSLOADER

used for passing the tmpClassLoader parameter to the enhnacer tool

See Also:

Constant Field Values

META_PERSISTENCE_HEADER

private static final java.lang.String META_PERSISTENCE_HEADER

See Also:

Constant Field Values

Constructor Detail

OpenJPAEnhancerMojo

public OpenJPAEnhancerMojo()

Method Detail

execute

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

Perform whatever build-process behavior this Mojo implements.
This is the main trigger for the Mojo inside the Maven system, and allows the Mojo to communicate errors.

Throws:

org.apache.maven.plugin.MojoExecutionException - if an unexpected problem occurs. Throwing this exception causes a "BUILD ERROR" message to be displayed.

org.apache.maven.plugin.MojoFailureException - if an expected problem (such as a compilation failure) occurs. Throwing this exception causes a "BUILD FAILURE" message to be displayed.

getPathInBundle

private java.lang.String getPathInBundle(java.io.File persistence)

accept

public boolean accept(java.io.File file)

Checks whether the given file is managed by the current watcher. Notice that implementation must not check for the existence of the file as this method is also called for deleted files.

Parameters:

file - is the file.

Returns:

true if the watcher is interested in being notified on an event attached to the given file, false otherwise.

fileCreated

public boolean fileCreated(java.io.File file)
                    throws org.wisdom.maven.WatchingException

Notifies the watcher that a new file is created.

Parameters:

file - is the file.

Returns:

false if the pipeline processing must be interrupted for this event. Most watchers should return true to let other watchers be notified.

Throws:

org.wisdom.maven.WatchingException - if the watcher failed to process the given file.

fileUpdated

public boolean fileUpdated(java.io.File file)
                    throws org.wisdom.maven.WatchingException

Notifies the watcher that a file has been modified.

Parameters:

file - is the file.

Returns:

false if the pipeline processing must be interrupted for this event. Most watchers should returns true to let other watchers to be notified.

Throws:

org.wisdom.maven.WatchingException - if the watcher failed to process the given file.

fileDeleted

public boolean fileDeleted(java.io.File file)
                    throws org.wisdom.maven.WatchingException

Notifies the watcher that a file was deleted.

Parameters:

file - the file

Returns:

false if the pipeline processing must be interrupted for this event. Most watchers should return true to let other watchers be notified.

Throws:

org.wisdom.maven.WatchingException - if the watcher failed to process the given file.

ensurePersistenceXml

private java.io.File ensurePersistenceXml()
                                   throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

extendRealmClasspath

protected void extendRealmClasspath()
                             throws org.apache.maven.plugin.MojoExecutionException

This will prepare the current ClassLoader and add all jars and local classpaths (e.g. target/classes) needed by the OpenJPA task.

Throws:

org.apache.maven.plugin.MojoExecutionException - on any error inside the mojo

findEntityClassFiles

protected java.util.List<java.io.File> findEntityClassFiles()
                                                     throws org.apache.maven.plugin.MojoExecutionException

Locates and returns a list of class files found under specified class directory.

Returns:

list of class files.

Throws:

org.apache.maven.plugin.MojoExecutionException - if there was an error scanning class file resources.

getFilePaths

protected java.lang.String[] getFilePaths(java.util.List<java.io.File> files)

Parameters:

files - List of files

Returns:

the paths of the given files as String[]

getOptions

protected org.apache.openjpa.lib.util.Options getOptions()
                                                  throws org.apache.maven.plugin.MojoExecutionException

Get the options for the OpenJPA enhancer tool.

Returns:

populated Options

Throws:

org.apache.maven.plugin.MojoExecutionException

enhance

private void enhance(java.util.List<java.io.File> files)
              throws org.apache.maven.plugin.MojoExecutionException

Processes a list of class file resources that are to be enhanced.

Parameters:

files - class file resources to enhance.

Throws:

org.apache.maven.plugin.MojoExecutionException - if the enhancer encountered a failure