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(URL url)
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.
MavenRepositoryURL	getLocalRepository() Returns the url of local repository.
Map<String,Map<String,String>>	getMirrors() Returns the mirror settings from settings.xml.
Map<String,Map<String,String>>	getProxySettings(String... protocols) Returns the active proxy settings from settings.xml The fields are user, pass, host, port, nonProxyHosts, protocol.
List<MavenRepositoryURL>	getRepositories() Returns a list of repositories to be searched.
URL	getSettingsFileUrl() Returns the URL of maven settings file.
Integer	getTimeout() Returns the timeout configured in case the maven artifact is retrieved from a remote location.
Boolean	useFallbackRepositories() Returns true if the fallback repositories should be used instead of default ones.

Method Detail

getCertificateCheck

Boolean getCertificateCheck()

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

Returns:

true if the certificate should be checked

getSettingsFileUrl

URL getSettingsFileUrl()

Returns the URL of maven settings file.

Returns:

the url to settings file

getDefaultRepositories

List<MavenRepositoryURL> getDefaultRepositories()
                                                throws 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:

MalformedURLException

getRepositories

List<MavenRepositoryURL> getRepositories()
                                         throws 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:

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

Boolean useFallbackRepositories()

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

Returns:

true if the fallback repositories should be used

getTimeout

Integer getTimeout()

Returns the timeout configured in case the maven artifact is retrieved from a remote location.

Returns:

the timeout in case artifacts are retrieved from a remote location

enableProxy

void enableProxy(URL url)

Parameters:

url - Enables the proxy server for a given URL.

getProxySettings

Map<String,Map<String,String>> getProxySettings(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

Map<String,Map<String,String>> getMirrors()

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

Returns:

the mirror settings