Class Settings

java.lang.Object
org.apache.maven.settings.TrackableBase
org.apache.maven.settings.Settings
All Implemented Interfaces:
Serializable

public class Settings extends TrackableBase implements Serializable
Root element of the user configuration file.
Version:
$Revision$ $Date$
See Also:
  • Field Details

    • localRepository

      private String localRepository
      The local repository.
    • interactiveMode

      private boolean interactiveMode
      Whether Maven should attempt to interact with the user for input.
    • usePluginRegistry

      private boolean usePluginRegistry
      Whether Maven should use the plugin-registry.xml file to manage plugin versions.
    • offline

      private boolean offline
      Indicate whether maven should operate in offline mode full-time.
    • proxies

      private List<Proxy> proxies
      Field proxies.
    • servers

      private List<Server> servers
      Field servers.
    • mirrors

      private List<Mirror> mirrors
      Field mirrors.
    • profiles

      private List<Profile> profiles
      Field profiles.
    • activeProfiles

      private List<String> activeProfiles
      Field activeProfiles.
    • pluginGroups

      private List<String> pluginGroups
      Field pluginGroups.
    • modelEncoding

      private String modelEncoding
      Field modelEncoding.
    • activeProxy

      private Proxy activeProxy
    • profileMap

      private Map profileMap
    • runtimeInfo

      private RuntimeInfo runtimeInfo
  • Constructor Details

    • Settings

      public Settings()
  • Method Details

    • addActiveProfile

      public void addActiveProfile(String string)
      Method addActiveProfile.
      Parameters:
      string -
    • addMirror

      public void addMirror(Mirror mirror)
      Method addMirror.
      Parameters:
      mirror -
    • addPluginGroup

      public void addPluginGroup(String string)
      Method addPluginGroup.
      Parameters:
      string -
    • addProfile

      public void addProfile(Profile profile)
      Method addProfile.
      Parameters:
      profile -
    • addProxy

      public void addProxy(Proxy proxy)
      Method addProxy.
      Parameters:
      proxy -
    • addServer

      public void addServer(Server server)
      Method addServer.
      Parameters:
      server -
    • getActiveProfiles

      public List<String> getActiveProfiles()
      Method getActiveProfiles.
      Returns:
      List
    • getLocalRepository

      public String getLocalRepository()
      Get the local repository.
      Returns:
      String
    • getMirrors

      public List<Mirror> getMirrors()
      Method getMirrors.
      Returns:
      List
    • getModelEncoding

      public String getModelEncoding()
      Get the modelEncoding field.
      Returns:
      String
    • getPluginGroups

      public List<String> getPluginGroups()
      Method getPluginGroups.
      Returns:
      List
    • getProfiles

      public List<Profile> getProfiles()
      Method getProfiles.
      Returns:
      List
    • getProxies

      public List<Proxy> getProxies()
      Method getProxies.
      Returns:
      List
    • getServers

      public List<Server> 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

      public void removeActiveProfile(String string)
      Method removeActiveProfile.
      Parameters:
      string -
    • removeMirror

      public void removeMirror(Mirror mirror)
      Method removeMirror.
      Parameters:
      mirror -
    • removePluginGroup

      public void removePluginGroup(String string)
      Method removePluginGroup.
      Parameters:
      string -
    • removeProfile

      public void removeProfile(Profile profile)
      Method removeProfile.
      Parameters:
      profile -
    • removeProxy

      public void removeProxy(Proxy proxy)
      Method removeProxy.
      Parameters:
      proxy -
    • removeServer

      public void removeServer(Server server)
      Method removeServer.
      Parameters:
      server -
    • setActiveProfiles

      public void setActiveProfiles(List<String> activeProfiles)
      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

      public void setLocalRepository(String localRepository)
      Set the local repository.
      Parameters:
      localRepository -
    • setMirrors

      public void setMirrors(List<Mirror> mirrors)
      Set configuration of download mirrors for repositories.
      Parameters:
      mirrors -
    • setModelEncoding

      public void setModelEncoding(String modelEncoding)
      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

      public void setPluginGroups(List<String> pluginGroups)
      Set list of groupIds to search for a plugin when that plugin groupId is not explicitly provided.
      Parameters:
      pluginGroups -
    • setProfiles

      public void setProfiles(List<Profile> profiles)
      Set configuration of build profiles for adjusting the build according to environmental parameters.
      Parameters:
      profiles -
    • setProxies

      public void setProxies(List<Proxy> proxies)
      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

      public void setServers(List<Server> servers)
      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

      public Boolean getInteractiveMode()
    • flushActiveProxy

      public void flushActiveProxy()
      Reset the activeProxy field to null
    • getActiveProxy

      public Proxy getActiveProxy()
      Returns:
      the first active proxy
    • getServer

      public Server getServer(String serverId)
    • getMirrorOf

      @Deprecated public Mirror getMirrorOf(String repositoryId)
      Deprecated.
    • flushProfileMap

      public void flushProfileMap()
      Reset the profileMap field to null
    • getProfilesAsMap

      public Map getProfilesAsMap()
      Returns:
      a Map of profiles field with Profile#getId() as key
      See Also:
    • setRuntimeInfo

      public void setRuntimeInfo(RuntimeInfo runtimeInfo)
    • getRuntimeInfo

      public RuntimeInfo getRuntimeInfo()