Using the properties tag within maven profiles

balteo picture balteo · Aug 22, 2012 · Viewed 28.1k times · Source

I am in reference to "Maven: The Complete Reference" and especially the section regarding profiles which documents the use of a <properties... tag within the <profile... tag here: see here

 <profile>
            <id>development</id>
            <activation>
                <activeByDefault>true</activeByDefault>
                <property>
                    <name>environment.type</name>
                    <value>dev</value>
                </property>
            </activation>
            <properties>
                <database.driverClassName>com.mysql.jdbc.Driver</database.driverClassName>
                <database.url>
                    jdbc:mysql://localhost:3306/app_dev
                </database.url>
                <database.user>development_user</database.user>
                <database.password>development_password</database.password>
            </properties>
        </profile>

What I am not sure about is what happens when the mvn install -Denvironment.type=dev command is run:

  • Will this create a .properties file?
  • If not how and where will tomcat (for instance) read the individual properties when the app is tested in dev?

Answer

polypiel picture polypiel · Aug 22, 2012

Will this create a .properties file?

No, it won't. This would set the properties used by maven. This is, with mvn install -Denvironment.type=development maven would use the value 'development_user' for the variable 'database.user' (that you can use as ${database.user} in poms and filtered resources).

If not how and where will tomcat (for instance) read the individual properties when the app is tested in dev?

The thing is to tell maven to filter (and modify) the resources that you want to customize depending on the profile (properties.files).

So, first you have to say maven to filter the resources:

<build>
    <resources>
        <resource>
             <directory>src/main/resources</directory>
             <filtering>true</filtering>
        </resource>
    </resources> 
</build>

Then modify your properties files to use maven variables. For example, your db properties file would look like this:

database.driverClassName=${database.driverClassName}
database.url=${database.url}
#...