org.apache.maven.plugin.eclipse.writers.wtp

Class EclipseWtpApplicationXMLWriter

java.lang.Object

org.apache.maven.plugin.eclipse.writers.AbstractEclipseWriter

org.apache.maven.plugin.eclipse.writers.wtp.AbstractWtpResourceWriter

org.apache.maven.plugin.eclipse.writers.wtp.EclipseWtpApplicationXMLWriter

All Implemented Interfaces:

EclipseWriter

public class EclipseWtpApplicationXMLWriter
extends AbstractWtpResourceWriter

This writer creates the application.xml and the .modulemaps files for RAD6 the the META-INF directory in the project root. this is where RAD6 requires the files to be. These will be independent of the real application.xml witch will be generated the stad. maven way.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	APPLICATION_XML_APPLICATION
private static java.lang.String	APPLICATION_XML_CONTEXT_ROOT
private static java.lang.String	APPLICATION_XML_DESCRIPTION
private static java.lang.String	APPLICATION_XML_DISPLAY_NAME
private static java.lang.String	APPLICATION_XML_FILENAME
private static java.lang.String	APPLICATION_XML_MODULE
private static java.lang.String	APPLICATION_XML_WEB
private static java.lang.String	APPLICATION_XML_WEB_URI
private org.codehaus.plexus.util.xml.Xpp3Dom[]	applicationXmlDomChildren
private static java.lang.String	HREF
private static java.lang.String	ID
private static java.lang.String	MODULEMAP_EARPROJECT_MAP
private static java.lang.String	MODULEMAPS_APPLICATION_EJB_MODULE
private static java.lang.String	MODULEMAPS_APPLICATION_WEB_MODULE
private static java.lang.String	MODULEMAPS_FILENAME
private static java.lang.String	MODULEMAPS_MAPPINGS
private static java.lang.String	MODULEMAPS_PROJECT_NAME
private static java.lang.String	MODULEMAPS_UTILITY_JARMAPPINGS
private org.codehaus.plexus.util.xml.Xpp3Dom[]	modulemapsXmlDomChildren
private static java.lang.String	URI
private static java.lang.String	VERSION
private org.codehaus.plexus.util.xml.Xpp3Dom[]	webModulesFromPoms
private static java.lang.String	XMI_ID
private static java.lang.String	XMI_TYPE
private static java.lang.String	XMI_VERSION
private static java.lang.String	XMLNS
private static java.lang.String	XMLNS_APPLICATION
private static java.lang.String	XMLNS_MODULEMAP
private static java.lang.String	XMLNS_SCHEMA_LOCATION
private static java.lang.String	XMLNS_XMI
private static java.lang.String	XMLNS_XSI
private static java.lang.String	XSI_SCHEMA_LOCATION

Fields inherited from class org.apache.maven.plugin.eclipse.writers.wtp.AbstractWtpResourceWriter

ATTR_DEPLOY_NAME, ATTR_DEPLOY_PATH, ATTR_MODULE_ID, ATTR_MODULE_TYPE_ID, ATTR_NAME, ATTR_PROJECT_VERSION, ATTR_SOURCE_PATH, ATTR_VALUE, ELT_MODULE_TYPE, ELT_PROJECT_MODULES, ELT_PROPERTY, ELT_VERSION, ELT_WB_MODULE, ELT_WB_RESOURCE

Fields inherited from class org.apache.maven.plugin.eclipse.writers.AbstractEclipseWriter

config, log

Constructor Summary

Constructors

Constructor and Description
EclipseWtpApplicationXMLWriter()

Method Summary

Modifier and Type	Method and Description
private void	copyApplicationFiles() Copy all files from application directory to the target eclipseEar directory.
static void	copyDirectoryStructure(java.io.File sourceDirectory, java.io.File destinationDirectory) Copies a entire directory structure without scm files.
private org.codehaus.plexus.util.xml.Xpp3Dom	createNewApplicationXml() there is no existing application.xml file so create a new one.
private org.codehaus.plexus.util.xml.Xpp3Dom	createNewModulemaps() there is no existing .modulemaps file so create a new one.
private org.codehaus.plexus.util.xml.Xpp3Dom	findModuleInApplicationXml(org.codehaus.plexus.util.xml.Xpp3Dom applicationXmlDom, org.codehaus.plexus.util.xml.Xpp3Dom mapping) find an existing module entry in the application.xml file by looking up the id in the modulemaps file and then using that to locate the entry in the application.xml file.
private org.codehaus.plexus.util.xml.Xpp3Dom	findOrCreateArtifact(IdeDependency dependency, org.codehaus.plexus.util.xml.Xpp3Dom modulemapXmlDom) find an artifact in the modulemaps dom tree, if it is missing create a new entry in the modulemaps dom tree.
private java.lang.String	getContextRootFor(IdeDependency dependency) Find the contextRoot specified in the pom and convert it into contectroot for the application.xml.
private java.lang.String	getIdFromMapping(org.codehaus.plexus.util.xml.Xpp3Dom mapping) get the id from the href of a modulemap.
private void	handled(org.codehaus.plexus.util.xml.Xpp3Dom xpp3Dom) mark the domtree entry as handled (all not handled ones will be deleted).
private org.codehaus.plexus.util.xml.Xpp3Dom	readXMLFile(java.io.File xmlFile) read an xml file (application.xml or .modulemaps).
private void	removeUnusedEntries(org.codehaus.plexus.util.xml.Xpp3Dom applicationXmlDom, org.codehaus.plexus.util.xml.Xpp3Dom modulemapsXmlDom) delete all unused entries from the dom-trees.
private void	updateApplicationXml(org.codehaus.plexus.util.xml.Xpp3Dom applicationXmlDom, org.codehaus.plexus.util.xml.Xpp3Dom modulemapXmlDom, IdeDependency dependency) update the application.xml and the .modulemaps file for a specified dependency.all WAR an EJB dependencies will go in both files all others only in the modulemaps files.
void	write() write the application.xml and the .modulemaps file to the META-INF directory.
private void	writePrettyXmlFile(java.io.File xmlFile, org.codehaus.plexus.util.xml.Xpp3Dom xmlDomTree) write back a domtree to a xmlfile and use the pretty print for it so that it is human readable.

Methods inherited from class org.apache.maven.plugin.eclipse.writers.wtp.AbstractWtpResourceWriter

addDependency, writeModuleTypeAccordingToPackaging, writeWarOrEarResources

Methods inherited from class org.apache.maven.plugin.eclipse.writers.AbstractEclipseWriter

init

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

APPLICATION_XML_APPLICATION

private static final java.lang.String APPLICATION_XML_APPLICATION

See Also:

Constant Field Values

APPLICATION_XML_CONTEXT_ROOT

private static final java.lang.String APPLICATION_XML_CONTEXT_ROOT

See Also:

Constant Field Values

APPLICATION_XML_DESCRIPTION

private static final java.lang.String APPLICATION_XML_DESCRIPTION

See Also:

Constant Field Values

APPLICATION_XML_DISPLAY_NAME

private static final java.lang.String APPLICATION_XML_DISPLAY_NAME

See Also:

Constant Field Values

APPLICATION_XML_FILENAME

private static final java.lang.String APPLICATION_XML_FILENAME

See Also:

Constant Field Values

APPLICATION_XML_MODULE

private static final java.lang.String APPLICATION_XML_MODULE

See Also:

Constant Field Values

APPLICATION_XML_WEB

private static final java.lang.String APPLICATION_XML_WEB

See Also:

Constant Field Values

APPLICATION_XML_WEB_URI

private static final java.lang.String APPLICATION_XML_WEB_URI

See Also:

Constant Field Values

HREF

private static final java.lang.String HREF

See Also:

Constant Field Values

ID

private static final java.lang.String ID

See Also:

Constant Field Values

MODULEMAP_EARPROJECT_MAP

private static final java.lang.String MODULEMAP_EARPROJECT_MAP

See Also:

Constant Field Values

MODULEMAPS_APPLICATION_EJB_MODULE

private static final java.lang.String MODULEMAPS_APPLICATION_EJB_MODULE

See Also:

Constant Field Values

MODULEMAPS_APPLICATION_WEB_MODULE

private static final java.lang.String MODULEMAPS_APPLICATION_WEB_MODULE

See Also:

Constant Field Values

MODULEMAPS_FILENAME

private static final java.lang.String MODULEMAPS_FILENAME

See Also:

Constant Field Values

MODULEMAPS_MAPPINGS

private static final java.lang.String MODULEMAPS_MAPPINGS

See Also:

Constant Field Values

MODULEMAPS_PROJECT_NAME

private static final java.lang.String MODULEMAPS_PROJECT_NAME

See Also:

Constant Field Values

MODULEMAPS_UTILITY_JARMAPPINGS

private static final java.lang.String MODULEMAPS_UTILITY_JARMAPPINGS

See Also:

Constant Field Values

URI

private static final java.lang.String URI

See Also:

Constant Field Values

VERSION

private static final java.lang.String VERSION

See Also:

Constant Field Values

XMI_ID

private static final java.lang.String XMI_ID

See Also:

Constant Field Values

XMI_TYPE

private static final java.lang.String XMI_TYPE

See Also:

Constant Field Values

XMI_VERSION

private static final java.lang.String XMI_VERSION

See Also:

Constant Field Values

XMLNS

private static final java.lang.String XMLNS

See Also:

Constant Field Values

XMLNS_APPLICATION

private static final java.lang.String XMLNS_APPLICATION

See Also:

Constant Field Values

XMLNS_MODULEMAP

private static final java.lang.String XMLNS_MODULEMAP

See Also:

Constant Field Values

XMLNS_SCHEMA_LOCATION

private static final java.lang.String XMLNS_SCHEMA_LOCATION

See Also:

Constant Field Values

XSI_SCHEMA_LOCATION

private static final java.lang.String XSI_SCHEMA_LOCATION

See Also:

Constant Field Values

XMLNS_XMI

private static final java.lang.String XMLNS_XMI

See Also:

Constant Field Values

XMLNS_XSI

private static final java.lang.String XMLNS_XSI

See Also:

Constant Field Values

applicationXmlDomChildren

private org.codehaus.plexus.util.xml.Xpp3Dom[] applicationXmlDomChildren

modulemapsXmlDomChildren

private org.codehaus.plexus.util.xml.Xpp3Dom[] modulemapsXmlDomChildren

webModulesFromPoms

private org.codehaus.plexus.util.xml.Xpp3Dom[] webModulesFromPoms

Constructor Detail

EclipseWtpApplicationXMLWriter

public EclipseWtpApplicationXMLWriter()

Method Detail

write

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

write the application.xml and the .modulemaps file to the META-INF directory.

Throws:

org.apache.maven.plugin.MojoExecutionException - when writing the config files was not possible

See Also:

AbstractWtpResourceWriter#write(EclipseSourceDir[], ArtifactRepository, File)

copyApplicationFiles

private void copyApplicationFiles()
                           throws org.apache.maven.plugin.MojoExecutionException

Copy all files from application directory to the target eclipseEar directory.

Throws:

org.apache.maven.plugin.MojoExecutionException - wenn an error occures during file copieing

copyDirectoryStructure

public static void copyDirectoryStructure(java.io.File sourceDirectory,
                                          java.io.File destinationDirectory)
                                   throws java.io.IOException

Copies a entire directory structure without scm files. Note:

• It will include empty directories.
• The sourceDirectory must exists.

Parameters:

sourceDirectory -

destinationDirectory -

Throws:

java.io.IOException

createNewApplicationXml

private org.codehaus.plexus.util.xml.Xpp3Dom createNewApplicationXml()

there is no existing application.xml file so create a new one.

Returns:

the domtree representing the contents of application.xml

createNewModulemaps

private org.codehaus.plexus.util.xml.Xpp3Dom createNewModulemaps()

there is no existing .modulemaps file so create a new one.

Returns:

the domtree representing the contents of the .modulemaps file

findModuleInApplicationXml

private org.codehaus.plexus.util.xml.Xpp3Dom findModuleInApplicationXml(org.codehaus.plexus.util.xml.Xpp3Dom applicationXmlDom,
                                                                        org.codehaus.plexus.util.xml.Xpp3Dom mapping)

find an existing module entry in the application.xml file by looking up the id in the modulemaps file and then using that to locate the entry in the application.xml file.

Parameters:

applicationXmlDom - application.xml dom tree

mapping - .modulemaps dom tree

Returns:

dom tree representing the module

findOrCreateArtifact

private org.codehaus.plexus.util.xml.Xpp3Dom findOrCreateArtifact(IdeDependency dependency,
                                                                  org.codehaus.plexus.util.xml.Xpp3Dom modulemapXmlDom)

find an artifact in the modulemaps dom tree, if it is missing create a new entry in the modulemaps dom tree.

Parameters:

dependency - dependency to find

modulemapXmlDom - dom-tree of modulemaps

Returns:

dom-tree representing the artifact

getIdFromMapping

private java.lang.String getIdFromMapping(org.codehaus.plexus.util.xml.Xpp3Dom mapping)

get the id from the href of a modulemap.

Parameters:

mapping - the dom-tree of modulemaps

Returns:

module identifier

readXMLFile

private org.codehaus.plexus.util.xml.Xpp3Dom readXMLFile(java.io.File xmlFile)

read an xml file (application.xml or .modulemaps).

Parameters:

xmlFile - an xmlfile

Returns:

dom-tree representing the file contents

handled

private void handled(org.codehaus.plexus.util.xml.Xpp3Dom xpp3Dom)

mark the domtree entry as handled (all not handled ones will be deleted).

Parameters:

xpp3Dom - dom element to mark handled

removeUnusedEntries

private void removeUnusedEntries(org.codehaus.plexus.util.xml.Xpp3Dom applicationXmlDom,
                                 org.codehaus.plexus.util.xml.Xpp3Dom modulemapsXmlDom)

delete all unused entries from the dom-trees.

Parameters:

applicationXmlDom - dom-tree of application.xml

modulemapsXmlDom - dom-tree of modulemaps

updateApplicationXml

private void updateApplicationXml(org.codehaus.plexus.util.xml.Xpp3Dom applicationXmlDom,
                                  org.codehaus.plexus.util.xml.Xpp3Dom modulemapXmlDom,
                                  IdeDependency dependency)

update the application.xml and the .modulemaps file for a specified dependency.all WAR an EJB dependencies will go in both files all others only in the modulemaps files. Webapplications contextroots are corrected to the contextRoot specified in the pom.

Parameters:

applicationXmlDom - dom-tree of application.xml

modulemapXmlDom - dom-tree of modulemaps

dependency - the eclipse dependency to handle

getContextRootFor

private java.lang.String getContextRootFor(IdeDependency dependency)

Find the contextRoot specified in the pom and convert it into contectroot for the application.xml.

Parameters:

dependency - the artifact to search

Returns:

string with the context root

writePrettyXmlFile

private void writePrettyXmlFile(java.io.File xmlFile,
                                org.codehaus.plexus.util.xml.Xpp3Dom xmlDomTree)
                         throws org.apache.maven.plugin.MojoExecutionException

write back a domtree to a xmlfile and use the pretty print for it so that it is human readable.

Parameters:

xmlFile - file to write to

xmlDomTree - dom-tree to write

Throws:

org.apache.maven.plugin.MojoExecutionException - if the file could not be written