org.apache.ivy.core.settings

Class IvySettings

public class IvySettings extends Object implements SortEngineSettings, PublishEngineSettings, ParserSettings, DeliverEngineSettings, CheckEngineSettings, InstallEngineSettings, ResolverSettings, ResolveEngineSettings, RetrieveEngineSettings, RepositoryManagementEngineSettings

Constructor Summary
IvySettings()
IvySettings(IvyVariableContainer variableContainer)
Method Summary
voidaddAllVariables(Map variables)
voidaddAllVariables(Map variables, boolean overwrite)
voidaddClasspathURL(URL url)
voidaddConfigured(DependencyResolver resolver)
voidaddConfigured(ModuleDescriptorParser parser)
voidaddConfigured(ConflictManager cm)
voidaddConfigured(LatestStrategy latest)
voidaddConfigured(LockStrategy lockStrategy)
voidaddConfigured(Namespace ns)
voidaddConfigured(PatternMatcher m)
voidaddConfigured(RepositoryCacheManager c)
voidaddConfigured(ReportOutputter outputter)
voidaddConfigured(VersionMatcher vmatcher)
voidaddConfigured(CircularDependencyStrategy strategy)
voidaddConfigured(Trigger trigger)
voidaddConflictManager(String name, ConflictManager cm)
voidaddLatestStrategy(String name, LatestStrategy latest)
voidaddLockStrategy(String name, LockStrategy lockStrategy)
voidaddMatcher(PatternMatcher m)
voidaddModuleConfiguration(Map attributes, PatternMatcher matcher, String resolverName, String branch, String conflictManager, String resolveMode)
regular expressions as explained in Pattern class may be used in attributes
voidaddNamespace(Namespace ns)
voidaddReportOutputter(ReportOutputter outputter)
voidaddRepositoryCacheManager(RepositoryCacheManager c)
voidaddResolver(DependencyResolver resolver)
voidaddTrigger(Trigger trigger)
voidaddVersionMatcher(VersionMatcher vmatcher)
voidconfigureDefaultVersionMatcher()
voidconfigureRepositories(boolean remote)
Call this method to ask ivy to configure some variables using either a remote or a local properties file
booleandebugConflictResolution()
booleandebugLocking()
voiddefaultInit()
Default initialization of settings, useful when you don't want to load your settings from a settings file or URL, but prefer to set them manually.
booleandoValidate()
booleandumpMemoryUsage()
voidfilterIgnore(Collection names)
Filters the names list by removing all names that should be ignored as defined by the listing ignore list
FilegetBaseDir()
CircularDependencyStrategygetCircularDependencyStrategy()
CircularDependencyStrategygetCircularDependencyStrategy(String name)
ConflictManagergetConflictManager(ModuleId moduleId)
ConflictManagergetConflictManager(String name)
static URLgetDefault14SettingsURL()
StringgetDefaultBranch(ModuleId moduleId)
StringgetDefaultBranch()
FilegetDefaultCache()
StringgetDefaultCacheArtifactPattern()
StringgetDefaultCacheIvyPattern()
ConflictManagergetDefaultConflictManager()
FilegetDefaultIvyUserDir()
LatestStrategygetDefaultLatestStrategy()
LockStrategygetDefaultLockStrategy()
static URLgetDefaultPropertiesURL()
FilegetDefaultRepositoryCacheBasedir()
RepositoryCacheManagergetDefaultRepositoryCacheManager()
FilegetDefaultResolutionCacheBasedir()
StringgetDefaultResolveMode()
DependencyResolvergetDefaultResolver()
static URLgetDefaultSettingsURL()
String[]getIgnorableFilenames()
Returns the file names of the files that should be ignored when creating a file listing.
longgetInterruptTimeout()
LatestStrategygetLatestStrategy(String name)
LockStrategygetLockStrategy(String name)
PatternMatchergetMatcher(String name)
CollectiongetMatcherNames()
NamespacegetNamespace(String name)
RelativeUrlResolvergetRelativeUrlResolver()
ReportOutputtergetReportOutputter(String name)
ReportOutputter[]getReportOutputters()
RepositoryCacheManagergetRepositoryCacheManager(String name)
RepositoryCacheManager[]getRepositoryCacheManagers()
ResolutionCacheManagergetResolutionCacheManager()
StringgetResolveMode(ModuleId moduleId)
DependencyResolvergetResolver(ModuleRevisionId mrid)
DependencyResolvergetResolver(String resolverName)
StringgetResolverName(ModuleRevisionId mrid)
CollectiongetResolverNames()
CollectiongetResolvers()
StatusManagergetStatusManager()
NamespacegetSystemNamespace()
ListgetTriggers()
ClassgetTypeDef(String name)
MapgetTypeDefs()
StringgetVariable(String name)
IvyVariableContainergetVariableContainer()
IvyVariableContainergetVariables()
Returns the variables loaded in configuration file.
VersionMatchergetVersionMatcher(String name)
VersionMatchergetVersionMatcher()
VersionMatcher[]getVersionMatchers()
booleanisCheckUpToDate()
booleanisDefaultUseOrigin()
booleanisUseRemoteConfig()
voidload(File settingsFile)
voidload(URL settingsURL)
voidloadDefault()
voidloadDefault14()
voidloadProperties(URL url)
voidloadProperties(URL url, boolean overwrite)
voidloadProperties(File file)
voidloadProperties(File file, boolean overwrite)
booleanlogModulesInUse()
booleanlogModuleWhenFound()
booleanlogNotConvertedExclusionRule()
booleanlogResolvedRevision()
FileresolveFile(String fileName)
Return the canonical form of a filename.
voidsetBaseDir(File baseDir)
voidsetCheckUpToDate(boolean checkUpToDate)
voidsetCircularDependencyStrategy(CircularDependencyStrategy strategy)
voidsetDefaultBranch(String defaultBranch)
voidsetDefaultCache(File cacheDirectory)
voidsetDefaultCacheArtifactPattern(String defaultCacheArtifactPattern)
voidsetDefaultCacheIvyPattern(String defaultCacheIvyPattern)
voidsetDefaultConflictManager(ConflictManager defaultConflictManager)
voidsetDefaultIvyUserDir(File defaultUserDir)
voidsetDefaultLatestStrategy(LatestStrategy defaultLatestStrategy)
voidsetDefaultLockStrategy(LockStrategy defaultLockStrategy)
voidsetDefaultRepositoryCacheBasedir(String repositoryCacheRoot)
voidsetDefaultRepositoryCacheManager(RepositoryCacheManager cache)
voidsetDefaultResolutionCacheBasedir(String resolutionCacheRoot)
voidsetDefaultResolveMode(String defaultResolveMode)
voidsetDefaultResolver(String resolverName)
voidsetDefaultUseOrigin(boolean useOrigin)
voidsetDictatorResolver(DependencyResolver resolver)
voidsetLogNotConvertedExclusionRule(boolean logNotConvertedExclusionRule)
voidsetResolutionCacheManager(ResolutionCacheManager resolutionCacheManager)
voidsetSettingsVariables(File settingsFile)
voidsetSettingsVariables(URL settingsURL)
voidsetStatusManager(StatusManager statusManager)
voidsetUseRemoteConfig(boolean useRemoteConfig)
voidsetValidate(boolean validate)
voidsetVariable(String varName, String value)
voidsetVariable(String varName, String value, boolean overwrite)
voidsetVariableContainer(IvyVariableContainer variables)
Use a different variable container.
Stringsubstitute(String str)
Substitute variables in the given string by their value found in the current set of variables
Mapsubstitute(Map strings)
Substitute variables in the given map values by their value found in the current set of variables
ClasstypeDef(String name, String className)
ClasstypeDef(String name, String className, boolean silentFail)
voidtypeDefs(InputStream stream)
voidtypeDefs(InputStream stream, boolean silentFail)
voidtypeDefs(Properties p)
voidtypeDefs(Properties p, boolean silentFail)
voiduseDeprecatedUseOrigin()
voidvalidate()
Validates the settings, throwing an IllegalStateException if the current state is not valid.

Constructor Detail

IvySettings

public IvySettings()

IvySettings

public IvySettings(IvyVariableContainer variableContainer)

Method Detail

addAllVariables

public void addAllVariables(Map variables)

addAllVariables

public void addAllVariables(Map variables, boolean overwrite)

addClasspathURL

public void addClasspathURL(URL url)

addConfigured

public void addConfigured(DependencyResolver resolver)

addConfigured

public void addConfigured(ModuleDescriptorParser parser)

addConfigured

public void addConfigured(ConflictManager cm)

addConfigured

public void addConfigured(LatestStrategy latest)

addConfigured

public void addConfigured(LockStrategy lockStrategy)

addConfigured

public void addConfigured(Namespace ns)

addConfigured

public void addConfigured(PatternMatcher m)

addConfigured

public void addConfigured(RepositoryCacheManager c)

addConfigured

public void addConfigured(ReportOutputter outputter)

addConfigured

public void addConfigured(VersionMatcher vmatcher)

addConfigured

public void addConfigured(CircularDependencyStrategy strategy)

addConfigured

public void addConfigured(Trigger trigger)

addConflictManager

public void addConflictManager(String name, ConflictManager cm)

addLatestStrategy

public void addLatestStrategy(String name, LatestStrategy latest)

addLockStrategy

public void addLockStrategy(String name, LockStrategy lockStrategy)

addMatcher

public void addMatcher(PatternMatcher m)

addModuleConfiguration

public void addModuleConfiguration(Map attributes, PatternMatcher matcher, String resolverName, String branch, String conflictManager, String resolveMode)
regular expressions as explained in Pattern class may be used in attributes

addNamespace

public void addNamespace(Namespace ns)

addReportOutputter

public void addReportOutputter(ReportOutputter outputter)

addRepositoryCacheManager

public void addRepositoryCacheManager(RepositoryCacheManager c)

addResolver

public void addResolver(DependencyResolver resolver)

addTrigger

public void addTrigger(Trigger trigger)

addVersionMatcher

public void addVersionMatcher(VersionMatcher vmatcher)

configureDefaultVersionMatcher

public void configureDefaultVersionMatcher()

configureRepositories

public void configureRepositories(boolean remote)
Call this method to ask ivy to configure some variables using either a remote or a local properties file

debugConflictResolution

public boolean debugConflictResolution()

debugLocking

public final boolean debugLocking()

defaultInit

public void defaultInit()
Default initialization of settings, useful when you don't want to load your settings from a settings file or URL, but prefer to set them manually. By calling this method you will still have the basic initialization done when loading settings.

Throws: IOException

doValidate

public boolean doValidate()

dumpMemoryUsage

public boolean dumpMemoryUsage()

filterIgnore

public void filterIgnore(Collection names)
Filters the names list by removing all names that should be ignored as defined by the listing ignore list

Parameters: names

getBaseDir

public File getBaseDir()

getCircularDependencyStrategy

public CircularDependencyStrategy getCircularDependencyStrategy()

getCircularDependencyStrategy

public CircularDependencyStrategy getCircularDependencyStrategy(String name)

getConflictManager

public ConflictManager getConflictManager(ModuleId moduleId)

getConflictManager

public ConflictManager getConflictManager(String name)

getDefault14SettingsURL

public static URL getDefault14SettingsURL()

getDefaultBranch

public String getDefaultBranch(ModuleId moduleId)

getDefaultBranch

public String getDefaultBranch()

getDefaultCache

public File getDefaultCache()

getDefaultCacheArtifactPattern

public String getDefaultCacheArtifactPattern()

getDefaultCacheIvyPattern

public String getDefaultCacheIvyPattern()

getDefaultConflictManager

public ConflictManager getDefaultConflictManager()

getDefaultIvyUserDir

public File getDefaultIvyUserDir()

getDefaultLatestStrategy

public LatestStrategy getDefaultLatestStrategy()

getDefaultLockStrategy

public LockStrategy getDefaultLockStrategy()

getDefaultPropertiesURL

public static URL getDefaultPropertiesURL()

getDefaultRepositoryCacheBasedir

public File getDefaultRepositoryCacheBasedir()

getDefaultRepositoryCacheManager

public RepositoryCacheManager getDefaultRepositoryCacheManager()

getDefaultResolutionCacheBasedir

public File getDefaultResolutionCacheBasedir()

getDefaultResolveMode

public String getDefaultResolveMode()

getDefaultResolver

public DependencyResolver getDefaultResolver()

getDefaultSettingsURL

public static URL getDefaultSettingsURL()

getIgnorableFilenames

public String[] getIgnorableFilenames()
Returns the file names of the files that should be ignored when creating a file listing.

getInterruptTimeout

public long getInterruptTimeout()

getLatestStrategy

public LatestStrategy getLatestStrategy(String name)

getLockStrategy

public LockStrategy getLockStrategy(String name)

getMatcher

public PatternMatcher getMatcher(String name)

getMatcherNames

public Collection getMatcherNames()

getNamespace

public Namespace getNamespace(String name)

getRelativeUrlResolver

public RelativeUrlResolver getRelativeUrlResolver()

getReportOutputter

public ReportOutputter getReportOutputter(String name)

getReportOutputters

public ReportOutputter[] getReportOutputters()

getRepositoryCacheManager

public RepositoryCacheManager getRepositoryCacheManager(String name)

getRepositoryCacheManagers

public RepositoryCacheManager[] getRepositoryCacheManagers()

getResolutionCacheManager

public ResolutionCacheManager getResolutionCacheManager()

getResolveMode

public String getResolveMode(ModuleId moduleId)

getResolver

public DependencyResolver getResolver(ModuleRevisionId mrid)

getResolver

public DependencyResolver getResolver(String resolverName)

getResolverName

public String getResolverName(ModuleRevisionId mrid)

getResolverNames

public Collection getResolverNames()

getResolvers

public Collection getResolvers()

getStatusManager

public StatusManager getStatusManager()

getSystemNamespace

public Namespace getSystemNamespace()

getTriggers

public List getTriggers()

getTypeDef

public Class getTypeDef(String name)

getTypeDefs

public Map getTypeDefs()

getVariable

public String getVariable(String name)

getVariableContainer

public IvyVariableContainer getVariableContainer()

getVariables

public IvyVariableContainer getVariables()
Returns the variables loaded in configuration file. Those variables may better be seen as ant properties

Returns:

getVersionMatcher

public VersionMatcher getVersionMatcher(String name)

getVersionMatcher

public VersionMatcher getVersionMatcher()

getVersionMatchers

public VersionMatcher[] getVersionMatchers()

isCheckUpToDate

public boolean isCheckUpToDate()

isDefaultUseOrigin

public boolean isDefaultUseOrigin()

isUseRemoteConfig

public boolean isUseRemoteConfig()

load

public void load(File settingsFile)

load

public void load(URL settingsURL)

loadDefault

public void loadDefault()

loadDefault14

public void loadDefault14()

loadProperties

public void loadProperties(URL url)

loadProperties

public void loadProperties(URL url, boolean overwrite)

loadProperties

public void loadProperties(File file)

loadProperties

public void loadProperties(File file, boolean overwrite)

logModulesInUse

public boolean logModulesInUse()

logModuleWhenFound

public boolean logModuleWhenFound()

logNotConvertedExclusionRule

public boolean logNotConvertedExclusionRule()

logResolvedRevision

public boolean logResolvedRevision()

resolveFile

public File resolveFile(String fileName)
Return the canonical form of a filename.

If the specified file name is relative it is resolved with respect to the settings's base directory.

Parameters: fileName The name of the file to resolve. Must not be null.

Returns: the resolved File.

setBaseDir

public void setBaseDir(File baseDir)

setCheckUpToDate

public void setCheckUpToDate(boolean checkUpToDate)

setCircularDependencyStrategy

public void setCircularDependencyStrategy(CircularDependencyStrategy strategy)

setDefaultBranch

public void setDefaultBranch(String defaultBranch)

setDefaultCache

public void setDefaultCache(File cacheDirectory)

setDefaultCacheArtifactPattern

public void setDefaultCacheArtifactPattern(String defaultCacheArtifactPattern)

setDefaultCacheIvyPattern

public void setDefaultCacheIvyPattern(String defaultCacheIvyPattern)

setDefaultConflictManager

public void setDefaultConflictManager(ConflictManager defaultConflictManager)

setDefaultIvyUserDir

public void setDefaultIvyUserDir(File defaultUserDir)

setDefaultLatestStrategy

public void setDefaultLatestStrategy(LatestStrategy defaultLatestStrategy)

setDefaultLockStrategy

public void setDefaultLockStrategy(LockStrategy defaultLockStrategy)

setDefaultRepositoryCacheBasedir

public void setDefaultRepositoryCacheBasedir(String repositoryCacheRoot)

setDefaultRepositoryCacheManager

public void setDefaultRepositoryCacheManager(RepositoryCacheManager cache)

setDefaultResolutionCacheBasedir

public void setDefaultResolutionCacheBasedir(String resolutionCacheRoot)

setDefaultResolveMode

public void setDefaultResolveMode(String defaultResolveMode)

setDefaultResolver

public void setDefaultResolver(String resolverName)

setDefaultUseOrigin

public void setDefaultUseOrigin(boolean useOrigin)

setDictatorResolver

public void setDictatorResolver(DependencyResolver resolver)

setLogNotConvertedExclusionRule

public void setLogNotConvertedExclusionRule(boolean logNotConvertedExclusionRule)

setResolutionCacheManager

public void setResolutionCacheManager(ResolutionCacheManager resolutionCacheManager)

setSettingsVariables

public void setSettingsVariables(File settingsFile)

setSettingsVariables

public void setSettingsVariables(URL settingsURL)

setStatusManager

public void setStatusManager(StatusManager statusManager)

setUseRemoteConfig

public void setUseRemoteConfig(boolean useRemoteConfig)

setValidate

public void setValidate(boolean validate)

setVariable

public void setVariable(String varName, String value)

setVariable

public void setVariable(String varName, String value, boolean overwrite)

setVariableContainer

public void setVariableContainer(IvyVariableContainer variables)
Use a different variable container.

Parameters: variables

substitute

public String substitute(String str)
Substitute variables in the given string by their value found in the current set of variables

Parameters: str the string in which substitution should be made

Returns: the string where all current ivy variables have been substituted by their value If the input str doesn't use any variable, the same object is returned

substitute

public Map substitute(Map strings)
Substitute variables in the given map values by their value found in the current set of variables

Parameters: strings the map of strings in which substitution should be made

Returns: a new map of strings in which all current ivy variables in values have been substituted by their value

typeDef

public Class typeDef(String name, String className)

typeDef

public Class typeDef(String name, String className, boolean silentFail)

typeDefs

public void typeDefs(InputStream stream)

typeDefs

public void typeDefs(InputStream stream, boolean silentFail)

typeDefs

public void typeDefs(Properties p)

typeDefs

public void typeDefs(Properties p, boolean silentFail)

useDeprecatedUseOrigin

public void useDeprecatedUseOrigin()

validate

public void validate()
Validates the settings, throwing an IllegalStateException if the current state is not valid.

Throws: IllegalStateException if the settings is not valid.