org.apache.maven.plugin.eclipse

Class RadPlugin

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.ide.AbstractIdeSupportMojo

org.apache.maven.plugin.eclipse.EclipsePlugin

org.apache.maven.plugin.eclipse.RadPlugin

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.codehaus.plexus.logging.LogEnabled

public class RadPlugin
extends EclipsePlugin

Generates the rad-6 configuration files.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	COM_IBM_ETOOLS_J2EE_UI_LIB_DIR_BUILDER
private static java.lang.String	COM_IBM_ETOOLS_SITEEDIT_SITE_NAV_BUILDER
private static java.lang.String	COM_IBM_ETOOLS_SITEEDIT_SITE_UPDATE_BUILDER
private static java.lang.String	COM_IBM_ETOOLS_SITEEDIT_WEB_SITE_NATURE
private static java.lang.String	COM_IBM_ETOOLS_VALIDATION_VALIDATIONBUILDER
private static java.lang.String	COM_IBM_ETOOLS_WEBPAGE_TEMPLATE_TEMPLATEBUILDER
private static java.lang.String	COM_IBM_ETOOLS_WEBPAGE_TEMPLATE_TEMPLATENATURE
private static java.lang.String	COM_IBM_ETOOLS_WEBTOOLS_ADDITIONS_JSPCOMPILATIONBUILDER
private static java.lang.String	COM_IBM_ETOOLS_WEBTOOLS_ADDITIONS_LINKSBUILDER
private static java.lang.String	COM_IBM_SSE_MODEL_STRUCTUREDBUILDER
private static java.lang.String	COM_IBM_WTP_EJB_EJBNATURE
private static java.lang.String	COM_IBM_WTP_J2EE_EARNATURE
private static java.lang.String	COM_IBM_WTP_J2EE_LIB_COPY_BUILDER
private static java.lang.String	COM_IBM_WTP_MIGRATION_MIGRATION_BUILDER
private static java.lang.String	COM_IBM_WTP_WEB_WEB_NATURE
private java.lang.String	generatedResourceDirName Use this to specify a different generated resources folder than target/generated-resources/rad6.
private static java.lang.String	NO_GENERATED_RESOURCE_DIRNAME
private static java.lang.String	ORG_ECLIPSE_JDT_CORE_JAVABUILDER
private static java.lang.String	ORG_ECLIPSE_JDT_CORE_JAVANATURE
private java.lang.String	warContextRoot The context root of the webapplication.

Fields inherited from class org.apache.maven.plugin.eclipse.EclipsePlugin

ASPECTJ_FILE_PATTERN, ASPECTJ_RT_CONTAINER, BUILDER_WST_VALIDATION, classpathContainersLast, COMMON_PATH_JDT_LAUNCHING_JRE_CONTAINER, JAVA_FILE_PATTERN, jeeversion, limitProjectReferencesToWorkspace, REQUIRED_PLUGINS_CONTAINER, testSourcesLast, workspace, WTP_SUPPORTED_VERSIONS

Fields inherited from class org.apache.maven.plugin.ide.AbstractIdeSupportMojo

artifactCollector, artifactFactory, artifactMetadataSource, artifactResolver, downloadJavadocs, downloadSources, executedProject, forceRecheck, localRepository, logger, packaging, project, reactorProjects, remoteArtifactRepositories

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

ROLE

Constructor Summary

Constructors

Constructor and Description
RadPlugin()

Method Summary

Modifier and Type	Method and Description
private void	addManifestResource(EclipseWriterConfig config) make room for a Manifest file.
protected void	fillDefaultBuilders(java.lang.String packaging) overwite the default builders with the builders required by RAD6.
protected void	fillDefaultNatures(java.lang.String packaging) overwite the default natures with the natures required by RAD6.
java.lang.String	getProjectNameForArifact(org.apache.maven.artifact.Artifact artifact) Find the name of the project as used in eclipse.
java.lang.String	getWarContextRoot()
private static java.lang.String	getWebContentBaseDirectory(EclipseWriterConfig config) Returns absolute path to the web content directory based on configuration of the war plugin or default one otherwise.
protected boolean	isAvailableAsAReactorProject(org.apache.maven.artifact.Artifact artifact) Utility method that locates a project producing the given artifact.
protected void	setupExtras() WARNING: The manifest resources added here will not have the benefit of the dependencies of the project, since that's not provided in the setup() apis...
void	setWarContextRoot(java.lang.String warContextRoot)
protected void	writeConfigurationExtras(EclipseWriterConfig config) write all rad6 configuration files.

Methods inherited from class org.apache.maven.plugin.eclipse.EclipsePlugin

buildDirectoryList, checkDeprecationsExtras, convertBuildCommandList, createEclipseWriterConfig, extractResourceDirs, fillDefaultClasspathContainers, getAdditionalBuildcommands, getAdditionalProjectnatures, getBuildcommands, getBuildOutputDirectory, getClasspathContainers, getEclipseProjectDir, getExcludes, getLinkedResources, getProjectNameTemplate, getProjectnatures, getUseProjectReferences, getWorkspaceArtefacts, getWorkspaceConfiguration, getWtpversion, hasToResolveJar, isAddGroupIdToProjectName, isAddVersionToProjectName, isJavaProject, isPdeProject, setAddGroupIdToProjectName, setAdditionalBuildcommands, setAdditionalProjectnatures, setAddVersionToProjectName, setBuildcommands, setBuildOutputDirectory, setClasspathContainers, setEclipseProjectDir, setLinkedResources, setProjectNameTemplate, setProjectnatures, setup, setUseProjectReferences, setWtpversion, useProjectReference, validateExtras, writeConfiguration

Methods inherited from class org.apache.maven.plugin.ide.AbstractIdeSupportMojo

doDependencyResolution, enableLogging, execute, getArtifactFactory, getArtifactMetadataSource, getArtifactResolver, getDownloadJavadocs, getDownloadSources, getExecutedProject, getLocalRepository, getProject, getReactorProject, getReactorProjects, getRemoteArtifactRepositories, isMavenVersion, isResolveDependencies, setArtifactFactory, setArtifactMetadataSource, setArtifactResolver, setDownloadJavadocs, setDownloadSources, setExecutedProject, setLocalRepository, setProject, setReactorProjects, setRemoteArtifactRepositories, setResolveDependencies

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

COM_IBM_ETOOLS_J2EE_UI_LIB_DIR_BUILDER

private static final java.lang.String COM_IBM_ETOOLS_J2EE_UI_LIB_DIR_BUILDER

See Also:

Constant Field Values

COM_IBM_ETOOLS_SITEEDIT_SITE_NAV_BUILDER

private static final java.lang.String COM_IBM_ETOOLS_SITEEDIT_SITE_NAV_BUILDER

See Also:

Constant Field Values

COM_IBM_ETOOLS_SITEEDIT_SITE_UPDATE_BUILDER

private static final java.lang.String COM_IBM_ETOOLS_SITEEDIT_SITE_UPDATE_BUILDER

See Also:

Constant Field Values

COM_IBM_ETOOLS_SITEEDIT_WEB_SITE_NATURE

private static final java.lang.String COM_IBM_ETOOLS_SITEEDIT_WEB_SITE_NATURE

See Also:

Constant Field Values

COM_IBM_ETOOLS_VALIDATION_VALIDATIONBUILDER

private static final java.lang.String COM_IBM_ETOOLS_VALIDATION_VALIDATIONBUILDER

See Also:

Constant Field Values

COM_IBM_ETOOLS_WEBPAGE_TEMPLATE_TEMPLATEBUILDER

private static final java.lang.String COM_IBM_ETOOLS_WEBPAGE_TEMPLATE_TEMPLATEBUILDER

See Also:

Constant Field Values

COM_IBM_ETOOLS_WEBPAGE_TEMPLATE_TEMPLATENATURE

private static final java.lang.String COM_IBM_ETOOLS_WEBPAGE_TEMPLATE_TEMPLATENATURE

See Also:

Constant Field Values

COM_IBM_ETOOLS_WEBTOOLS_ADDITIONS_JSPCOMPILATIONBUILDER

private static final java.lang.String COM_IBM_ETOOLS_WEBTOOLS_ADDITIONS_JSPCOMPILATIONBUILDER

See Also:

Constant Field Values

COM_IBM_ETOOLS_WEBTOOLS_ADDITIONS_LINKSBUILDER

private static final java.lang.String COM_IBM_ETOOLS_WEBTOOLS_ADDITIONS_LINKSBUILDER

See Also:

Constant Field Values

COM_IBM_SSE_MODEL_STRUCTUREDBUILDER

private static final java.lang.String COM_IBM_SSE_MODEL_STRUCTUREDBUILDER

See Also:

Constant Field Values

COM_IBM_WTP_EJB_EJBNATURE

private static final java.lang.String COM_IBM_WTP_EJB_EJBNATURE

See Also:

Constant Field Values

COM_IBM_WTP_J2EE_EARNATURE

private static final java.lang.String COM_IBM_WTP_J2EE_EARNATURE

See Also:

Constant Field Values

COM_IBM_WTP_J2EE_LIB_COPY_BUILDER

private static final java.lang.String COM_IBM_WTP_J2EE_LIB_COPY_BUILDER

See Also:

Constant Field Values

COM_IBM_WTP_MIGRATION_MIGRATION_BUILDER

private static final java.lang.String COM_IBM_WTP_MIGRATION_MIGRATION_BUILDER

See Also:

Constant Field Values

COM_IBM_WTP_WEB_WEB_NATURE

private static final java.lang.String COM_IBM_WTP_WEB_WEB_NATURE

See Also:

Constant Field Values

NO_GENERATED_RESOURCE_DIRNAME

private static final java.lang.String NO_GENERATED_RESOURCE_DIRNAME

See Also:

Constant Field Values

ORG_ECLIPSE_JDT_CORE_JAVABUILDER

private static final java.lang.String ORG_ECLIPSE_JDT_CORE_JAVABUILDER

See Also:

Constant Field Values

ORG_ECLIPSE_JDT_CORE_JAVANATURE

private static final java.lang.String ORG_ECLIPSE_JDT_CORE_JAVANATURE

See Also:

Constant Field Values

warContextRoot

private java.lang.String warContextRoot

The context root of the webapplication. This parameter is only used when the current project is a war project, else it will be ignored.

generatedResourceDirName

private java.lang.String generatedResourceDirName

Use this to specify a different generated resources folder than target/generated-resources/rad6. Set to "none" to skip this folder generation.

Constructor Detail

RadPlugin

public RadPlugin()

Method Detail

getWarContextRoot

public java.lang.String getWarContextRoot()

Returns:

Returns the warContextRoot.

setWarContextRoot

public void setWarContextRoot(java.lang.String warContextRoot)

Parameters:

warContextRoot - The warContextRoot to set.

writeConfigurationExtras

protected void writeConfigurationExtras(EclipseWriterConfig config)
                                 throws org.apache.maven.plugin.MojoExecutionException

write all rad6 configuration files.
NOTE: This could change the config!

Overrides:

writeConfigurationExtras in class EclipsePlugin

Parameters:

deps - resolved dependencies to handle

Throws:

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

See Also:

EclipsePlugin#writeConfiguration()

addManifestResource

private void addManifestResource(EclipseWriterConfig config)
                          throws org.apache.maven.plugin.MojoExecutionException

make room for a Manifest file. use a generated resource for JARS and for WARS use the manifest in the webapp/meta-inf directory.

Throws:

org.apache.maven.plugin.MojoExecutionException

getWebContentBaseDirectory

private static java.lang.String getWebContentBaseDirectory(EclipseWriterConfig config)
                                                    throws org.apache.maven.plugin.MojoExecutionException

Returns absolute path to the web content directory based on configuration of the war plugin or default one otherwise.

Parameters:

project -

Returns:

absolute directory path as String

Throws:

org.apache.maven.plugin.MojoExecutionException

fillDefaultBuilders

protected void fillDefaultBuilders(java.lang.String packaging)

overwite the default builders with the builders required by RAD6.

Overrides:

fillDefaultBuilders in class EclipsePlugin

Parameters:

packaging - packaging-type (jar,war,ejb,ear)

fillDefaultNatures

protected void fillDefaultNatures(java.lang.String packaging)

overwite the default natures with the natures required by RAD6.

Overrides:

fillDefaultNatures in class EclipsePlugin

Parameters:

packaging - packaging-type (jar,war,ejb,ear)

isAvailableAsAReactorProject

protected boolean isAvailableAsAReactorProject(org.apache.maven.artifact.Artifact artifact)

Utility method that locates a project producing the given artifact.

Overrides:

isAvailableAsAReactorProject in class EclipsePlugin

Parameters:

artifact - the artifact a project should produce.

Returns:

true if the artifact is produced by a reactor projectart.

setupExtras

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

WARNING: The manifest resources added here will not have the benefit of the dependencies of the project, since that's not provided in the setup() apis...

Overrides:

setupExtras in class EclipsePlugin

Throws:

org.apache.maven.plugin.MojoExecutionException - mojo failures.

getProjectNameForArifact

public java.lang.String getProjectNameForArifact(org.apache.maven.artifact.Artifact artifact)

Find the name of the project as used in eclipse.

Overrides:

getProjectNameForArifact in class EclipsePlugin

Parameters:

artifact - The artifact to find the eclipse name for.

Returns:

The name os the eclipse project.