Index (Maven Settings 3.9.1 API)

A C D E F G I M O P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

Activation - Class in org.apache.maven.settings: The conditions within the build runtime environment which will trigger the automatic inclusion of the parent build profile.
Activation() - Constructor for class org.apache.maven.settings.Activation
ActivationFile - Class in org.apache.maven.settings: This is the file specification used to activate a profile.
ActivationFile() - Constructor for class org.apache.maven.settings.ActivationFile
ActivationOS - Class in org.apache.maven.settings: This is an activator which will detect an operating system's attributes in order to activate its profile.
ActivationOS() - Constructor for class org.apache.maven.settings.ActivationOS
ActivationProperty - Class in org.apache.maven.settings: This is the property specification used to activate a profile.
ActivationProperty() - Constructor for class org.apache.maven.settings.ActivationProperty
addActiveProfile(String) - Method in class org.apache.maven.settings.Settings: Method addActiveProfile.
addMirror(Mirror) - Method in class org.apache.maven.settings.Settings: Method addMirror.
addPluginGroup(String) - Method in class org.apache.maven.settings.Settings: Method addPluginGroup.
addPluginRepository(Repository) - Method in class org.apache.maven.settings.Profile: Method addPluginRepository.
addProfile(Profile) - Method in class org.apache.maven.settings.Settings: Method addProfile.
addProperty(String, String) - Method in class org.apache.maven.settings.Profile: Method addProperty.
addProxy(Proxy) - Method in class org.apache.maven.settings.Settings: Method addProxy.
addRepository(Repository) - Method in class org.apache.maven.settings.Profile: Method addRepository.
addServer(Server) - Method in class org.apache.maven.settings.Settings: Method addServer.

C

clone() - Method in class org.apache.maven.settings.Activation: Method clone.
clone() - Method in class org.apache.maven.settings.ActivationFile: Method clone.
clone() - Method in class org.apache.maven.settings.ActivationOS: Method clone.
clone() - Method in class org.apache.maven.settings.ActivationProperty: Method clone.
clone() - Method in class org.apache.maven.settings.IdentifiableBase: Method clone.
clone() - Method in class org.apache.maven.settings.Mirror: Method clone.
clone() - Method in class org.apache.maven.settings.Profile: Method clone.
clone() - Method in class org.apache.maven.settings.Proxy: Method clone.
clone() - Method in class org.apache.maven.settings.Repository: Method clone.
clone() - Method in class org.apache.maven.settings.RepositoryBase: Method clone.
clone() - Method in class org.apache.maven.settings.RepositoryPolicy: Method clone.
clone() - Method in class org.apache.maven.settings.Server: Method clone.
clone() - Method in class org.apache.maven.settings.Settings: Method clone.
clone() - Method in class org.apache.maven.settings.TrackableBase: Method clone.
contentTransformer - Variable in class org.apache.maven.settings.io.xpp3.SettingsXpp3Reader: Field contentTransformer.

D

DEFAULT_USER_SETTINGS_FILE - Static variable in class org.apache.maven.settings.RuntimeInfo: Deprecated.

E

equals(Object) - Method in class org.apache.maven.settings.Repository
equals(Object) - Method in class org.apache.maven.settings.RepositoryBase

F

flushActiveProxy() - Method in class org.apache.maven.settings.Settings: Reset the activeProxy field to null
flushProfileMap() - Method in class org.apache.maven.settings.Settings: Reset the profileMap field to null

G

getActivation() - Method in class org.apache.maven.settings.Profile: Get the conditional logic which will automatically trigger the inclusion of this profile.
getActiveProfiles() - Method in class org.apache.maven.settings.Settings: Method getActiveProfiles.
getActiveProxy() - Method in class org.apache.maven.settings.Settings
getAddDefaultEntities() - Method in class org.apache.maven.settings.io.xpp3.SettingsXpp3Reader: Returns the state of the "add default entities" flag.
getArch() - Method in class org.apache.maven.settings.ActivationOS: Get the architecture of the OS to be used to activate a profile.
getChecksumPolicy() - Method in class org.apache.maven.settings.RepositoryPolicy: Get what to do when verification of an artifact checksum fails - warn, fail, etc.
getConfiguration() - Method in class org.apache.maven.settings.Server: Get extra configuration for the transport layer.
getDirectoryPermissions() - Method in class org.apache.maven.settings.Server: Get the permissions for directories when they are created.
getExists() - Method in class org.apache.maven.settings.ActivationFile: Get the name of the file that should exist to activate a profile.
getFamily() - Method in class org.apache.maven.settings.ActivationOS: Get the general family of the OS to be used to activate a profile (e.g.
getFile() - Method in class org.apache.maven.settings.Activation: Get specifies that this profile will be activated based on existence of a file.
getFile() - Method in class org.apache.maven.settings.RuntimeInfo: Deprecated.
getFilePermissions() - Method in class org.apache.maven.settings.Server: Get the permissions for files when they are created.
getHost() - Method in class org.apache.maven.settings.Proxy: Get the proxy host.
getId() - Method in class org.apache.maven.settings.IdentifiableBase: Get the id field.
getId() - Method in class org.apache.maven.settings.RepositoryBase: Get a unique identifier for a repository.
getInteractiveMode() - Method in class org.apache.maven.settings.Settings
getJdk() - Method in class org.apache.maven.settings.Activation: Get specifies that this profile will be activated when a matching JDK is detected.
getLayout() - Method in class org.apache.maven.settings.Mirror: Get the layout of the mirror repository.
getLayout() - Method in class org.apache.maven.settings.RepositoryBase: Get the type of layout this repository uses for locating and storing artifacts - can be "legacy" or "default".
getLocalRepository() - Method in class org.apache.maven.settings.Settings: Get the local repository.
Default value is: ${user.home}/.m2/repository
getMirrorOf() - Method in class org.apache.maven.settings.Mirror: Get the server ID of the repository being mirrored, e.g., "central".
getMirrorOf(String) - Method in class org.apache.maven.settings.Settings: Deprecated.
getMirrorOfLayouts() - Method in class org.apache.maven.settings.Mirror: Get the layouts of repositories being mirrored.
getMirrors() - Method in class org.apache.maven.settings.Settings: Method getMirrors.
getMissing() - Method in class org.apache.maven.settings.ActivationFile: Get the name of the file that should be missing to activate a profile.
getModelEncoding() - Method in class org.apache.maven.settings.Settings: Get the modelEncoding field.
getName() - Method in class org.apache.maven.settings.ActivationOS: Get the name of the OS to be used to activate a profile.
getName() - Method in class org.apache.maven.settings.ActivationProperty: Get the name of the property to be used to activate a profile.
getName() - Method in class org.apache.maven.settings.Mirror: Get the optional name that describes the mirror.
getName() - Method in class org.apache.maven.settings.RepositoryBase: Get human readable name of the repository.
getNonProxyHosts() - Method in class org.apache.maven.settings.Proxy: Get the list of non-proxied hosts (delimited by |).
getOs() - Method in class org.apache.maven.settings.Activation: Get specifies that this profile will be activated when matching OS attributes are detected.
getPassphrase() - Method in class org.apache.maven.settings.Server: Get the passphrase used in conjunction with the privateKey to authenticate.
getPassword() - Method in class org.apache.maven.settings.Proxy: Get the proxy password.
getPassword() - Method in class org.apache.maven.settings.Server: Get the password used in conjunction with the username to authenticate.
getPluginGroups() - Method in class org.apache.maven.settings.Settings: Method getPluginGroups.
getPluginRepositories() - Method in class org.apache.maven.settings.Profile: Method getPluginRepositories.
getPort() - Method in class org.apache.maven.settings.Proxy: Get the proxy port.
getPrivateKey() - Method in class org.apache.maven.settings.Server: Get the private key location used to authenticate.
getProfiles() - Method in class org.apache.maven.settings.Settings: Method getProfiles.
getProfilesAsMap() - Method in class org.apache.maven.settings.Settings
getProperties() - Method in class org.apache.maven.settings.Profile: Method getProperties.
getProperty() - Method in class org.apache.maven.settings.Activation: Get specifies that this profile will be activated when this property is specified.
getProtocol() - Method in class org.apache.maven.settings.Proxy: Get the proxy protocol.
getProxies() - Method in class org.apache.maven.settings.Settings: Method getProxies.
getReleases() - Method in class org.apache.maven.settings.Repository: Get how to handle downloading of releases from this repository.
getRepositories() - Method in class org.apache.maven.settings.Profile: Method getRepositories.
getServer(String) - Method in class org.apache.maven.settings.Settings
getServers() - Method in class org.apache.maven.settings.Settings: Method getServers.
getSnapshots() - Method in class org.apache.maven.settings.Repository: Get how to handle downloading of snapshots from this repository.
getSourceLevel() - Method in class org.apache.maven.settings.TrackableBase
getUpdatePolicy() - Method in class org.apache.maven.settings.RepositoryPolicy: Get the frequency for downloading updates - can be "always", "daily" (default), "interval:XXX" (in minutes) or "never" (only if it doesn't exist locally).
getUrl() - Method in class org.apache.maven.settings.Mirror: Get the URL of the mirror repository.
getUrl() - Method in class org.apache.maven.settings.RepositoryBase: Get the url of the repository.
getUsername() - Method in class org.apache.maven.settings.Proxy: Get the proxy user.
getUsername() - Method in class org.apache.maven.settings.Server: Get the username used to authenticate.
getValue() - Method in class org.apache.maven.settings.ActivationProperty: Get the value of the property to be used to activate a profile.
getVersion() - Method in class org.apache.maven.settings.ActivationOS: Get the version of the OS to be used to activate a profile.
GLOBAL_LEVEL - Static variable in class org.apache.maven.settings.TrackableBase

I

IdentifiableBase - Class in org.apache.maven.settings: Base class for Mirror, Profile, Proxy and Server.
IdentifiableBase() - Constructor for class org.apache.maven.settings.IdentifiableBase
isActive() - Method in class org.apache.maven.settings.Proxy: Get whether this proxy configuration is the active one.
isActiveByDefault() - Method in class org.apache.maven.settings.Activation: Get flag specifying whether this profile is active as a default.
isBlocked() - Method in class org.apache.maven.settings.Mirror: Get whether this mirror should be blocked from any download request but fail the download process, explaining why.
isEnabled() - Method in class org.apache.maven.settings.RepositoryPolicy: Get whether to use this repository for downloading this type of artifact.
isInteractiveMode() - Method in class org.apache.maven.settings.Settings: Get whether Maven should attempt to interact with the user for input.
isOffline() - Method in class org.apache.maven.settings.Settings: Get indicate whether maven should operate in offline mode full-time.
isUsePluginRegistry() - Method in class org.apache.maven.settings.Settings: Get whether Maven should use the plugin-registry.xml file to manage plugin versions.

M

Mirror - Class in org.apache.maven.settings: A download mirror for a given repository.
Mirror() - Constructor for class org.apache.maven.settings.Mirror

O

org.apache.maven.settings - package org.apache.maven.settings
org.apache.maven.settings.io.xpp3 - package org.apache.maven.settings.io.xpp3

P

Profile - Class in org.apache.maven.settings: Modifications to the build process which is keyed on some sort of environmental parameter.
Profile() - Constructor for class org.apache.maven.settings.Profile
Proxy - Class in org.apache.maven.settings: The <proxy> element contains informations required to a proxy settings.
Proxy() - Constructor for class org.apache.maven.settings.Proxy

R

read(InputStream) - Method in class org.apache.maven.settings.io.xpp3.SettingsXpp3Reader: Method read.
read(InputStream, boolean) - Method in class org.apache.maven.settings.io.xpp3.SettingsXpp3Reader: Method read.
read(Reader) - Method in class org.apache.maven.settings.io.xpp3.SettingsXpp3Reader
read(Reader, boolean) - Method in class org.apache.maven.settings.io.xpp3.SettingsXpp3Reader
removeActiveProfile(String) - Method in class org.apache.maven.settings.Settings: Method removeActiveProfile.
removeMirror(Mirror) - Method in class org.apache.maven.settings.Settings: Method removeMirror.
removePluginGroup(String) - Method in class org.apache.maven.settings.Settings: Method removePluginGroup.
removePluginRepository(Repository) - Method in class org.apache.maven.settings.Profile: Method removePluginRepository.
removeProfile(Profile) - Method in class org.apache.maven.settings.Settings: Method removeProfile.
removeProxy(Proxy) - Method in class org.apache.maven.settings.Settings: Method removeProxy.
removeRepository(Repository) - Method in class org.apache.maven.settings.Profile: Method removeRepository.
removeServer(Server) - Method in class org.apache.maven.settings.Settings: Method removeServer.
Repository - Class in org.apache.maven.settings: Repository contains the information needed for establishing connections with remote repository .
Repository() - Constructor for class org.apache.maven.settings.Repository
RepositoryBase - Class in org.apache.maven.settings: Repository contains the information needed for establishing connections with remote repository .
RepositoryBase() - Constructor for class org.apache.maven.settings.RepositoryBase
RepositoryPolicy - Class in org.apache.maven.settings: Download policy.
RepositoryPolicy() - Constructor for class org.apache.maven.settings.RepositoryPolicy
RuntimeInfo - Class in org.apache.maven.settings: Deprecated.
RuntimeInfo() - Constructor for class org.apache.maven.settings.RuntimeInfo: Deprecated.
RuntimeInfo(File) - Constructor for class org.apache.maven.settings.RuntimeInfo: Deprecated.

S

Server - Class in org.apache.maven.settings: The <server> element contains informations required to a server settings.
Server() - Constructor for class org.apache.maven.settings.Server
setActivation(Activation) - Method in class org.apache.maven.settings.Profile: Set the conditional logic which will automatically trigger the inclusion of this profile.
setActive(boolean) - Method in class org.apache.maven.settings.Proxy: Set whether this proxy configuration is the active one.
setActiveByDefault(boolean) - Method in class org.apache.maven.settings.Activation: Set flag specifying whether this profile is active as a default.
setActiveProfiles(List<String>) - Method in class org.apache.maven.settings.Settings: Set list of manually-activated build profiles, specified in the order in which they should be applied.
setAddDefaultEntities(boolean) - Method in class org.apache.maven.settings.io.xpp3.SettingsXpp3Reader: Sets the state of the "add default entities" flag.
setArch(String) - Method in class org.apache.maven.settings.ActivationOS: Set the architecture of the OS to be used to activate a profile.
setBlocked(boolean) - Method in class org.apache.maven.settings.Mirror: Set whether this mirror should be blocked from any download request but fail the download process, explaining why.
setChecksumPolicy(String) - Method in class org.apache.maven.settings.RepositoryPolicy: Set what to do when verification of an artifact checksum fails - warn, fail, etc.
setConfiguration(Object) - Method in class org.apache.maven.settings.Server: Set extra configuration for the transport layer.
setDirectoryPermissions(String) - Method in class org.apache.maven.settings.Server: Set the permissions for directories when they are created.
setEnabled(boolean) - Method in class org.apache.maven.settings.RepositoryPolicy: Set whether to use this repository for downloading this type of artifact.
setExists(String) - Method in class org.apache.maven.settings.ActivationFile: Set the name of the file that should exist to activate a profile.
setFamily(String) - Method in class org.apache.maven.settings.ActivationOS: Set the general family of the OS to be used to activate a profile (e.g.
setFile(ActivationFile) - Method in class org.apache.maven.settings.Activation: Set specifies that this profile will be activated based on existence of a file.
setFileComment(String) - Method in class org.apache.maven.settings.io.xpp3.SettingsXpp3Writer: Method setFileComment.
setFilePermissions(String) - Method in class org.apache.maven.settings.Server: Set the permissions for files when they are created.
setHost(String) - Method in class org.apache.maven.settings.Proxy: Set the proxy host.
setId(String) - Method in class org.apache.maven.settings.IdentifiableBase: Set the id field.
setId(String) - Method in class org.apache.maven.settings.RepositoryBase: Set a unique identifier for a repository.
setInteractiveMode(boolean) - Method in class org.apache.maven.settings.Settings: Set whether Maven should attempt to interact with the user for input.
setJdk(String) - Method in class org.apache.maven.settings.Activation: Set specifies that this profile will be activated when a matching JDK is detected.
setLayout(String) - Method in class org.apache.maven.settings.Mirror: Set the layout of the mirror repository.
setLayout(String) - Method in class org.apache.maven.settings.RepositoryBase: Set the type of layout this repository uses for locating and storing artifacts - can be "legacy" or "default".
setLocalRepository(String) - Method in class org.apache.maven.settings.Settings: Set the local repository.
Default value is: ${user.home}/.m2/repository
setMirrorOf(String) - Method in class org.apache.maven.settings.Mirror: Set the server ID of the repository being mirrored, e.g., "central".
setMirrorOfLayouts(String) - Method in class org.apache.maven.settings.Mirror: Set the layouts of repositories being mirrored.
setMirrors(List<Mirror>) - Method in class org.apache.maven.settings.Settings: Set configuration of download mirrors for repositories.
setMissing(String) - Method in class org.apache.maven.settings.ActivationFile: Set the name of the file that should be missing to activate a profile.
setModelEncoding(String) - Method in class org.apache.maven.settings.Settings: Set the modelEncoding field.
setName(String) - Method in class org.apache.maven.settings.ActivationOS: Set the name of the OS to be used to activate a profile.
setName(String) - Method in class org.apache.maven.settings.ActivationProperty: Set the name of the property to be used to activate a profile.
setName(String) - Method in class org.apache.maven.settings.Mirror: Set the optional name that describes the mirror.
setName(String) - Method in class org.apache.maven.settings.RepositoryBase: Set human readable name of the repository.
setNonProxyHosts(String) - Method in class org.apache.maven.settings.Proxy: Set the list of non-proxied hosts (delimited by |).
setOffline(boolean) - Method in class org.apache.maven.settings.Settings: Set indicate whether maven should operate in offline mode full-time.
setOs(ActivationOS) - Method in class org.apache.maven.settings.Activation: Set specifies that this profile will be activated when matching OS attributes are detected.
setPassphrase(String) - Method in class org.apache.maven.settings.Server: Set the passphrase used in conjunction with the privateKey to authenticate.
setPassword(String) - Method in class org.apache.maven.settings.Proxy: Set the proxy password.
setPassword(String) - Method in class org.apache.maven.settings.Server: Set the password used in conjunction with the username to authenticate.
setPluginGroups(List<String>) - Method in class org.apache.maven.settings.Settings: Set list of groupIds to search for a plugin when that plugin groupId is not explicitly provided.
setPluginRepositories(List<Repository>) - Method in class org.apache.maven.settings.Profile: Set the lists of the remote repositories for discovering plugins.
setPort(int) - Method in class org.apache.maven.settings.Proxy: Set the proxy port.
setPrivateKey(String) - Method in class org.apache.maven.settings.Server: Set the private key location used to authenticate.
setProfiles(List<Profile>) - Method in class org.apache.maven.settings.Settings: Set configuration of build profiles for adjusting the build according to environmental parameters.
setProperties(Properties) - Method in class org.apache.maven.settings.Profile: Set extended configuration specific to this profile goes here.
setProperty(ActivationProperty) - Method in class org.apache.maven.settings.Activation: Set specifies that this profile will be activated when this property is specified.
setProtocol(String) - Method in class org.apache.maven.settings.Proxy: Set the proxy protocol.
setProxies(List<Proxy>) - Method in class org.apache.maven.settings.Settings: Set configuration for different proxy profiles.
setReleases(RepositoryPolicy) - Method in class org.apache.maven.settings.Repository: Set how to handle downloading of releases from this repository.
setRepositories(List<Repository>) - Method in class org.apache.maven.settings.Profile: Set the lists of the remote repositories.
setServers(List<Server>) - Method in class org.apache.maven.settings.Settings: Set configuration of server-specific settings, mainly authentication method.
setSnapshots(RepositoryPolicy) - Method in class org.apache.maven.settings.Repository: Set how to handle downloading of snapshots from this repository.
setSourceLevel(String) - Method in class org.apache.maven.settings.TrackableBase
Settings - Class in org.apache.maven.settings: Root element of the user configuration file.
Settings() - Constructor for class org.apache.maven.settings.Settings
SettingsXpp3Reader - Class in org.apache.maven.settings.io.xpp3: Class SettingsXpp3Reader.
SettingsXpp3Reader() - Constructor for class org.apache.maven.settings.io.xpp3.SettingsXpp3Reader
SettingsXpp3Reader(SettingsXpp3Reader.ContentTransformer) - Constructor for class org.apache.maven.settings.io.xpp3.SettingsXpp3Reader
SettingsXpp3Reader.ContentTransformer - Interface in org.apache.maven.settings.io.xpp3
SettingsXpp3Writer - Class in org.apache.maven.settings.io.xpp3: Class SettingsXpp3Writer.
SettingsXpp3Writer() - Constructor for class org.apache.maven.settings.io.xpp3.SettingsXpp3Writer
setUpdatePolicy(String) - Method in class org.apache.maven.settings.RepositoryPolicy: Set the frequency for downloading updates - can be "always", "daily" (default), "interval:XXX" (in minutes) or "never" (only if it doesn't exist locally).
setUrl(String) - Method in class org.apache.maven.settings.Mirror: Set the URL of the mirror repository.
setUrl(String) - Method in class org.apache.maven.settings.RepositoryBase: Set the url of the repository.
setUsePluginRegistry(boolean) - Method in class org.apache.maven.settings.Settings: Set whether Maven should use the plugin-registry.xml file to manage plugin versions.
setUsername(String) - Method in class org.apache.maven.settings.Proxy: Set the proxy user.
setUsername(String) - Method in class org.apache.maven.settings.Server: Set the username used to authenticate.
setValue(String) - Method in class org.apache.maven.settings.ActivationProperty: Set the value of the property to be used to activate a profile.
setVersion(String) - Method in class org.apache.maven.settings.ActivationOS: Set the version of the OS to be used to activate a profile.

T

toString() - Method in class org.apache.maven.settings.Mirror
TrackableBase - Class in org.apache.maven.settings: common base class that contains code to track the source for this instance (USER|GLOBAL) .
TrackableBase() - Constructor for class org.apache.maven.settings.TrackableBase
transform(String, String) - Method in interface org.apache.maven.settings.io.xpp3.SettingsXpp3Reader.ContentTransformer: Interpolate the value read from the xpp3 document

U

USER_LEVEL - Static variable in class org.apache.maven.settings.TrackableBase
userHome - Static variable in class org.apache.maven.settings.RuntimeInfo: Deprecated.
userMavenConfigurationHome - Static variable in class org.apache.maven.settings.RuntimeInfo: Deprecated.

W

write(OutputStream, Settings) - Method in class org.apache.maven.settings.io.xpp3.SettingsXpp3Writer: Method write.
write(Writer, Settings) - Method in class org.apache.maven.settings.io.xpp3.SettingsXpp3Writer: Method write.

A C D E F G I M O P R S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form