org.mule.maven.client.api.model

Interface MavenConfiguration

@NoImplement
public interface MavenConfiguration

Configuration settings for a MavenClient.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MavenConfiguration.MavenConfigurationBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getForcePolicyUpdateNever()
Optional<File>	getGlobalSettingsLocation()
boolean	getIgnoreArtifactDescriptorRepositories()
File	getLocalMavenRepositoryLocation()
List<RemoteRepository>	getMavenRemoteRepositories()
boolean	getOfflineMode()
Optional<File>	getSettingsSecurityLocation()
Optional<File>	getUserSettingsLocation()
static MavenConfiguration.MavenConfigurationBuilder	newMavenConfigurationBuilder()

Method Detail

getLocalMavenRepositoryLocation

File getLocalMavenRepositoryLocation()

Returns:

File with the location of the local maven repository. It has precedence over the Maven settings localRepository.

getMavenRemoteRepositories

List<RemoteRepository> getMavenRemoteRepositories()

Returns:

a list of remote repository to lookup for artifacts. May be empty. It has precedence over the Maven settings remoteRepositories. If a remote repository is defined within authentication the authentication credentials from this remote repository will be considered and ignored the ones (if any) on Maven settings file.

On the other hand if the remote repository does not define authentication credentials and Maven settings has a server entry with authentication for the same repository id, the one from settings file will be considered.

If a Maven settings file is defined with proxies and mirrors for repositories those will also be applied to the remote repositories declared here. This will allow to use proxy even with default repositories declared programatically.

getUserSettingsLocation

Optional<File> getUserSettingsLocation()

Returns:

the user settings.xml file location. Any server settings defined on settings will override the authentication defined for an explicit remote repository declared as {getMavenRemoteRepositories()}.

getGlobalSettingsLocation

Optional<File> getGlobalSettingsLocation()

Returns:

the global settings.xml file location. Any server settings defined on settings will override the authentication defined for an explicit remote repository declared as {getMavenRemoteRepositories()}.

getSettingsSecurityLocation

Optional<File> getSettingsSecurityLocation()

Returns:

the global secure-settings.xml file location to decrypt the password for severs defined on settings.xml.

getForcePolicyUpdateNever

boolean getForcePolicyUpdateNever()

Returns:

true if for all the repositories, the update policy for artifact should be to never update and checksum policy ignored for SNAPSHOT artifacts and failure for released artifacts. If not, default from Maven will be set UPDATE_POLICY_DAILY, CHECKSUM_POLICY_WARN for all the artifacts.

getIgnoreArtifactDescriptorRepositories

boolean getIgnoreArtifactDescriptorRepositories()

Returns:

true to ignore additional repositories from artifact descriptors, false to merge those with the originally specified remote repositories. Default value is true.

getOfflineMode

boolean getOfflineMode()

Returns:

true if resolution should work in off line mode, meaning that no remote repositories would be accessed and only local repository.

newMavenConfigurationBuilder

static MavenConfiguration.MavenConfigurationBuilder newMavenConfigurationBuilder()

Returns:

a MavenConfiguration.MavenConfigurationBuilder to build a MavenConfiguration.