org.ops4j.pax.url.maven.commons
Interface MavenConfiguration

All Known Implementing Classes:

MavenConfigurationImpl

public interface MavenConfiguration

Handler configuration.

Since:

August 11, 2007

Author:

Alin Dreghiciu

Method Summary

void	enableProxy(java.net.URL url)
java.lang.Boolean	getCertificateCheck() Returns true if the certificate should be checked on SSL connection, false otherwise.
java.util.List<MavenRepositoryURL>	getDefaultRepositories() Returns a list of default repositories to be searched before any other repositories.
MavenRepositoryURL	getLocalRepository() Returns the url of local repository.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getMirrors() Returns the mirror settings from settings.xml.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getProxySettings(java.lang.String... protocols) Returns the active proxy settings from settings.xml The fields are user, pass, host, port, nonProxyHosts, protocol.
java.util.List<MavenRepositoryURL>	getRepositories() Returns a list of repositories to be searched.
java.net.URL	getSettingsFileUrl() Returns the URL of maven settings file.
java.lang.Boolean	useFallbackRepositories() Returns true if the fallback repositories should be used instead of default ones.

Method Detail

getCertificateCheck

java.lang.Boolean getCertificateCheck()

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

Returns:

true if the certificate should be checked

getSettingsFileUrl

java.net.URL getSettingsFileUrl()

Returns the URL of maven settings file.

Returns:

the url to settings file

getDefaultRepositories

java.util.List<MavenRepositoryURL> getDefaultRepositories()
                                                          throws java.net.MalformedURLException

Returns a list of default repositories to be searched before any other repositories.

Returns:

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

Throws:

java.net.MalformedURLException

getRepositories

java.util.List<MavenRepositoryURL> getRepositories()
                                                   throws java.net.MalformedURLException

Returns a list of repositories to be searched.

Returns:

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

Throws:

java.net.MalformedURLException

getLocalRepository

MavenRepositoryURL getLocalRepository()

Returns the url of local repository.

Returns:

url of local repository. Can be null if there is no local repository.

useFallbackRepositories

java.lang.Boolean useFallbackRepositories()

Returns true if the fallback repositories should be used instead of default ones. Default value is false.

Returns:

true if the fallback repositories should

enableProxy

void enableProxy(java.net.URL url)

Parameters:

url - Enables the proxy server for a given URL.

getProxySettings

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getProxySettings(java.lang.String... protocols)

Returns the active proxy settings from settings.xml The fields are user, pass, host, port, nonProxyHosts, protocol.

Parameters:

protocols - protocols to be recognized.

Returns:

the active proxy settings

getMirrors

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getMirrors()

Returns the mirror settings from settings.xml. The fields are id, url, mirrorOf, layout, mirrorOfLayouts.

Returns:

the mirror settings