curiousity
curiousity

Reputation: 4741

how to get property value from pom.xml?

I have added a node in my pom.xml:

<properties>
        <getdownload-webapp.version>1.5</getdownload-webapp.version>
</properties>

how could I get this 1.5 value in code?

String version = System.getProperty("getdownload-webapp.version"); // output version = null

This code gave me null while running(

ps: there is no settings.xml in this project

Upvotes: 11

Views: 29588

Answers (4)

awwsmm
awwsmm

Reputation: 1445

So you have a property like this.

<properties>
    <getdownload-webapp.version>1.5</getdownload-webapp.version>
</properties>

Create a file as follows in your Maven project.

  src/main/resources/project.properties

Or as follows if it is for tests only.

  src/test/resources/project.properties

Add this line inside the new file. Please note that you should not prefix with "properties" (e.g. don't write "properties.getdownload-webapp.version").

  version=${getdownload-webapp.version}

Note that you can also add flags like this to the file.

  debug=false

If not already done, you have to enable Maven filtering for your project. It is the feature that will look for placeholders inside the files of your project to be replaced by values from the pom. In order to proceed, you need add these lines inside the <build> tag of your pom.xml file. This is how to do with src/main:

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

And here is how to do for src/test:

<build>
    <testResources>
        <testResource>
            <directory>src/test/resources</directory>
            <filtering>true</filtering>
        </testResource>
    </testResources>
    ...

Finally, in your source code (MyClassName.java), add a block like

  Properties props = new Properties();
  props.load(MyClassName.class.getClassLoader().getResourceAsStream("project.properties"));
  String version = props.getProperty("version");

You can add as many variables as you want to the project.properties file and load each one using this method.

Upvotes: 7

Fritz Duchardt
Fritz Duchardt

Reputation: 11930

The mechanism chiefly in charge to transfer Maven properties to Java application is provided by the Maven Resource Plugin

The plugin is part of the Maven Super Pom and executed during the process-resources phase of the Jar Default Lifecyle. The only thing you have to do is to active filtering.

This will replace any placeholders, e.g. ${my.property} in any of the files in src/main/resources with the corresponding property from your pom, e.g. <property><my.property>test</my.property></property>

How you make this property then available to your Java application is up to you - reading it from the classpath would work.

Upvotes: 1

Bradley Smith
Bradley Smith

Reputation: 39

String version = project.getProperties().getProperty("getdownload-webapp.version");

Where project is of type MavenProject

Upvotes: -1

Nadir
Nadir

Reputation: 1379

I assume you want to get it in the code to check something right? You can use filtering from maven that will inject the value in the source code, similar to the filtering option http://mojo.codehaus.org/templating-maven-plugin/

Upvotes: 0

Related Questions