EclipseLink JPA 4.0.2 · org.eclipse.persistence.tools.weaving.jpa.StaticWeaveAntTask

Description: This is the static weave ant task definition class that verifies the value of specified attributes and invokes StaticWeaveProcessor to weave classes.

Usage:

Ensure the classpath contains all the classes necessary to load the classes in the source.
The lib containing this weaving Ant task must be added into the classpath by using the -lib option on Ant command line instead of using the classpath attribute of the taskdef Ant task.
Define weaving Ant task and Ant target by using following attributes:
- source - specify source location. In the default configuration StaticWeaveAntTask assumes the source contains the persistence.xml,if this is not the case, the location containing the persistence.xml must be explicitly identified by the attribute 'persistenceinfo'.
- target - specify the output location (either a directory or a jar).
- persistenceinfo - specify the location containing the persistence.xml. This is optional and should only be specified if the source does not contain the persistence.xml. Weaving is not required for composite persistence unit - only for its members. If composite persistence unit member can't be used independently from its composite (specifies <property name="eclipselink.composite-unit.member" value="true"/>) then it must specify both its source and persistenceInfo of its composite. Otherwise composite persistence unit member may or may not specify persistenceInfo of its composite.
- log - specify a logging file. This is optional.
- loglevel - specify a literal value of EclipseLink logging level(OFF,SEVERE,WARNING,INFO,CONFIG,FINE,FINER,FINEST) The default value is OFF(8). This is optional.
The weaving will be performed in place if source and target point to the same location. Weaving in place is ONLY applicable for directory-based sources.

Example:


<target name="define.task" description="New task definition for EclipseLink static weaving"/>

  <taskdef name="weave" classname="org.eclipse.persistence.tools.weaving.jpa.StaticWeaveAntTask"/>

</target>

<target name="weaving" description="perform weaving." depends="define.task">

  <weave source= "c:\foo.jar" target = "c:\wovenfoo.jar" persistenceinfo="c:\foo-containing-persistenceinfo.jar">

    <classpath>

      <pathelement path="c:\foo-dependent.jar"/>

    </classpath>

  </weave>

</target>

Modifier and Type	Field and Description
private List<Path>	classPaths
private int	logLevel
private Writer	logWriter
private String	persistenceinfo
private String	persistencexml
private String	source
private String	target Hides org.apache.tools.ant.Task.target.

Access	Constructor and Description
public	StaticWeaveAntTask() Default constructor.

Method Summary

Modifier and Type	Method and Description
public void	addClasspath(Path path) Add the dependent classpath in order to load classes from the specified input jar.
public void	execute() Overrides org.apache.tools.ant.Task.execute. Execute ant task.
private List<String>	getPathElement() Parse the class path element and store them into vector.
private URL[]	getURLs() Convert the path element into the URL which further pass into the classloader.
public void	setLog(String logFile) Set the log file.
public void	setLogLevel(String logLevel)
public void	setPersistenceinfo(String persistenceinfo)
public void	setpersistencexml(String persistenceXMLLocation)
public void	setSource(String source) Set the input archive to be used to weave.
public void	setTarget(String target) Set output archive to be used to weave to.
private void	start() Invoke weaving process.
private void	verifyOptions() Verify the value of attributes.

Field Detail

classPaths	back to summary
private List<Path> classPaths

logLevel	back to summary
private int logLevel

logWriter	back to summary
private Writer logWriter

persistenceinfo	back to summary
private String persistenceinfo

persistencexml	back to summary
private String persistencexml

source	back to summary
private String source

target	back to summary
private String target Hides org.apache.tools.ant.Task.target.

StaticWeaveAntTask	back to summary
public StaticWeaveAntTask() Default constructor.

Method Detail

addClasspath	back to summary
public void addClasspath(Path path) Add the dependent classpath in order to load classes from the specified input jar.

execute	back to summary
public void execute() Overrides org.apache.tools.ant.Task.execute. Execute ant task. Annotations @Override

execute

back to summary

public void execute()

Overrides org.apache.tools.ant.Task.execute.

Execute ant task.

Annotations

@Override

getPathElement	back to summary
private List<String> getPathElement() Parse the class path element and store them into vector.

getURLs	back to summary
private URL[] getURLs() Convert the path element into the URL which further pass into the classloader.

setLog	back to summary
public void setLog(String logFile) throws IOException Set the log file.

setLogLevel	back to summary
public void setLogLevel(String logLevel)

setPersistenceinfo	back to summary
public void setPersistenceinfo(String persistenceinfo)

setpersistencexml	back to summary
public void setpersistencexml(String persistenceXMLLocation)

setSource	back to summary
public void setSource(String source) Set the input archive to be used to weave.

setTarget	back to summary
public void setTarget(String target) Set output archive to be used to weave to.

start	back to summary
private void start() Invoke weaving process.

verifyOptions	back to summary
private void verifyOptions() throws BuildException Verify the value of attributes.

public Class StaticWeaveAntTask

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail