diff --git a/j2ee/plugin.properties b/j2ee/plugin.properties deleted file mode 100644 index 5811388c..00000000 --- a/j2ee/plugin.properties +++ /dev/null @@ -1,128 +0,0 @@ -# ------------------------------------------------------------------- -# Default properties for the J2EE Plugin -# ------------------------------------------------------------------- -# These are the properties that we believe are immutable so we -# keep them apart from the project specific properties. -# ------------------------------------------------------------------- - -# ------------------------------------------------------------------- -# Properties for the "validate-war" target -# ------------------------------------------------------------------- -# Location where the webapp or the war will be created. Defaults to -# ${maven.build.dir} -maven.war.build.dir = ${maven.build.dir} - - -# ------------------------------------------------------------------- -# Properties for the "ear" target -# ------------------------------------------------------------------- - -# List of mandatory properties that need to be defined in the project -# properties for the "ear" target : -# -# maven.j2ee.ear.name : name of the ear - -# Location of the ear application.xml file -maven.j2ee.ear.appxml=${maven.src.dir}/application.xml - -# J2EE modules to include and exclude from the ear -# Note: These files are relative to ${maven.build.dir} -maven.j2ee.ear.includes=*.jar, *.war -maven.j2ee.ear.excludes= - -# ------------------------------------------------------------------- -# Properties for the "ejb" target -# ------------------------------------------------------------------- - -# Required - -#maven.j2ee.ejb.name - -# Defaulted - -maven.j2ee.ejb.conf.dir=${maven.conf.dir}/${maven.j2ee.ejb.name}/ -maven.j2ee.ejb.conf.includes=ejb-jar.xml -maven.j2ee.ejb.conf.excludes= -maven.j2ee.ejb.includes=** -maven.j2ee.ejb.excludes=**/package.html - -# Optional - -# Local Interfaces Jar -#maven.j2ee.ejb.local.includes=**/interfaces/*Local*.class -#maven.j2ee.ejb.local.excludes=**/package.html - -# Remote Interfaces Jar -#maven.j2ee.ejb.remote.includes=**/interfaces/* -#maven.j2ee.ejb.remote.excludes=**/interfaces/*Local*.class - - - -############################################################################# -# A P P S E R V E R -#---------------------------------------------------------------------------- - -# -# used to let the appserver implementation scripts know which version of j2ee we are -# running against -# -maven.j2ee.version=13 - -# -# the place where the main install of the application server resides -# -maven.appserver.home=/apps/jakarta-tomcat-4 - -# -# a supported name of an application server instance to install -# -maven.appserver.name=tomcat - -# -# version number of the application server, in the form of ## -# -maven.appserver.version=4.x - -## needed for dir names and messages to the user -maven.appserver.fullname=${maven.appserver.name}-${maven.appserver.version} - -# -# ports to access this server instance -# -maven.appserver.port.http=8082 -maven.appserver.port.https=8083 -maven.appserver.port.one=8087 -maven.appserver.port.two=8088 -maven.appserver.port.three=8089 - -# -# where to install the local instance of the server -# -maven.appserver.dir=${basedir}/server - -# -# files in an 'includes' pattern to include when controlling the server -# For example, if you have classes in your classpath you would like to -# include when starting the server, you could use -# maven.appserver.classpath=${java.class.path} -# paths can be absolute or relative to ${maven.appserver.dir} as that is -# where a jvm will be started. This is common for libraries that need sharing -# across all webapps installed in the server -# -maven.appserver.classpath= - -# -# The host name, used when configuring, defaults to localhost -# -maven.appserver.host=localhost - -# -# The URL used to test the current running status of the appserver -# -maven.appserver.url=http://${maven.appserver.host}:${maven.appserver.port.http}/index.html - - - - - - diff --git a/j2ee/xdocs/appserver.xml b/j2ee/xdocs/appserver.xml index dd441dc9..821d21c2 100644 --- a/j2ee/xdocs/appserver.xml +++ b/j2ee/xdocs/appserver.xml @@ -9,111 +9,10 @@

- This page offers some general information about the appserver control - features of the J2EE plug-in. Specific details about - related targets and - their properties can be found elsewhere. + The Maven J2EE Plugin appserver control features have been migrated to a + standalone Maven appserver plugin. For more information see the appserver + plugin documentation.

-
-

- When developing a web application (or website for that matter), each developer - working on the project needs to have an environment to run and test their - application. Rather than store a complete application server install in source - control, it is much more feasible to have a centralized install of that - application server. Then, using only the minimum configuration files the - developer can control a separate isolated instance of the application server - on their machine. -

-

- The Maven J2EE plug-in appserver features use this technique to install and control - application server instances for your project needs. The appserver - features are not for - deploying webapps or war files into application servers. -

-
- -
-

- The following table shows the various appserver versions that are - supported by the appserver control features of the Maven J2EE plug-in - and what propety values are required to be set in order for the - maven:appserver-* targets to work with those versions. -

- - - - - - - - - - - - - -
Server${maven.appserver.name}${maven.appserver.version}${maven.j2ee.version}
Tomcat 4.xtomcat4012 or 13
- -

The following application servers are expected to be supported soon:

- -
- -
-

- To make life even easier when using the appserver targets, the Maven J2EE - plug-in includes a proxy build file. This means a file similar to the one - below is copied to the directory specified by - ${maven.appserver.dir}. -

-
${maven.appserver.dir}/build.xml
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ]]> - -

Using this build file, you can run the appserver related targets quickly - from within your ${maven.appserver.dir} directory. Typing simply

- -

can stop, re-install, and re-start a started server instance.

-
diff --git a/j2ee/xdocs/changes.xml b/j2ee/xdocs/changes.xml index 1f8d761b..869c9257 100644 --- a/j2ee/xdocs/changes.xml +++ b/j2ee/xdocs/changes.xml @@ -3,6 +3,7 @@ Changes dIon Gillard + Peter Lynch @@ -12,11 +13,15 @@ b5 - Fix for jars not being included in an EAR file + Fix for jars not being included in an EAR file Added the new changes report. + + Removed appserver plugin from the J2EE project workspace. The Maven + appserver plugin is now a seperate project. + diff --git a/j2ee/xdocs/futures.xml b/j2ee/xdocs/futures.xml index 2daf5c8d..e4a117d3 100644 --- a/j2ee/xdocs/futures.xml +++ b/j2ee/xdocs/futures.xml @@ -15,7 +15,7 @@

  1. - We need to have Class-Path entries in generated J2EE EJB jars and + We need to have Class-Path entries in generated J2EE EJB jars and such. Quite tricky as it doesn't work the same for all application servers (and across versions of them !).
    2. @@ -32,14 +32,6 @@ Add technology specific validators, e.g. JSP/Turbine/Velocity/Struts etc -
  2. - Allow integration with a 'webserver' plugin so that application server - requests can seamlessly be hooked into the application server. -
    3. -
  3. - Tie where applicable the appserver instance to other Maven plugins that - need an application server instance to do their work. -
diff --git a/j2ee/xdocs/goals.xml b/j2ee/xdocs/goals.xml index 0c74647f..ea47afaa 100644 --- a/j2ee/xdocs/goals.xml +++ b/j2ee/xdocs/goals.xml @@ -11,12 +11,12 @@

- This document describes the supplied + This document describes the supplied goals that are available when using the J2EE Plug-in with Maven.

- Please refer to the + Please refer to the Integration document for more information on how to integrate these goals into your project. @@ -46,24 +46,6 @@ j2ee:ear Creates an EAR file. - - j2ee:appserver-install - Installs an Application Server instance - - - j2ee:appserver-start - Starts an Application Server instance - - - j2ee:appserver-stop - Stops an Application Server instance - - - j2ee:appserver-clean - Safely deletes the Application Server instance installation directory - specified by the ${maven.appserver.dir} - property. -

@@ -177,7 +159,7 @@ A J2EE enterprise application deployment descriptor, which is placed in the META-INF of the resulting ear file. The ${maven.j2ee.ear.appxml} - property defines the location of this file. It defaults to + property defines the location of this file. It defaults to src/application.xml @@ -185,7 +167,7 @@ Other Content Any dependencies specified in your project.xml - may be included by adding the ear.bundle.jar property to the + may be included by adding the ear.bundle.jar property to the properties, e.g. @@ -200,185 +182,6 @@ - - - - -

- The j2ee:appserver-install target installs the minimum - directory and file structure necessary for an individual application - server instance. Once the structure is created inside the - directory specified by ${maven.appserver.dir} - , configuration files are installed using the copy task and the filter - mechanism built into Ant. - The exact work done by this target is specific to the - name and version of the application server you specify using - ${maven.appserver.name} - and ${maven.appserver.version} - properties. -

-

- Optionally, you can invoke the install target of the - Ant build.xml file copied to ${maven.appserver.dir} instead. See the - appserver proxy build file for more - information. -

-

- During the configuration process, all - maven.appserver.* properties - are used as filter tokens while files in - ${maven.conf.dir}/${maven.appserver.name}${maven.appserver.version} are - copied to ${maven.appserver.dir}. By default, certain files are - excluded from copying to ${maven.appserver.dir}. Files excluded are: -

- -

- This allows you to keep you webapp specific conf files in the same - directory and not have them installed with this target needlessly. -

-

- Your configuration files may require additional processing ( using additional - filter tokens for example). In that case you can use the - maven-post-appserver-install - callback target to re-configure files. -

-

- This target has different behavior - depending on the current status of the application server. The - behavior is defined by the following rules: -

- - - - - - - - - - - - - - -
Server StatusBehavior
Not Installed - Install and configure the application server. -
Installed and stopped - Re-install/re-configure the application server. -
Installed and started - Stop, re-install/re-configure, re-start the application server. -
-

Note: In all situations, the j2ee:appserver-install - target will overwrite existing appserver configuration files already - installed. Maven does this because it cannot know if the you have changed - your maven.appserver.* related properties, - so it always re-configures the configuration files. Since this - operation has low overhead, it is considered a feature that allows dynamic - updates to your appserver related property values.

- - - -

- The j2ee:appserver-start target - attempts to start the application server instance you have specified - via properties. -

-

Optionally, you can invoke the start target of the - Ant build.xml file copied to ${maven.appserver.dir} instead. See the - appserver proxy build file for more - information. -

-

- This target will cause two processes to run. One process will - represent the running of the Ant build file for the Maven target. - The other will be the forked JVM that actually starts the application - server instance. -

-

- If you don't want the processes to block your current terminal, - you can execute the call to this target in the background using the - traditional '&' directive on unix-like systems. -

-

For example, to run the server in the background, go to your - ${maven.appserver.dir} directory and type:

- -

- This target has different behavior - depending on the current status of the application server. The - behavior is defined by the following rules: -

- - - - - - - - - - - - - - -
Server StatusBehavior
Not Installed - Install/configure, then start the application server. -
Installed and stopped - Start the application server. -
Installed and started - Stop and then re-start the application server. This is useful for - application servers that are not set to auto-reload resources. -
- - - -

- The j2ee:appserver-stop target - attempts to stop the application server instance you have specified - via the maven.appserver.* properties. -

-

Optionally, you can invoke the stop target of the - Ant build.xml file copied to ${maven.appserver.dir} instead. See the - appserver proxy build file for more - information. -

-

- This target only has relevance if the application server instance - is actually started. All other situations do nothing. -

- - - - -

- The j2ee:appserver-clean target - attempts to safely delete the directory specified by - ${maven.appserver.dir}. -

-

- This target has different behavior - depending on the current status of the application server. The - behavior is defined by the following rules: -

- - - - - - - - - - -
Server StatusBehavior
Installed and stopped - Deletes the directory specified by ${maven.appserver.dir}. -
Installed and started - Stop the application server instance and then delete the directory - specified by ${maven.appserver.dir}. -
-
diff --git a/j2ee/xdocs/index.xml b/j2ee/xdocs/index.xml index 071a15aa..6b6deac4 100644 --- a/j2ee/xdocs/index.xml +++ b/j2ee/xdocs/index.xml @@ -41,19 +41,12 @@ hierarchy is used for. - Appserver Notes + Appserver Control

This page contains additional reference material regarding the application server ( appserver ) control features of the Maven J2EE plugin.

-

- For additional help in understanding what the appserver features of the - Maven J2EE plugin are, look at the - J2EE plug-in properties - and J2EE build file - documents. -

Futures diff --git a/j2ee/xdocs/navigation.xml b/j2ee/xdocs/navigation.xml index 27681333..e3b8c7a4 100644 --- a/j2ee/xdocs/navigation.xml +++ b/j2ee/xdocs/navigation.xml @@ -11,7 +11,7 @@ - + diff --git a/j2ee/xdocs/properties.xml b/j2ee/xdocs/properties.xml index 37057845..a704764f 100644 --- a/j2ee/xdocs/properties.xml +++ b/j2ee/xdocs/properties.xml @@ -27,13 +27,6 @@

- - - - - - - -
SectionDescription
General Settings - These properties specify various settings that may be used in any - J2EE Plug-in target. -
War @@ -55,43 +48,10 @@ of an ear file by the J2EE Plug-in.
Appserver - These properties detail what application server instance you would - like to install and control for your project and how to configure - it. -
-
- - - - - - - -
PropertyOptional?Description
maven.j2ee.version - No for the "appserver:install" goal. - Otherwise, Yes. - - Specifies the version of J2EE you are trying to use. Valid values are: -
    -
  • 12
    • -
  • 13
    • -
- The above values represent version 1.2 and 1.3 respectively. - The value of this property is especially important for the - supported servers - used with the appserver control features of this plugin. -
-
- -
@@ -320,149 +280,5 @@
PropertyOptional?Description
- - - -
-

Although application server ( appserver ) instance control is part - of the J2EE plugin, all appserver related properties begin with - the "maven.appserver" prefix. This is indicative of the large scope of - functionality within the appserver targets. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyOptional?Description
maven.appserver.nameNo - Specifies the name of the application server to install and control - for your project. -

- Please refer to the supported servers - table for a current list of supported appservers and the ${maven.appserver.name} - value they use use. -

maven.appserver.versionNo - Specifies the version of the appserver to install and control - for your project. Please refer to the - supported servers - table for a current list of supported appservers and the - ${maven.appserver.version} value they use. -
maven.appserver.homeNo - Specifies the directory where the shared installation of the appserver - resides. This should be the home of the appserver specified by - ${maven.appserver.name} - and ${maven.appserver.version}. -
maven.appserver.dirNo - Specifies the directory where the appserver instance is installed - during the "appserver:install" goal. - Defaults to be ${basedir}/server . -
maven.appserver.hostNo - Specifies the default host to use to access the started server - instance. Defaults to 'localhost'. -
maven.appserver.port.httpNo - Specifies the HTTP port number to use to access the started server - instance. Defaults to 8080. -
maven.appserver.urlNo - The URL that is used to test if your appserver instance is running. - This URL must point to a target that will return a response code < 400 - when your appserver instance is started. Default value is - http://${maven.appserver.host}:${maven.appserver.port.http}/index.html -
maven.appserver.port.httpsYes - Specifies the HTTPS port number to use to access the started server - instance using SSL. Defaults to 444. -
maven.appserver.port.oneYes - Optional additional port you can specify when configuring appserver files during - install. -
maven.appserver.port.twoYes - Optional additional port you can specify when configuring appserver files during - install. -
maven.appserver.port.threeYes - Optional additional port you can specify when configuring appserver files during - install. -
maven.appserver.classpathYes - A path-like - value that can specify resources to make available as - part of the classpath of the JVM used when controlling your appserver instance. - For example, you may have several webapps running in the same container - that require a JDBC driver be available. Adding a reference to that - jar here will put it in the classpath of the JVM used to start - your appserver. -

- An example of a valid value might be: -

- /jars/database.jar;/jars/foobar.jar -

- Path seperators are automatically converted to their system correct values. - By default, there are no additional paths. Jars required to control an appserver - are automatically built-in and do not need to be added here. -

-