Package org.ops4j.pax.url.mvn.internal.config

Class MavenConfigurationImpl

java.lang.Object

org.ops4j.pax.url.mvn.internal.config.MavenConfigurationImpl

All Implemented Interfaces:

MavenConfiguration

public class MavenConfigurationImpl
extends Object
implements MavenConfiguration

Service Configuration implementation.

Since:

August 11, 2007

Author:

Alin Dreghiciu, Guillaume Nodet

See Also:

MavenConfiguration

Constructor Summary

Constructors

Constructor	Description
MavenConfigurationImpl(org.ops4j.util.property.PropertyResolver propertyResolver, String pid)	Creates a new Maven configuration.

Method Summary

Modifier and Type	Method	Description
boolean	contains(String propertyName)	Returns true if the the property was set.
<T> T	get(String propertyName)	Returns the property by name.
boolean	getCertificateCheck()	Returns true if the certificate should be checked on SSL connection, false otherwise.
List<MavenRepositoryURL>	getDefaultRepositories()	Returns a list of default repositories to be searched before any other repositories.
String	getGlobalChecksumPolicy()	Global repository update policy.
String	getGlobalUpdatePolicy()	Global repository update policy.
MavenRepositoryURL	getLocalMavenRepositoryURL()	Returns the MavenRepositoryURL for Maven local repository.
File	getLocalRepository()	Returns local repository directory by using the following resolution: looks for a configuration property named localRepository looks for a framework property/system setting localRepository looks in settings.xml (see settings.xml resolution) looks for system property maven.repo.local (PAXURL-231) falls back to ${user.home}/.m2/repository Returns the directory for Maven local repository.
String	getPid()	Returns PID for properties used by this configuration.
<T> T	getProperty(String name, T defaultValue, Class<T> clazz)	Returns generic property by name and type.
org.ops4j.util.property.PropertyResolver	getPropertyResolver()	Returns a PropertyResolver backing up this configuration object.
List<MavenRepositoryURL>	getRepositories()	Returns a list of remote repositories to be searched.
File	getSecuritySettingsFile()	Returns the location of settings-security.xml file used.
org.apache.maven.settings.Settings	getSettings()	Returns Maven Settings object with decrypted values.
File	getSettingsFile()	Returns the location of settings.xml file used.
Integer	getTimeout()	Returns the generic connection/read timeout configured in case the maven artifact is retrieved from a remote location.
boolean	isOffline()	Whether DefaultRepositorySystemSession.setOffline(boolean) should be set to true.
boolean	isValid()	Should the configuration be used at all?
<T> T	set(String propertyName, T propertyValue)	Sets a property.
void	setSettings(org.apache.maven.settings.Settings settings)
boolean	useFallbackRepositories()	Returns true if Maven Central should be added as fallback repository in addition to other configured repositories.Default value is true.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MavenConfigurationImpl

public MavenConfigurationImpl(org.ops4j.util.property.PropertyResolver propertyResolver,
                              String pid)

Creates a new Maven configuration. Passed PropertyResolver is immediately used to determine location of settings.xml file and local repository (in such order, because settings may specify <localRepository> element).

Parameters:

propertyResolver - propertyResolver used to resolve properties; mandatory

pid - configuration PID. Set to "" if null.

Method Detail

getPid

public String getPid()

Description copied from interface: MavenConfiguration

Returns PID for properties used by this configuration. It's used as prefix for properties in associated PropertyResolver. Defaults to ServiceConstants.PID.

Specified by:

getPid in interface MavenConfiguration

Returns:

getPropertyResolver

public org.ops4j.util.property.PropertyResolver getPropertyResolver()

Description copied from interface: MavenConfiguration

Returns a PropertyResolver backing up this configuration object.

Specified by:

getPropertyResolver in interface MavenConfiguration

Returns:

isValid

public boolean isValid()

Should the configuration be used at all? If ServiceConstants.REQUIRE_CONFIG_ADMIN_CONFIG property is present, it is a hint that there should be new configuration (without this property) available soon from different source (in practice - when switchin from default, BundleContext based configuration to Configuration Admin based configuration (thus the name of the property).

Returns:

isOffline

public boolean isOffline()

Description copied from interface: MavenConfiguration

Whether DefaultRepositorySystemSession.setOffline(boolean) should be set to true.

Specified by:

isOffline in interface MavenConfiguration

Returns:

getSettingsFile

public File getSettingsFile()

Description copied from interface: MavenConfiguration

Returns the location of settings.xml file used. When null, no external settings are loaded.

Specified by:

getSettingsFile in interface MavenConfiguration

Returns:

getSecuritySettingsFile

public File getSecuritySettingsFile()

Description copied from interface: MavenConfiguration

Returns the location of settings-security.xml file used. When null, no external security settings are loaded.

Specified by:

getSecuritySettingsFile in interface MavenConfiguration

Returns:

getGlobalUpdatePolicy

public String getGlobalUpdatePolicy()

Description copied from interface: MavenConfiguration

Global repository update policy.

See ServiceConstants.PROPERTY_GLOBAL_UPDATE_POLICY

Specified by:

getGlobalUpdatePolicy in interface MavenConfiguration

Returns:

repository update policy or null if not set

getGlobalChecksumPolicy

public String getGlobalChecksumPolicy()

Description copied from interface: MavenConfiguration

Global repository update policy.

See ServiceConstants.PROPERTY_GLOBAL_CHECKSUM_POLICY

Specified by:

getGlobalChecksumPolicy in interface MavenConfiguration

Returns:

repository update policy or null if not set

getLocalRepository

public File getLocalRepository()

Returns local repository directory by using the following resolution:

1. looks for a configuration property named localRepository
2. looks for a framework property/system setting localRepository
3. looks in settings.xml (see settings.xml resolution)
4. looks for system property maven.repo.local (PAXURL-231)
5. falls back to ${user.home}/.m2/repository

Returns the directory for Maven local repository. Checks context propert/PID, settings.xml, maven.repo.local system property and falls back to ~/.m2/repository. Local repository must be specified in order to resolve remote artifacts.

Specified by:

getLocalRepository in interface MavenConfiguration

Returns:

getLocalMavenRepositoryURL

public MavenRepositoryURL getLocalMavenRepositoryURL()

Description copied from interface: MavenConfiguration

Returns the MavenRepositoryURL for Maven local repository. This is the way to get more information about the repository (for example if is it split).

Specified by:

getLocalMavenRepositoryURL in interface MavenConfiguration

Returns:

useFallbackRepositories

public boolean useFallbackRepositories()

Description copied from interface: MavenConfiguration

Returns true if Maven Central should be added as fallback repository in addition to other configured repositories.Default value is true.

Specified by:

useFallbackRepositories in interface MavenConfiguration

Returns:

true if the fallback repositories should be used

getTimeout

public Integer getTimeout()

Description copied from interface: MavenConfiguration

Returns the generic connection/read timeout configured in case the maven artifact is retrieved from a remote location. We can configure the timeouts separately using external settings.xml as well as dedicated properties like ServiceConstants.PROPERTY_SOCKET_CONNECTION_TIMEOUT.

Specified by:

getTimeout in interface MavenConfiguration

Returns:

the timeout in case artifacts are retrieved from a remote location

getCertificateCheck

public boolean getCertificateCheck()

Description copied from interface: MavenConfiguration

Returns true if the certificate should be checked on SSL connection, false otherwise.

Specified by:

getCertificateCheck in interface MavenConfiguration

Returns:

true if the certificate should be checked

getDefaultRepositories

public List<MavenRepositoryURL> getDefaultRepositories()
                                                throws MalformedURLException

Description copied from interface: MavenConfiguration

Returns a list of default repositories to be searched before any other repositories. These should be file: based repositories. For example Karaf's system/ directory should be configured as default repository.

Specified by:

getDefaultRepositories in interface MavenConfiguration

Returns:

a list of default repositories. List can be null or empty if there are not default repositories to be searched.

Throws:

MalformedURLException

getRepositories

public List<MavenRepositoryURL> getRepositories()
                                         throws MalformedURLException

Description copied from interface: MavenConfiguration

Returns a list of remote repositories to be searched. When resolving artifacts from remote repositories, locally cached version is always created in configured local repository. These repositories may be file: based, but usually external http(s): repositories are used.

Specified by:

getRepositories in interface MavenConfiguration

Returns:

a list of remote repositories. List can be null or empty if there are no repositories to be searched.

Throws:

MalformedURLException

getSettings

public org.apache.maven.settings.Settings getSettings()

Description copied from interface: MavenConfiguration

Returns Maven Settings object with decrypted values.

Specified by:

getSettings in interface MavenConfiguration

Returns:

setSettings

public void setSettings(org.apache.maven.settings.Settings settings)

getProperty

public <T> T getProperty(String name,
                         T defaultValue,
                         Class<T> clazz)

Description copied from interface: MavenConfiguration

Returns generic property by name and type.

Specified by:

getProperty in interface MavenConfiguration

Returns:

contains

public boolean contains(String propertyName)

Returns true if the the property was set.

Parameters:

propertyName - name of the property

Returns:

true if property is set

set

public <T> T set(String propertyName,
                 T propertyValue)

Sets a property.

Parameters:

propertyName - name of the property to set

propertyValue - value of the property to set

Returns:

the value of property set (fluent api)

get

public <T> T get(String propertyName)

Returns the property by name.

Parameters:

propertyName - name of the property

Returns:

property value