Develop Reference

Configurable outputDirectory for maven war plugin using Git

I have put up a maven project on git repository which is using maven-war-plugin to create war directly in tomcat directory. But on different systems, tomcat directory path can be different.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-war-plugin</artifactId>
<version>2.3</version>
<configuration>
<outputDirectory><file-path></outputDirectory>
</configuration>
</plugin>
I want this outputDirectory parameter to be configurable without needing to change pom.xml on local systems.

I faced the exact same issue and I resolved it by putting the below plugin in my POM file.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-war-plugin</artifactId>
<version>2.6</version>
<configuration>
<resources>
<resource>
<directory>${project.basedir}/src/main/resources</directory>
</resource>
</resources>
</configuration>
</plugin>
<properties>
<failOnMissingWebXml>false</failOnMissingWebXml>
</properties>

As ali4j mentioned in comment, using env variable is appropriate solution for this scenario. Use a custom env variable in POM and ask the users to set the env in their system.
How to refer environment variable in POM.xml?

Eclipse Mars. Java Spring - Maven Profile Switch for Build Environments [duplicate]

This question already has answers here:
Building two different versions a given war with maven profiles and filtering from eclipse
(2 answers)
Closed 6 years ago.
#Jarrod Roberson, Spring in this question is about version 1.2 so the other solution was not possible. This solution uses a simple Maven configuration and Spring's PropertyPlaceholderConfigurer in applicationContext.xml.
I have upgraded a webapp I work on from Windows XP, Eclipse 3.2 to OS X, Eclipse Mars.
I started with a Dynamic Web Project on Mars and completed the upgrade. I have since converted it to a Maven Project. I was hoping to use Maven Profiles for switching between Dev and Test environments.
The environments differ only in config.properties which gets pulled into applicationContext.xml. For Test I only intend to export to a war with the 'correct' config.properties.
But I cannot get the config.properties file to be updated from the profile dependent versions when switching profiles.
I have in pom.xml:-
<profiles>
<profile><!-- The configuration of the development profile -->
<id>dev</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<build.profile.id>dev</build.profile.id>
</properties>
</profile>
<profile><!-- The configuration of the test profile -->
<id>test</id>
<properties>
<build.profile.id>test</build.profile.id>
</properties>
</profile>
</profiles>
<build>
<sourceDirectory>src</sourceDirectory>
<filters>
<filter>profiles/${build.profile.id}/config.properties</filter>
</filters>
<resources>
<resource>
<filtering>true</filtering>
<directory>src</directory>
<excludes>
<exclude>**/*.java</exclude>
</excludes>
</resource>
</resources>
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.3</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
<plugin>
<artifactId>maven-war-plugin</artifactId>
<version>2.6</version>
<configuration>
<warSourceDirectory>WebContent</warSourceDirectory>
<failOnMissingWebXml>false</failOnMissingWebXml>
</configuration>
</plugin>
</plugins>
</build>
I feel that I am close but something is missing. I tried adding the maven-resources-plugin but that made no difference.
Any help would be much appreciated.

Instead of having your config.properties file placed in the src/ folder you should have it inside your src/main/resources folder.
Your project structure should look like this:
project-root
|_ src
|_ main
|_ java
|_ resources
|_ profiles
|_ dev
|_ config.properties
|_ test
|_ config.properties
|_ webapp
|_ WEB-INF
After that you've to change your pom.xml in order to include your config.properties as a resource.
And notice that the filters have been removed since Maven is already filtering your resources when you have <filtering>true</filtering>.
Your pom.xml will look like this:
<build>
<sourceDirectory>src</sourceDirectory>
<resources>
<resource>
<filtering>true</filtering>
<directory>src/main/resources/profiles/${build.profile.id}</directory>
<excludes>
<exclude>**/*.java</exclude>
</excludes>
<includes>
<include>*.properties</include>
</includes>
</resource>
</resources>
...
</build>
Finally, you'll have your config.properties inside your WEB-INF/classes folder, according to the selected profile.

This worked for me:-
<build>
<sourceDirectory>src</sourceDirectory>
<resources>
<resource>
<filtering>true</filtering>
<directory>profiles/${build.profile.id}</directory>
<excludes>
<exclude>**/*.java</exclude>
</excludes>
<includes>
<include>*.properties</include>
</includes>
</resource>
</resources>
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.3</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
<plugin>
<artifactId>maven-war-plugin</artifactId>
<version>2.6</version>
<configuration>
<warSourceDirectory>WebContent</warSourceDirectory>
<failOnMissingWebXml>false</failOnMissingWebXml>
</configuration>
</plugin>
</plugins>
</build>
I am using a Dynamic Web folder structure not a 'pure' Maven folder structure (eg. src/main/java).
My profiles folder is directly under the project (webapp) folder at the same level as src. Under profiles I have two folders, dev and test each with their respective config.properties file.
It now works as expected, when I change profile the correct config.properties appears in WEB-INF/classes ready to be picked up by applicationContext.xml...

Exclude a package from build path in POM

I have a package de.ht.ak.praktikum.hook in a project which is in a source folder src but it should be excluded from build path. I used to do this with right click on it and choosing Build Path -> Exclude. Since I added maven to the project every time I update the project the excluded folder turns into package again, i.e. the exclusion gets deleted. I tried to fix it this way:
...
<build>
<sourceDirectory>src</sourceDirectory>
<resources>
<resource>
<directory>src</directory>
<excludes>
<exclude>de/ht/ak/praktikum/hook</exclude>
</excludes>
</resource>
</resources>
...
</build>
...
I tried also to do it as described there:
...
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-eclipse-plugin</artifactId>
<version>3.1</version>
<configuration>
<sourceExcludes>
<sourceExclude>de/ht/ak/praktikum/hook/</sourceExclude>
</sourceExcludes>
<sourceIncludes>
<sourceInclude>**/*.java</sourceInclude>
</sourceIncludes>
</configuration>
</plugin>
...
However none of the both methods help. Any ideas?

Your first attempt won't work because you're specifying to exclude it as a resource (i.e., those files that get packaged in your resulting JAR file - you don't usually want source files to be among them).
The second attempt is more on the right track. However, you want to exclude them from compilation, hence you need to set the exclude option of the maven-compiler-plugin. I.e., like this:
<build>
..
<plugins>
..
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.2</version>
<configuration>
<excludes>
<exclude>de/ht/ak/praktikum/hook/*.java</exclude>
</excludes>
</configuration>
</plugin>
..
</plugins>
</build>
When updating the project in Eclipse (Maven -> Update Project), Eclipse should honor this configuration and also exclude it from the Eclipse-internal build path.

Best practice for packaging resource files and classes with Maven

Currently I have a sample maven project with the following build part where I specify a second resource location directory:
<project>
...
<build>
<resources>
<resource>
<directory>src/main/second-resources</directory>
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.1</version>
<configuration>
<source>${maven.compiler.source}</source>
<target>${maven.compiler.target}</target>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.4</version>
<configuration>
<finalName>${artifactId}</finalName>
<outputDirectory>${jarBuildPath}</outputDirectory>
</configuration>
</plugin>
</plugins>
</build>
</project>
I can get my jar packaged with this configuration having my classes and resource files just in right place and with no issue.
But when adding the property <classesDirectory> to my maven-jar-plugin configuration snippet with value src/main/java:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.4</version>
<configuration>
<classesDirectory>src/main/java</classesDirectory>
<finalName>${artifactId}</finalName>
<outputDirectory>${jarBuildPath}</outputDirectory>
</configuration>
</plugin>
then when packaging my archive, hell, my resource files are no longer there.
From maven official documentation for the classesDirectory property, it says that Directory containing the classes and resource files that should be packaged into the JAR. and that makes all sense for me and it is quite fair that my resource files get disappeared since maven assumes that no file has the right to be packaged unless it is under src/main/java.
But my big thought was when specifying my resource files location (with one of the options below), Maven will be aware of the files location even if I had specified the <classesDirectory> entry.
With top level <resources> entry
<resources>
<resource>
<directory>src/main/second-resources</directory>
</resource>
</resources>
or via the maven-resource-plugin
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>2.6</version>
<configuration>
<resources>
<resource>
<directory>src/main/second-resources</directory>
</resource>
</resources>
</configuration>
</plugin>
I can tell you that I'm quite familiar with maven but this issue seemed weird for me: Is it not recommended to have in maven-jar-plugin when you have a some custom resource directory?
Can anyone kindly drop some light on this?
BR.

The classesDirectory is the directory where
the compiler plugin stores compiled java classes
the resources-plugin copies resources to be included in the file
created by the jar-plugin.
You have changed it to your java source code directory in the jar-plugin configuration.
Therefore, I imagine that your jar now only contains java source files.
Is this what you want, or are you just trying to include a second source of resource files?
If the latter, then just adding:
<resources>
<resource>
<directory>src/main/resources</directory>
</resource>
<resource>
<directory>src/main/second-resources</directory>
</resource>
</resources>
should accomplish what you want without adding any configuration to the jar plugin. Note that the first <resource>..</resource> section is needed if you still have stuff you want in the default src/main/resources location.

Is it possible to configure additional folders in arbitrary locations to serve static resource in a war file

By default, files under web-app are served, in an application container like tomcat, as static resources. So if I save a file like helloworld.html in those I can view it from my browser at
http://localhost:8080/myapp/helloworld.html
Is it possible to configure additional folders other than web-app to serve static content. I would prefer to do this from within the war file itself instead of having to configure it on a tomcat-wide way.
Any suggestions?

Maven's war plugin is a good fit here. This offers several configuration options when building the war so it'll be independent of your web server.
And an example where a different directory can be hosted as you suggest
<project>
...
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-war-plugin</artifactId>
<version>2.3</version>
<configuration>
<webResources>
<resource>
<!-- this is relative to the pom.xml directory -->
<directory>resource2</directory>
</resource>
</webResources>
</configuration>
</plugin>
</plugins>
</build>
...
</project>
Here's an another example they give where a different webapp folder can be used.
<project>
...
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-war-plugin</artifactId>
<version>2.3</version>
<configuration>
<webappDirectory>/sample/servlet/container/deploy/directory</webappDirectory>
</configuration>
</plugin>
</plugins>
</build>
...
</project>