I recently ran into a problem when using maven resource filtering from within Eclipse. The problem was that properties in xml files (in this case a spring configuration file) weren’t expanded. Eventually i figured out what was causing the problem. That’s what this small blog is about.
As noted i wanted maven to expand some properties – datasource properties in this case – in a spring configuration file. The idea was to externalize the datasource connection information in various environment files, so that during deployment the right datasource connection information would be put in the spring configuration file according to the deployment environment, eg. local, test, staging.
For this i altered the spring conguration file, called spring-config.xml in my case, and changed the configuration for the dataSource spring bean into the one resembling the xml stanza below:
Now i used eclipse with the m2eclipse plugin and defined the following configuration for packaging the project (a web application) to a war file suitable for my local environment:
Notice the embedded Maven Runtime which is selected by default.
After running the configuration the properties for the datasource bean were not expanded and the original spring configuration file for the local deployment got packaged. I also noticed that maven properties in property text files as opposed to xml files, did get expanded. So the problem only occurred in xml files.
I noticed that running the package maven goal from a terminal window did expand the properties. So eventually i realized that the embedded maven version selected by default was the cause of distress. After i switched the maven runtime for the run configuration to the maven version currently installed on my ubuntu distribution, the problem was solved. See the picture below for this configuration.
The maven version on my ubuntu distribution, by the way, was installed via the following command:
sudo apt-get install maven2
Note that in future versions the bug in the maven embedded runtime may be fixed.
Recently I changed a seam-gen generated project into a maven project. It took me a while to get it all up and running. In this blog I’ll try to summarize all the steps needed to convert a seam-gen app (the open18 app I created in the previous blogs) into a full blown Maven project called open18_mvn2. I took the liberty to stretch the Maven pom to support deployment to glassfish as well as jboss.
Above is the list with prerequisites. Most of them are taken care of when you’ve followed all the steps in the previous blog series “Seam-gen on glassfish”.
You’ve created the seam-gen project open18;
You’ll have a mysql database up and running in which resides the open18 catalog with application data.
You’ll have a glassfish installation available in ~/opt/glassfishv2;
The necessary hibernate and slf4j/log4j libraries and the mysql-connector-java-5.1.12-bin.jar file are all available in the <glassfish_home>/domains/domain1/lib/ext directory. This can be done via the ant task gf-prepare of the seam-gen app;
A connection pool (open18Pool) together with a datasource (open18Datasource) for connecting to the mysql open18 catalog is available in the glassfish server. This datasource can be installed on the server via the ant task gf-deploy-datasource of the seam-gen app;
For this blog I added a jboss server installation and put it in ~/opt/jboss-5.1.0.GA;
See the next section for installation details;
The mysql driver mysql-connector-java-5.1.12-bin.jar is available in the <jboss_home>/server/default/lib directory;
A datasource file open18-ds.xml is available in the jboss server directory <jboss_home>/server/default/deploy for connecting to the mysql open18 catalog. This datasource can be installed on the server via the ant task datasource of the seam-gen app.
Next we’ll setup the maven project structure, wherein we will copy the necessary files from the seam-gen app.
hot: Folder for the hot deployable sources (i.e. the action classes). In the seam-gen app this is the src/hot folder;
java: Folder for the ordinary java sources (eg. the model classes). In the seam-gen app this is the src/main folder;
resources: All the resource files. In the seam-gen app this is the resources folder without the WEB-INF folder. Of all the multiple environment files, I only added the -dev files and renamed them by dropping the –dev extension. For example, i’ve renamed the components-dev.properties to components.properties.;
webap: The web-app folder containing all the view files. In the seam-gen app this is the view folder combined with the resources/WEB-INF folder;
bootstrap: The bootstrap files needed for testing with jboss-embedded. In the seam-gen app this is the bootstrap folder;
java: Folder for the test classes. In the seam-gen app this is the src/test folder;
resources: Resource files for testing. In the seam-gen app these are the resources/META-INF/persistence-test.xml, resources/components-test.properties and resources/import-test.sql files. I’ve renamed them by dropping off the -test extension.
This is the pom file with which it’ll be possible to eg. test and explode the application to glassfish and jboss. I’ve highlighted the lines which I will comment upon in this section.
the webapp directory: this includes for one the facelets and page desciptors;
the test resources directory: this will contain files like persistence.xml and components.properties;
the test bootstrap directory: this will contain the bootstrap files needed for testing with jboss embedded server.
line 330-340: maven-surefire-plugin
Make sure to add this plugin configuration, or else the tests will surely fail.
line 351-384: maven-antrun-plugin
This is a little workaround. JBoss embedded unfortunately doesn’t see the persistence.xml file in the target/test-classes/META-INF directory. It has to be in the target/classes/META-INF directory. To work around this issue, we’ll make a backup of the persistence.xml in the classes tree and replace it with the test-classes version. After the testing phase we’ll put the backed up persistence.xml file back in place.
line 390: jboss.local profile
Profile for hot deployment and undeployment to jboss.
line 425: directory.deploy.jboss
Make sure to point this to the domain folder of your jboss installation.
line 430: glassfish.local profile
Profile for hot deployment and undeployment to glassfish.
line 484: glassfish.home
Make sure to point this to your glassfish installation.
At this point your project in Netbeans should look like the picture below
5. Test class example
To check if testing (and especially persistence against the Hypersonic database) works correctly I’ve added the test class org.open18.test.CreateNewFacilityActionTest, which adds a new facility. Note that you have to be logged in first to be able to make any permanent changes:
Because the generated JPA classes all contain a catalog named “OPEN18” you need to make sure that when Hibernate is going to create the tables in the Hypersonic database you’re connected to a schema by the same name. If you don’t do this, you’ll get a bunch of “invalid schema name OPEN18” messages when running the maven test goal. Add the following line below the displayed comment
<!-- sql to call when connection is created -->
<new-connection-sql>CREATE SCHEMA OPEN18 AUTHORIZATION DBA</new-connection-sql>
7. Running the goals
Now you can test your Maven seam-gen app.
Test (Netbeans context menu) will run the maven test goal;
Run (Netbeans context menu) and selecting a server will deploy the application;
Clean (Netbeans context menu) will run the maven clean goal. When you’ve set one of the profiles (via the Set Configuration context menu) it will also undeploy the application from the server;
Profile jboss.local (via Custom goals context menu) will hot deploy the application to jboss;
Goal prepare-package with profile glassfish.local (via Custom goals context menu) will hot deploy the application to glassfish.