Linux maven settings xml

Configuring Apache Maven

MAVEN_OPTS environment variable:

This variable contains parameters used to start up the JVM running Maven and can be used to supply additional options to it. E.g. JVM memory settings could be defined with the value -Xms256m -Xmx512m .

settings.xml file:

Located in USER_HOME/.m2 the settings files is designed to contain any configuration for Maven usage across projects.

.mvn directory:

Located within the project’s top level directory, the files maven.config , jvm.config , and extensions.xml contain project specific configuration for running Maven.

This directory is part of the project and may be checked in into your version control.

.mvn/extensions.xml file:

The old way (up to Maven 3.2.5) was to create a jar (must be shaded if you have other dependencies) which contains the extension and put it manually into the $/lib/ext directory. This means you had to change the Maven installation. The consequence was that everyone who likes to use this needed to change it’s installation and makes the on-boarding for a developer much more inconvenient. The other option was to give the path to the jar on command line via mvn -Dmaven.ext.class.path=extension.jar . This has the drawback giving those options to your Maven build every time you are calling Maven. Not very convenient as well.

From now on this can be done much more simpler and in a more Maven like way. So you can define an $/.mvn/extensions.xml file which looks like the following:

Now you can simply use an extension by defining the usual maven coordinates groupId, artifactId, version as any other artifact. Furthermore all transitive dependencies of those extensions will automatically being downloaded from your repository. So no need to create a shaded artifact anymore.

.mvn/maven.config file:

It’s really hard to define a general set of options for calling the maven command line. Starting with Maven 3.3.1+, this can be solved by putting this options to a script but this can now simple being done by defining $/.mvn/maven.config file which contains the configuration options for the mvn command line.

For example things like -T3 -U —fail-at-end . So you only have to call Maven just by using mvn clean package instead of mvn -T3 -U —fail-at-end clean package and not to miss the -T3 -U —fail-at-end options on every call. The $/.mvn/maven.config is located in the $/.mvn/ directory; also works if in the root of a multi module build.

.mvn/jvm.config file:

Starting with Maven 3.3.1+ you can define JVM configuration via $/.mvn/jvm.config file which means you can define the options for your build on a per project base. This file will become part of your project and will be checked in along with your project. So no need anymore for MAVEN_OPTS , .mavenrc files. So for example if you put the following JVM options into the $/.mvn/jvm.config file

You don’t need to use these options in MAVEN_OPTS or switch between different configurations.

Other guides

The following guides contain further information to specific configuration aspects:

Источник

Linux maven settings xml

Configuring Maven

Maven configuration occurs at 3 levels:

• Project — most static configuration occurs in pom.xml
• Installation — this is configuration added once for a Maven installation
• User — this is configuration specific to a particular user

The separation is quite clear — the project defines information that applies to the project, no matter who is building it, while the others both define settings for the current environment.

Note: the installation and user configuration cannot be used to add shared project information — for example, setting or company-wide.

For this, you should have your projects inherit from a company-wide parent pom.xml .

You can specify your user configuration in $/.m2/settings.xml . A full reference to the configuration file is available. This section will show how to make some common configurations. Note that the file is not required — defaults will be used if it is not found.

Configuring your Local Repository

The location of your local repository can be changed in your user configuration. The default value is $/.m2/repository/ .

Note: The local repository must be an absolute path.

Configuring a Proxy

Proxy configuration can also be specified in the settings file.

For more information, see the Guide to using a Proxy.

Configuring Parallel Artifact Resolution

By default, Maven 2.1.0+ will download up to 5 artifacts (from different groups) at once. To change the size of the thread pool, start Maven using -Dmaven.artifact.threads . For example, to only download single artifacts at a time:

You may wish to set this option permanently, in which case you can use the MAVEN_OPTS environment variable. For example:

Security and Deployment Settings

Repositories to deploy to are defined in a project in the section. However, you cannot put your username, password, or other security settings in that project. For that reason, you should add a server definition to your own settings with an id that matches that of the deployment repository in the project.

In addition, some repositories may require authorization to download from, so the corresponding settings can be specified in a server element in the same way.

Which settings are required will depend on the type of repository you are deploying to. As of the first release, only SCP deployments and file deployments are supported by default, so only the following SCP configuration is needed:

To encrypt passwords in these sections, refer to Encryption Settings.

Using Mirrors for Repositories

Repositories can be declared inside a project, which means that if you have your own custom repositories, those sharing your project easily get the right settings out of the box. However, you may want to use an alternative mirror for a particular repository without changing the project files. Refer to Guide to Mirror Settings for more details.

Profiles

Repository configuration can also be put into a profile. You can have multiple profiles, with one set to active so that you can easily switch environments. Read more about profiles in Introduction to Build Profiles.

Optional configuration

Maven will work for most tasks with the above configuration, however if you have any environmental specific configuration outside of individual projects then you will need to configure settings. The following sections refer to what is available.

Settings

Maven has a settings file located in the Maven installation and/or user home directory that configure environmental specifics such as:

• HTTP proxy server
• repository manager location
• server authentication and passwords
• other configuration properties

For information on this file, see the Settings reference

Security

As of Maven 2.1.0+, you can encrypt passwords in your settings file, however you must first configure a master password. For more information on both server passwords and the master password, see the Guide to Password Encryption.

Toolchains

As of Maven 2.0.9+, you can build a project using a specific version of JDK independent from the one Maven is running with. For more information, see the Guide to Using Toolchains.

Источник

Linux maven settings xml

The settings element in the settings.xml file contains elements used to define values which configure Maven execution in various ways, like the pom.xml , but should not be bundled to any specific project, or distributed to an audience. These include values such as the local repository location, alternate remote repository servers, and authentication information.

There are two locations where a settings.xml file may live:

• The Maven install: $/conf/settings.xml
• A user’s install: $/.m2/settings.xml

The former settings.xml are also called global settings, the latter settings.xml are referred to as user settings. If both files exists, their contents gets merged, with the user-specific settings.xml being dominant.

Tip: If you need to create user-specific settings from scratch, it’s easiest to copy the global settings from your Maven installation to your $/.m2 directory. Maven’s default settings.xml is a template with comments and examples so you can quickly tweak it to match your needs.

Here is an overview of the top elements under settings :

The contents of the settings.xml can be interpolated using the following expressions:

1. $ and all other system properties (since Maven 3.0)
2. $ etc. for environment variables

Note that properties defined in profiles within the settings.xml cannot be used for interpolation.

Settings Details

Simple Values

Half of the top-level settings elements are simple values, representing a range of values which describe elements of the build system that are active full-time.

• localRepository: This value is the path of this build system’s local repository. The default value is $/.m2/repository . This element is especially useful for a main build server allowing all logged-in users to build from a common local repository.
• interactiveMode: true if Maven should attempt to interact with the user for input, false if not. Defaults to true .
• offline: true if this build system should operate in offline mode, defaults to false . This element is useful for build servers which cannot connect to a remote repository, either because of network setup or security reasons.

Plugin Groups

This element contains a list of pluginGroup elements, each contains a groupId. The list is searched when a plugin is used and the groupId is not provided in the command line. This list automatically contains org.apache.maven.plugins and org.codehaus.mojo .

For example, given the above settings the Maven command line may execute org.eclipse.jetty:jetty-maven-plugin:run with the truncated command:

Servers

The repositories for download and deployment are defined by the repositories and distributionManagement elements of the POM. However, certain settings such as username and password should not be distributed along with the pom.xml . This type of information should exist on the build server in the settings.xml .

• id: This is the ID of the server (not of the user to login as) that matches the id element of the repository/mirror that Maven tries to connect to.
• username, password: These elements appear as a pair denoting the login and password required to authenticate to this server.
• privateKey, passphrase: Like the previous two elements, this pair specifies a path to a private key (default is $/.ssh/id_dsa ) and a passphrase , if required. The passphrase and password elements may be externalized in the future, but for now they must be set plain-text in the settings.xml file.
• filePermissions, directoryPermissions: When a repository file or directory is created on deployment, these are the permissions to use. The legal values of each is a three digit number corresponding to *nix file permissions, e.g. 664, or 775.

Note: If you use a private key to login to the server, make sure you omit the

element. Otherwise, the key will be ignored.

Password Encryption

A new feature — server password and passphrase encryption has been added to 2.1.0+. See details on this page

Mirrors

• id, name: The unique identifier and user-friendly name of this mirror. The id is used to differentiate between mirror elements and to pick the corresponding credentials from the section when connecting to the mirror.
• url: The base URL of this mirror. The build system will use this URL to connect to a repository rather than the original repository URL.
• mirrorOf: The id of the repository that this is a mirror of. For example, to point to a mirror of the Maven central repository ( https://repo.maven.apache.org/maven2/ ), set this element to central . More advanced mappings like repo1,repo2 or *,!inhouse are also possible. This must not match the mirror id .

For a more in-depth introduction of mirrors, please read the Guide to Mirror Settings.

Proxies

• id: The unique identifier for this proxy. This is used to differentiate between proxy elements.
• active: true if this proxy is active. This is useful for declaring a set of proxies, but only one may be active at a time.
• protocol, host, port: The protocol://host:port of the proxy, separated into discrete elements.
• username, password: These elements appear as a pair denoting the login and password required to authenticate to this proxy server.
• nonProxyHosts: This is a list of hosts which should not be proxied. The delimiter of the list is the expected type of the proxy server; the example above is pipe delimited — comma delimited is also common.

Profiles

The profile element in the settings.xml is a truncated version of the pom.xml profile element. It consists of the activation , repositories , pluginRepositories and properties elements. The profile elements only include these four elements because they concerns themselves with the build system as a whole (which is the role of the settings.xml file), not about individual project object model settings.

If a profile is active from settings , its values will override any equivalently ID’d profiles in a POM or profiles.xml file.

Activation

Activations are the key of a profile. Like the POM’s profiles, the power of a profile comes from its ability to modify some values only under certain circumstances; those circumstances are specified via an activation element.

Activation occurs when all specified criteria have been met, though not all are required at once.

• jdk: activation has a built in, Java-centric check in the jdk element. This will activate if the test is run under a jdk version number that matches the prefix given. In the above example, 1.5.0_06 will match. Ranges are also supported. See the maven-enforcer-plugin for more details about supported ranges.
• os: The os element can define some operating system specific properties shown above. See the maven-enforcer-plugin for more details about OS values.
• property: The profile will activate if Maven detects a property (a value which can be dereferenced within the POM by $ ) of the corresponding name=value pair.
• file: Finally, a given filename may activate the profile by the existence of a file, or if it is missing .

The activation element is not the only way that a profile may be activated. The settings.xml file’s activeProfile element may contain the profile’s id . They may also be activated explicitly through the command line via a comma separated list after the -P flag (e.g. -P test ).

To see which profile will activate in a certain build, use the maven-help-plugin .

Properties

Maven properties are value placeholder, like properties in Ant. Their values are accessible anywhere within a POM by using the notation $ , where X is the property. They come in five different styles, all accessible from the settings.xml file:

1. env.X : Prefixing a variable with “env.” will return the shell’s environment variable. For example, $ contains the $path environment variable ( %PATH% in Windows).
2. project.x : A dot (.) notated path in the POM will contain the corresponding element’s value. For example:

is accessible via $ .

settings.x : A dot (.) notated path in the settings.xml will contain the corresponding element’s value. For example: false is accessible via $ .

Java System Properties: All properties accessible via java.lang.System.getProperties() are available as POM properties, such as $ .

x : Set within a

element or an external files, the value may be used as $ .

The property $ is accessible from a POM if this profile is active.

Repositories

Repositories are remote collections of projects from which Maven uses to populate the local repository of the build system. It is from this local repository that Maven calls it plugins and dependencies. Different remote repositories may contain different projects, and under the active profile they may be searched for a matching release or snapshot artifact.

• releases, snapshots: These are the policies for each type of artifact, Release or snapshot. With these two sets, a POM has the power to alter the policies for each type independent of the other within a single repository. For example, one may decide to enable only snapshot downloads, possibly for development purposes.
• enabled: true or false for whether this repository is enabled for the respective type ( releases or snapshots ).
• updatePolicy: This element specifies how often updates should attempt to occur. Maven will compare the local POM’s timestamp (stored in a repository’s maven-metadata file) to the remote. The choices are: always , daily (default), interval:X (where X is an integer in minutes) or never .
• checksumPolicy: When Maven deploys files to the repository, it also deploys corresponding checksum files. Your options are to ignore , fail , or warn on missing or incorrect checksums.
• layout: In the above description of repositories, it was mentioned that they all follow a common layout. This is mostly correct. Maven 2 has a default layout for its repositories; however, Maven 1.x had a different layout. Use this element to specify which if it is default or legacy .

Plugin Repositories

Repositories are home to two major types of artifacts. The first are artifacts that are used as dependencies of other artifacts. These are the majority of artifacts that reside within central. The other type of artifact is plugins. Maven plugins are themselves a special type of artifact. Because of this, plugin repositories may be separated from other repositories (although, I have yet to hear a convincing argument for doing so). In any case, the structure of the pluginRepositories element block is similar to the repositories element. The pluginRepository elements each specify a remote location of where Maven can find new plugins.

Источник

Читайте также:  Windows aero extensions что это