org.apache.ivy.core.settings
Class IvySettings

java.lang.Object
  extended by org.apache.ivy.core.settings.IvySettings
All Implemented Interfaces:
CacheSettings, CheckEngineSettings, DeliverEngineSettings, InstallEngineSettings, PublishEngineSettings, ResolveEngineSettings, RetrieveEngineSettings, SortEngineSettings, ParserSettings, ResolverSettings

public class IvySettings
extends java.lang.Object
implements SortEngineSettings, PublishEngineSettings, ParserSettings, DeliverEngineSettings, CacheSettings, CheckEngineSettings, InstallEngineSettings, ResolverSettings, ResolveEngineSettings, RetrieveEngineSettings


Constructor Summary
IvySettings()
           
IvySettings(IvyVariableContainer variableContainer)
           
 
Method Summary
 void addAllVariables(java.util.Map variables)
           
 void addAllVariables(java.util.Map variables, boolean overwrite)
           
 void addClasspathURL(java.net.URL url)
           
 void addConfigured(CircularDependencyStrategy strategy)
           
 void addConfigured(ConflictManager cm)
           
 void addConfigured(DependencyResolver resolver)
           
 void addConfigured(LatestStrategy latest)
           
 void addConfigured(LockStrategy lockStrategy)
           
 void addConfigured(ModuleDescriptorParser parser)
           
 void addConfigured(Namespace ns)
           
 void addConfigured(PatternMatcher m)
           
 void addConfigured(ReportOutputter outputter)
           
 void addConfigured(Trigger trigger)
           
 void addConfigured(VersionMatcher vmatcher)
           
 void addConflictManager(java.lang.String name, ConflictManager cm)
           
 void addLatestStrategy(java.lang.String name, LatestStrategy latest)
           
 void addLockStrategy(java.lang.String name, LockStrategy lockStrategy)
           
 void addMatcher(PatternMatcher m)
           
 void addModuleConfiguration(ModuleId mid, PatternMatcher matcher, java.lang.String resolverName, java.lang.String branch, java.lang.String conflictManager)
          regular expressions as explained in Pattern class may be used in ModuleId organisation and name
 void addNamespace(Namespace ns)
           
 void addReportOutputter(ReportOutputter outputter)
           
 void addResolver(DependencyResolver resolver)
           
 void addTrigger(Trigger trigger)
           
 void addVersionMatcher(VersionMatcher vmatcher)
           
 void configureDefaultVersionMatcher()
           
 void configureRepositories(boolean remote)
          Call this method to ask ivy to configure some variables using either a remote or a local properties file
 boolean debugConflictResolution()
           
 boolean debugLocking()
           
 boolean doValidate()
           
 void filterIgnore(java.util.Collection names)
          Filters the names list by removing all names that should be ignored as defined by the listing ignore list
 java.lang.String getCacheArtifactPattern()
           
 java.lang.String getCacheDataFilePattern()
           
 java.lang.String getCacheIvyPattern()
           
 java.lang.String getCacheResolvedIvyPattern()
           
 java.lang.String getCacheResolvedIvyPropertiesPattern()
           
 CircularDependencyStrategy getCircularDependencyStrategy()
           
 CircularDependencyStrategy getCircularDependencyStrategy(java.lang.String name)
           
 ConflictManager getConflictManager(ModuleId moduleId)
           
 ConflictManager getConflictManager(java.lang.String name)
           
static java.net.URL getDefault14SettingsURL()
           
 java.lang.String getDefaultBranch()
           
 java.lang.String getDefaultBranch(ModuleId moduleId)
           
 java.io.File getDefaultCache()
           
 ConflictManager getDefaultConflictManager()
           
 java.io.File getDefaultIvyUserDir()
           
 LatestStrategy getDefaultLatestStrategy()
           
 LockStrategy getDefaultLockStrategy()
           
static java.net.URL getDefaultPropertiesURL()
           
 DependencyResolver getDefaultResolver()
           
static java.net.URL getDefaultSettingsURL()
           
 long getInterruptTimeout()
           
 LatestStrategy getLatestStrategy(java.lang.String name)
           
 LockStrategy getLockStrategy(java.lang.String name)
           
 PatternMatcher getMatcher(java.lang.String name)
           
 java.util.Collection getMatcherNames()
           
 Namespace getNamespace(java.lang.String name)
           
 RelativeUrlResolver getRelativeUrlResolver()
           
 ReportOutputter getReportOutputter(java.lang.String name)
           
 ReportOutputter[] getReportOutputters()
           
 java.io.File getRepositoryCacheRoot(java.io.File cache)
           
 java.io.File getResolutionCacheRoot(java.io.File cache)
           
 DependencyResolver getResolver(ModuleId moduleId)
           
 DependencyResolver getResolver(java.lang.String resolverName)
           
 java.lang.String getResolverName(ModuleId moduleId)
           
 java.util.Collection getResolverNames()
           
 java.util.Collection getResolvers()
           
 StatusManager getStatusManager()
           
 Namespace getSystemNamespace()
           
 java.util.List getTriggers()
           
 java.lang.Class getTypeDef(java.lang.String name)
           
 java.util.Map getTypeDefs()
           
 java.lang.String getVariable(java.lang.String name)
           
 IvyVariableContainer getVariableContainer()
           
 java.util.Map getVariables()
          Returns the variables loaded in configuration file.
 VersionMatcher getVersionMatcher()
           
 VersionMatcher getVersionMatcher(java.lang.String name)
           
 VersionMatcher[] getVersionMatchers()
           
 boolean isCheckUpToDate()
           
 boolean isUseRemoteConfig()
           
 boolean listingIgnore(java.lang.String name)
          Returns true if the name should be ignored in listing
 void load(java.io.File settingsFile)
           
 void load(java.net.URL settingsURL)
           
 void loadDefault()
           
 void loadDefault14()
           
 void loadProperties(java.io.File file)
           
 void loadProperties(java.io.File file, boolean overwrite)
           
 void loadProperties(java.net.URL url)
           
 void loadProperties(java.net.URL url, boolean overwrite)
           
 boolean logModulesInUse()
           
 boolean logModuleWhenFound()
           
 boolean logNotConvertedExclusionRule()
           
 boolean logResolvedRevision()
           
 void setCacheArtifactPattern(java.lang.String cacheArtifactPattern)
           
 void setCacheIvyPattern(java.lang.String cacheIvyPattern)
           
 void setCheckUpToDate(boolean checkUpToDate)
           
 void setCircularDependencyStrategy(CircularDependencyStrategy strategy)
           
 void setDefaultBranch(java.lang.String defaultBranch)
           
 void setDefaultCache(java.io.File cacheDirectory)
           
 void setDefaultConflictManager(ConflictManager defaultConflictManager)
           
 void setDefaultIvyUserDir(java.io.File defaultUserDir)
           
 void setDefaultLatestStrategy(LatestStrategy defaultLatestStrategy)
           
 void setDefaultLockStrategy(LockStrategy defaultLockStrategy)
           
 void setDefaultResolver(java.lang.String resolverName)
           
 void setDictatorResolver(DependencyResolver resolver)
           
 void setLogNotConvertedExclusionRule(boolean logNotConvertedExclusionRule)
           
 void setRepositoryCacheRoot(java.lang.String repositoryCacheRoot)
           
 void setResolutionCacheRoot(java.lang.String resolutionCacheRoot)
           
 void setSettingsVariables(java.io.File settingsFile)
           
 void setSettingsVariables(java.net.URL settingsURL)
           
 void setStatusManager(StatusManager statusManager)
           
 void setUseRemoteConfig(boolean useRemoteConfig)
           
 void setValidate(boolean validate)
           
 void setVariable(java.lang.String varName, java.lang.String value)
           
 void setVariable(java.lang.String varName, java.lang.String value, boolean overwrite)
           
 void setVariableContainer(IvyVariableContainer variables)
          Use a different variable container.
 java.lang.String substitute(java.lang.String str)
          Substitute variables in the given string by their value found in the current set of variables
 java.lang.Class typeDef(java.lang.String name, java.lang.String className)
           
 java.lang.Class typeDef(java.lang.String name, java.lang.String className, boolean silentFail)
           
 void typeDefs(java.io.InputStream stream)
           
 void typeDefs(java.io.InputStream stream, boolean silentFail)
           
 void typeDefs(java.util.Properties p)
           
 void typeDefs(java.util.Properties p, boolean silentFail)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IvySettings

public IvySettings()

IvySettings

public IvySettings(IvyVariableContainer variableContainer)
Method Detail

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

Specified by:
configureRepositories in interface ResolverSettings

typeDefs

public void typeDefs(java.io.InputStream stream)
              throws java.io.IOException
Throws:
java.io.IOException

typeDefs

public void typeDefs(java.io.InputStream stream,
                     boolean silentFail)
              throws java.io.IOException
Throws:
java.io.IOException

typeDefs

public void typeDefs(java.util.Properties p)

typeDefs

public void typeDefs(java.util.Properties p,
                     boolean silentFail)

load

public void load(java.io.File settingsFile)
          throws java.text.ParseException,
                 java.io.IOException
Throws:
java.text.ParseException
java.io.IOException

load

public void load(java.net.URL settingsURL)
          throws java.text.ParseException,
                 java.io.IOException
Throws:
java.text.ParseException
java.io.IOException

loadDefault

public void loadDefault()
                 throws java.text.ParseException,
                        java.io.IOException
Throws:
java.text.ParseException
java.io.IOException

loadDefault14

public void loadDefault14()
                   throws java.text.ParseException,
                          java.io.IOException
Throws:
java.text.ParseException
java.io.IOException

getDefaultPropertiesURL

public static java.net.URL getDefaultPropertiesURL()

getDefaultSettingsURL

public static java.net.URL getDefaultSettingsURL()

getDefault14SettingsURL

public static java.net.URL getDefault14SettingsURL()

setSettingsVariables

public void setSettingsVariables(java.io.File settingsFile)

setSettingsVariables

public void setSettingsVariables(java.net.URL settingsURL)

loadProperties

public void loadProperties(java.net.URL url)
                    throws java.io.IOException
Throws:
java.io.IOException

loadProperties

public void loadProperties(java.net.URL url,
                           boolean overwrite)
                    throws java.io.IOException
Throws:
java.io.IOException

loadProperties

public void loadProperties(java.io.File file)
                    throws java.io.IOException
Throws:
java.io.IOException

loadProperties

public void loadProperties(java.io.File file,
                           boolean overwrite)
                    throws java.io.IOException
Throws:
java.io.IOException

setVariable

public void setVariable(java.lang.String varName,
                        java.lang.String value)

setVariable

public void setVariable(java.lang.String varName,
                        java.lang.String value,
                        boolean overwrite)

addAllVariables

public void addAllVariables(java.util.Map variables)

addAllVariables

public void addAllVariables(java.util.Map variables,
                            boolean overwrite)

substitute

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

Specified by:
substitute in interface DeliverEngineSettings
Specified by:
substitute in interface PublishEngineSettings
Specified by:
substitute in interface ParserSettings
Parameters:
str - the string in which substitution should be made
Returns:
the string where all current ivy variables have been substituted by their value

getVariables

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

Specified by:
getVariables in interface RetrieveEngineSettings
Returns:

typeDef

public java.lang.Class typeDef(java.lang.String name,
                               java.lang.String className)

typeDef

public java.lang.Class typeDef(java.lang.String name,
                               java.lang.String className,
                               boolean silentFail)

addClasspathURL

public void addClasspathURL(java.net.URL url)

getTypeDefs

public java.util.Map getTypeDefs()

getTypeDef

public java.lang.Class getTypeDef(java.lang.String name)

addConfigured

public void addConfigured(DependencyResolver resolver)

addConfigured

public void addConfigured(ModuleDescriptorParser parser)

addResolver

public void addResolver(DependencyResolver resolver)

setDefaultCache

public void setDefaultCache(java.io.File cacheDirectory)

setDefaultResolver

public void setDefaultResolver(java.lang.String resolverName)

addModuleConfiguration

public void addModuleConfiguration(ModuleId mid,
                                   PatternMatcher matcher,
                                   java.lang.String resolverName,
                                   java.lang.String branch,
                                   java.lang.String conflictManager)
regular expressions as explained in Pattern class may be used in ModuleId organisation and name

Parameters:
moduleId -
resolverName -
branch -

getDefaultIvyUserDir

public java.io.File getDefaultIvyUserDir()

setDefaultIvyUserDir

public void setDefaultIvyUserDir(java.io.File defaultUserDir)

getDefaultCache

public java.io.File getDefaultCache()
Specified by:
getDefaultCache in interface CacheSettings

setRepositoryCacheRoot

public void setRepositoryCacheRoot(java.lang.String repositoryCacheRoot)

setResolutionCacheRoot

public void setResolutionCacheRoot(java.lang.String resolutionCacheRoot)

getRepositoryCacheRoot

public java.io.File getRepositoryCacheRoot(java.io.File cache)
Specified by:
getRepositoryCacheRoot in interface CacheSettings

getResolutionCacheRoot

public java.io.File getResolutionCacheRoot(java.io.File cache)
Specified by:
getResolutionCacheRoot in interface CacheSettings

setDictatorResolver

public void setDictatorResolver(DependencyResolver resolver)
Specified by:
setDictatorResolver in interface ResolveEngineSettings

getResolver

public DependencyResolver getResolver(ModuleId moduleId)
Specified by:
getResolver in interface CacheSettings
Specified by:
getResolver in interface CheckEngineSettings
Specified by:
getResolver in interface ResolveEngineSettings
Specified by:
getResolver in interface ParserSettings

getResolver

public DependencyResolver getResolver(java.lang.String resolverName)
Specified by:
getResolver in interface CacheSettings
Specified by:
getResolver in interface CheckEngineSettings
Specified by:
getResolver in interface InstallEngineSettings
Specified by:
getResolver in interface PublishEngineSettings

getDefaultResolver

public DependencyResolver getDefaultResolver()

getResolverName

public java.lang.String getResolverName(ModuleId moduleId)
Specified by:
getResolverName in interface ResolveEngineSettings

getDefaultBranch

public java.lang.String getDefaultBranch(ModuleId moduleId)

getDefaultBranch

public java.lang.String getDefaultBranch()

setDefaultBranch

public void setDefaultBranch(java.lang.String defaultBranch)

getConflictManager

public ConflictManager getConflictManager(ModuleId moduleId)
Specified by:
getConflictManager in interface ResolveEngineSettings

addConfigured

public void addConfigured(ConflictManager cm)

getConflictManager

public ConflictManager getConflictManager(java.lang.String name)
Specified by:
getConflictManager in interface ParserSettings

addConflictManager

public void addConflictManager(java.lang.String name,
                               ConflictManager cm)

addConfigured

public void addConfigured(LatestStrategy latest)

getLatestStrategy

public LatestStrategy getLatestStrategy(java.lang.String name)
Specified by:
getLatestStrategy in interface ResolverSettings

addLatestStrategy

public void addLatestStrategy(java.lang.String name,
                              LatestStrategy latest)

addConfigured

public void addConfigured(LockStrategy lockStrategy)

getLockStrategy

public LockStrategy getLockStrategy(java.lang.String name)
Specified by:
getLockStrategy in interface CacheSettings

addLockStrategy

public void addLockStrategy(java.lang.String name,
                            LockStrategy lockStrategy)

addConfigured

public void addConfigured(Namespace ns)

getNamespace

public Namespace getNamespace(java.lang.String name)
Specified by:
getNamespace in interface ParserSettings
Specified by:
getNamespace in interface ResolverSettings

getSystemNamespace

public Namespace getSystemNamespace()
Specified by:
getSystemNamespace in interface ResolverSettings

addNamespace

public void addNamespace(Namespace ns)

addConfigured

public void addConfigured(PatternMatcher m)

getMatcher

public PatternMatcher getMatcher(java.lang.String name)
Specified by:
getMatcher in interface InstallEngineSettings
Specified by:
getMatcher in interface ParserSettings

addMatcher

public void addMatcher(PatternMatcher m)

addConfigured

public void addConfigured(ReportOutputter outputter)

getReportOutputter

public ReportOutputter getReportOutputter(java.lang.String name)

addReportOutputter

public void addReportOutputter(ReportOutputter outputter)

getReportOutputters

public ReportOutputter[] getReportOutputters()
Specified by:
getReportOutputters in interface InstallEngineSettings
Specified by:
getReportOutputters in interface ResolveEngineSettings

addConfigured

public void addConfigured(VersionMatcher vmatcher)

getVersionMatcher

public VersionMatcher getVersionMatcher(java.lang.String name)

addVersionMatcher

public void addVersionMatcher(VersionMatcher vmatcher)

getVersionMatchers

public VersionMatcher[] getVersionMatchers()

getVersionMatcher

public VersionMatcher getVersionMatcher()
Specified by:
getVersionMatcher in interface CacheSettings
Specified by:
getVersionMatcher in interface SortEngineSettings
Specified by:
getVersionMatcher in interface ResolverSettings

configureDefaultVersionMatcher

public void configureDefaultVersionMatcher()

getCircularDependencyStrategy

public CircularDependencyStrategy getCircularDependencyStrategy()
Specified by:
getCircularDependencyStrategy in interface SortEngineSettings

getCircularDependencyStrategy

public CircularDependencyStrategy getCircularDependencyStrategy(java.lang.String name)

setCircularDependencyStrategy

public void setCircularDependencyStrategy(CircularDependencyStrategy strategy)

addConfigured

public void addConfigured(CircularDependencyStrategy strategy)

getStatusManager

public StatusManager getStatusManager()
Specified by:
getStatusManager in interface InstallEngineSettings
Specified by:
getStatusManager in interface ParserSettings

setStatusManager

public void setStatusManager(StatusManager statusManager)

listingIgnore

public boolean listingIgnore(java.lang.String name)
Returns true if the name should be ignored in listing

Parameters:
name -
Returns:

filterIgnore

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

Specified by:
filterIgnore in interface ResolverSettings
Parameters:
names -

isCheckUpToDate

public boolean isCheckUpToDate()
Specified by:
isCheckUpToDate in interface RetrieveEngineSettings

setCheckUpToDate

public void setCheckUpToDate(boolean checkUpToDate)

getCacheArtifactPattern

public java.lang.String getCacheArtifactPattern()
Specified by:
getCacheArtifactPattern in interface CacheSettings

setCacheArtifactPattern

public void setCacheArtifactPattern(java.lang.String cacheArtifactPattern)

getCacheIvyPattern

public java.lang.String getCacheIvyPattern()
Specified by:
getCacheIvyPattern in interface CacheSettings

setCacheIvyPattern

public void setCacheIvyPattern(java.lang.String cacheIvyPattern)

getCacheDataFilePattern

public java.lang.String getCacheDataFilePattern()
Specified by:
getCacheDataFilePattern in interface CacheSettings

doValidate

public boolean doValidate()
Specified by:
doValidate in interface CheckEngineSettings

setValidate

public void setValidate(boolean validate)

getVariable

public java.lang.String getVariable(java.lang.String name)
Specified by:
getVariable in interface ResolverSettings

getDefaultConflictManager

public ConflictManager getDefaultConflictManager()

setDefaultConflictManager

public void setDefaultConflictManager(ConflictManager defaultConflictManager)

getDefaultLatestStrategy

public LatestStrategy getDefaultLatestStrategy()
Specified by:
getDefaultLatestStrategy in interface ResolverSettings

setDefaultLatestStrategy

public void setDefaultLatestStrategy(LatestStrategy defaultLatestStrategy)

getDefaultLockStrategy

public LockStrategy getDefaultLockStrategy()
Specified by:
getDefaultLockStrategy in interface CacheSettings

setDefaultLockStrategy

public void setDefaultLockStrategy(LockStrategy defaultLockStrategy)

addTrigger

public void addTrigger(Trigger trigger)

getTriggers

public java.util.List getTriggers()

addConfigured

public void addConfigured(Trigger trigger)

isUseRemoteConfig

public boolean isUseRemoteConfig()

setUseRemoteConfig

public void setUseRemoteConfig(boolean useRemoteConfig)

logModulesInUse

public boolean logModulesInUse()

logModuleWhenFound

public boolean logModuleWhenFound()
Specified by:
logModuleWhenFound in interface ResolveEngineSettings

logResolvedRevision

public boolean logResolvedRevision()
Specified by:
logResolvedRevision in interface ResolveEngineSettings

debugConflictResolution

public boolean debugConflictResolution()
Specified by:
debugConflictResolution in interface ResolveEngineSettings

debugLocking

public final boolean debugLocking()
Specified by:
debugLocking in interface CacheSettings

logNotConvertedExclusionRule

public boolean logNotConvertedExclusionRule()
Specified by:
logNotConvertedExclusionRule in interface InstallEngineSettings
Specified by:
logNotConvertedExclusionRule in interface ResolveEngineSettings

setLogNotConvertedExclusionRule

public void setLogNotConvertedExclusionRule(boolean logNotConvertedExclusionRule)
Specified by:
setLogNotConvertedExclusionRule in interface InstallEngineSettings

getCacheResolvedIvyPattern

public java.lang.String getCacheResolvedIvyPattern()
Specified by:
getCacheResolvedIvyPattern in interface CacheSettings

getCacheResolvedIvyPropertiesPattern

public java.lang.String getCacheResolvedIvyPropertiesPattern()
Specified by:
getCacheResolvedIvyPropertiesPattern in interface CacheSettings

getInterruptTimeout

public long getInterruptTimeout()

getResolvers

public java.util.Collection getResolvers()

getResolverNames

public java.util.Collection getResolverNames()
Specified by:
getResolverNames in interface InstallEngineSettings

getMatcherNames

public java.util.Collection getMatcherNames()
Specified by:
getMatcherNames in interface InstallEngineSettings

getVariableContainer

public IvyVariableContainer getVariableContainer()

setVariableContainer

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

Parameters:
variables -

getRelativeUrlResolver

public RelativeUrlResolver getRelativeUrlResolver()
Specified by:
getRelativeUrlResolver in interface ParserSettings