Package org.apache.maven.settings
Class Settings
java.lang.Object
org.apache.maven.settings.TrackableBase
org.apache.maven.settings.Settings
- All Implemented Interfaces:
Serializable
Root element of the user configuration file.
- Version:
- $Revision$ $Date$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionField activeProfiles.private Proxy
private boolean
Whether Maven should attempt to interact with the user for input.private String
The local repository.Field mirrors.private String
Field modelEncoding.private boolean
Indicate whether maven should operate in offline mode full-time.Field pluginGroups.private Map
Field profiles.Field proxies.private RuntimeInfo
Field servers.private boolean
Whether Maven should use the plugin-registry.xml file to manage plugin versions.Fields inherited from class org.apache.maven.settings.TrackableBase
GLOBAL_LEVEL, USER_LEVEL
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addActiveProfile
(String string) Method addActiveProfile.void
Method addMirror.void
addPluginGroup
(String string) Method addPluginGroup.void
addProfile
(Profile profile) Method addProfile.void
Method addProxy.void
Method addServer.void
Reset theactiveProxy
field tonull
void
Reset theprofileMap
field tonull
Method getActiveProfiles.Get the local repository.getMirrorOf
(String repositoryId) Deprecated.Method getMirrors.Get the modelEncoding field.Method getPluginGroups.Method getProfiles.Method getProxies.Method getServers.boolean
Get whether Maven should attempt to interact with the user for input.boolean
Get indicate whether maven should operate in offline mode full-time.boolean
Get whether Maven should use the plugin-registry.xml file to manage plugin versions.void
removeActiveProfile
(String string) Method removeActiveProfile.void
removeMirror
(Mirror mirror) Method removeMirror.void
removePluginGroup
(String string) Method removePluginGroup.void
removeProfile
(Profile profile) Method removeProfile.void
removeProxy
(Proxy proxy) Method removeProxy.void
removeServer
(Server server) Method removeServer.void
setActiveProfiles
(List<String> activeProfiles) Set list of manually-activated build profiles, specified in the order in which they should be applied.void
setInteractiveMode
(boolean interactiveMode) Set whether Maven should attempt to interact with the user for input.void
setLocalRepository
(String localRepository) Set the local repository.void
setMirrors
(List<Mirror> mirrors) Set configuration of download mirrors for repositories.void
setModelEncoding
(String modelEncoding) Set the modelEncoding field.void
setOffline
(boolean offline) Set indicate whether maven should operate in offline mode full-time.void
setPluginGroups
(List<String> pluginGroups) Set list of groupIds to search for a plugin when that plugin groupId is not explicitly provided.void
setProfiles
(List<Profile> profiles) Set configuration of build profiles for adjusting the build according to environmental parameters.void
setProxies
(List<Proxy> proxies) Set configuration for different proxy profiles.void
setRuntimeInfo
(RuntimeInfo runtimeInfo) void
setServers
(List<Server> servers) Set configuration of server-specific settings, mainly authentication method.void
setUsePluginRegistry
(boolean usePluginRegistry) Set whether Maven should use the plugin-registry.xml file to manage plugin versions.Methods inherited from class org.apache.maven.settings.TrackableBase
getSourceLevel, setSourceLevel
-
Field Details
-
localRepository
The local repository. -
interactiveMode
private boolean interactiveModeWhether Maven should attempt to interact with the user for input. -
usePluginRegistry
private boolean usePluginRegistryWhether Maven should use the plugin-registry.xml file to manage plugin versions. -
offline
private boolean offlineIndicate whether maven should operate in offline mode full-time. -
proxies
Field proxies. -
servers
Field servers. -
mirrors
Field mirrors. -
profiles
Field profiles. -
activeProfiles
Field activeProfiles. -
pluginGroups
Field pluginGroups. -
modelEncoding
Field modelEncoding. -
activeProxy
-
profileMap
-
runtimeInfo
-
-
Constructor Details
-
Settings
public Settings()
-
-
Method Details
-
addActiveProfile
Method addActiveProfile.- Parameters:
string
-
-
addMirror
Method addMirror.- Parameters:
mirror
-
-
addPluginGroup
Method addPluginGroup.- Parameters:
string
-
-
addProfile
Method addProfile.- Parameters:
profile
-
-
addProxy
Method addProxy.- Parameters:
proxy
-
-
addServer
Method addServer.- Parameters:
server
-
-
getActiveProfiles
Method getActiveProfiles.- Returns:
- List
-
getLocalRepository
Get the local repository.- Returns:
- String
-
getMirrors
Method getMirrors.- Returns:
- List
-
getModelEncoding
Get the modelEncoding field.- Returns:
- String
-
getPluginGroups
Method getPluginGroups.- Returns:
- List
-
getProfiles
Method getProfiles.- Returns:
- List
-
getProxies
Method getProxies.- Returns:
- List
-
getServers
Method getServers.- Returns:
- List
-
isInteractiveMode
public boolean isInteractiveMode()Get whether Maven should attempt to interact with the user for input.- Returns:
- boolean
-
isOffline
public boolean isOffline()Get indicate whether maven should operate in offline mode full-time.- Returns:
- boolean
-
isUsePluginRegistry
public boolean isUsePluginRegistry()Get whether Maven should use the plugin-registry.xml file to manage plugin versions.- Returns:
- boolean
-
removeActiveProfile
Method removeActiveProfile.- Parameters:
string
-
-
removeMirror
Method removeMirror.- Parameters:
mirror
-
-
removePluginGroup
Method removePluginGroup.- Parameters:
string
-
-
removeProfile
Method removeProfile.- Parameters:
profile
-
-
removeProxy
Method removeProxy.- Parameters:
proxy
-
-
removeServer
Method removeServer.- Parameters:
server
-
-
setActiveProfiles
Set list of manually-activated build profiles, specified in the order in which they should be applied.- Parameters:
activeProfiles
-
-
setInteractiveMode
public void setInteractiveMode(boolean interactiveMode) Set whether Maven should attempt to interact with the user for input.- Parameters:
interactiveMode
-
-
setLocalRepository
Set the local repository.- Parameters:
localRepository
-
-
setMirrors
Set configuration of download mirrors for repositories.- Parameters:
mirrors
-
-
setModelEncoding
Set the modelEncoding field.- Parameters:
modelEncoding
-
-
setOffline
public void setOffline(boolean offline) Set indicate whether maven should operate in offline mode full-time.- Parameters:
offline
-
-
setPluginGroups
Set list of groupIds to search for a plugin when that plugin groupId is not explicitly provided.- Parameters:
pluginGroups
-
-
setProfiles
Set configuration of build profiles for adjusting the build according to environmental parameters.- Parameters:
profiles
-
-
setProxies
Set configuration for different proxy profiles. Multiple proxy profiles might come in handy for anyone working from a notebook or other mobile platform, to enable easy switching of entire proxy configurations by simply specifying the profile id, again either from the command line or from the defaults section below.- Parameters:
proxies
-
-
setServers
Set configuration of server-specific settings, mainly authentication method. This allows configuration of authentication on a per-server basis.- Parameters:
servers
-
-
setUsePluginRegistry
public void setUsePluginRegistry(boolean usePluginRegistry) Set whether Maven should use the plugin-registry.xml file to manage plugin versions.- Parameters:
usePluginRegistry
-
-
getInteractiveMode
-
flushActiveProxy
public void flushActiveProxy()Reset theactiveProxy
field tonull
-
getActiveProxy
- Returns:
- the first active proxy
-
getServer
-
getMirrorOf
Deprecated. -
flushProfileMap
public void flushProfileMap()Reset theprofileMap
field tonull
-
getProfilesAsMap
- Returns:
- a Map of profiles field with
Profile#getId()
as key - See Also:
-
setRuntimeInfo
-
getRuntimeInfo
-