public class IvySettings extends java.lang.Object implements SortEngineSettings, PublishEngineSettings, ParserSettings, DeliverEngineSettings, CheckEngineSettings, InstallEngineSettings, ResolverSettings, ResolveEngineSettings, RetrieveEngineSettings, RepositoryManagementEngineSettings
| Constructor and Description |
|---|
IvySettings() |
IvySettings(IvyVariableContainer variableContainer) |
| Modifier and Type | Method and Description |
|---|---|
void |
addAllVariables(java.util.Map variables) |
void |
addAllVariables(java.util.Map<?,?> variables,
boolean overwrite) |
void |
addClasspathURL(java.net.URL url) |
void |
addConfigured(ArchivePacking packing) |
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(RepositoryCacheManager c) |
void |
addConfigured(SignatureGenerator generator) |
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(java.util.Map attributes,
PatternMatcher matcher,
java.lang.String resolverName,
java.lang.String branch,
java.lang.String conflictManager,
java.lang.String resolveMode)
regular expressions as explained in Pattern class may be used in attributes
|
void |
addNamespace(Namespace ns) |
void |
addReportOutputter(ReportOutputter outputter) |
void |
addRepositoryCacheManager(RepositoryCacheManager c) |
void |
addResolver(DependencyResolver resolver) |
void |
addSignatureGenerator(SignatureGenerator generator) |
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() |
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.
|
boolean |
doValidate() |
boolean |
dumpMemoryUsage() |
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.io.File |
getBaseDir() |
CircularDependencyStrategy |
getCircularDependencyStrategy() |
CircularDependencyStrategy |
getCircularDependencyStrategy(java.lang.String name) |
ConflictManager |
getConflictManager(ModuleId moduleId) |
ConflictManager |
getConflictManager(java.lang.String name) |
Namespace |
getContextNamespace()
Returns the namespace context in which the current descriptor is parsed.
|
static java.net.URL |
getDefault14SettingsURL() |
java.lang.String |
getDefaultBranch() |
java.lang.String |
getDefaultBranch(ModuleId moduleId) |
java.io.File |
getDefaultCache() |
java.lang.String |
getDefaultCacheArtifactPattern() |
java.lang.String |
getDefaultCacheIvyPattern() |
ConflictManager |
getDefaultConflictManager() |
java.io.File |
getDefaultIvyUserDir() |
LatestStrategy |
getDefaultLatestStrategy() |
LockStrategy |
getDefaultLockStrategy() |
static java.net.URL |
getDefaultPropertiesURL() |
java.io.File |
getDefaultRepositoryCacheBasedir() |
RepositoryCacheManager |
getDefaultRepositoryCacheManager() |
java.io.File |
getDefaultResolutionCacheBasedir() |
java.lang.String |
getDefaultResolveMode() |
DependencyResolver |
getDefaultResolver() |
static java.net.URL |
getDefaultSettingsURL() |
java.lang.String[] |
getIgnorableFilenames()
Returns the file names of the files that should be ignored when creating a file listing.
|
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) |
PackingRegistry |
getPackingRegistry() |
RelativeUrlResolver |
getRelativeUrlResolver() |
ReportOutputter |
getReportOutputter(java.lang.String name) |
ReportOutputter[] |
getReportOutputters() |
RepositoryCacheManager |
getRepositoryCacheManager(java.lang.String name) |
RepositoryCacheManager[] |
getRepositoryCacheManagers() |
ResolutionCacheManager |
getResolutionCacheManager() |
java.lang.String |
getResolveMode(ModuleId moduleId) |
DependencyResolver |
getResolver(ModuleRevisionId mrid) |
DependencyResolver |
getResolver(java.lang.String resolverName) |
java.lang.String |
getResolverName(ModuleRevisionId mrid) |
java.util.Collection |
getResolverNames() |
java.util.Collection |
getResolvers() |
SignatureGenerator |
getSignatureGenerator(java.lang.String name) |
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() |
IvyVariableContainer |
getVariables()
Returns the variables loaded in configuration file.
|
VersionMatcher |
getVersionMatcher() |
VersionMatcher |
getVersionMatcher(java.lang.String name) |
VersionMatcher[] |
getVersionMatchers() |
boolean |
hasResolver(java.lang.String resolverName) |
boolean |
isCheckUpToDate() |
boolean |
isDefaultUseOrigin() |
boolean |
isUseRemoteConfig() |
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() |
java.io.File |
resolveFile(java.lang.String fileName)
Return the canonical form of a filename.
|
void |
setBaseDir(java.io.File baseDir) |
void |
setCheckUpToDate(boolean checkUpToDate) |
void |
setCircularDependencyStrategy(CircularDependencyStrategy strategy) |
void |
setDefaultBranch(java.lang.String defaultBranch) |
void |
setDefaultCache(java.io.File cacheDirectory) |
void |
setDefaultCacheArtifactPattern(java.lang.String defaultCacheArtifactPattern) |
void |
setDefaultCacheIvyPattern(java.lang.String defaultCacheIvyPattern) |
void |
setDefaultConflictManager(ConflictManager defaultConflictManager) |
void |
setDefaultIvyUserDir(java.io.File defaultUserDir) |
void |
setDefaultLatestStrategy(LatestStrategy defaultLatestStrategy) |
void |
setDefaultLockStrategy(LockStrategy defaultLockStrategy) |
void |
setDefaultRepositoryCacheBasedir(java.lang.String repositoryCacheRoot) |
void |
setDefaultRepositoryCacheManager(RepositoryCacheManager cache) |
void |
setDefaultResolutionCacheBasedir(java.lang.String resolutionCacheRoot) |
void |
setDefaultResolveMode(java.lang.String defaultResolveMode) |
void |
setDefaultResolver(java.lang.String resolverName) |
void |
setDefaultUseOrigin(boolean useOrigin) |
void |
setDictatorResolver(DependencyResolver resolver) |
void |
setLogNotConvertedExclusionRule(boolean logNotConvertedExclusionRule) |
void |
setResolutionCacheManager(ResolutionCacheManager resolutionCacheManager) |
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 |
setVariable(java.lang.String varName,
java.lang.String value,
boolean overwrite,
java.lang.String ifSetVar,
java.lang.String unlessSetVar) |
void |
setVariableContainer(IvyVariableContainer variables)
Use a different variable container.
|
java.util.Map |
substitute(java.util.Map strings)
Substitute variables in the given map values by their value found in the current set of
variables
|
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) |
void |
useDeprecatedUseOrigin() |
void |
validate()
Validates the settings, throwing an
IllegalStateException if the current state is not
valid. |
public IvySettings()
public IvySettings(IvyVariableContainer variableContainer)
public void configureRepositories(boolean remote)
configureRepositories in interface ResolverSettingspublic void typeDefs(java.io.InputStream stream)
throws java.io.IOException
java.io.IOExceptionpublic void typeDefs(java.io.InputStream stream,
boolean silentFail)
throws java.io.IOException
java.io.IOExceptionpublic void typeDefs(java.util.Properties p)
public void typeDefs(java.util.Properties p,
boolean silentFail)
public void load(java.io.File settingsFile)
throws java.text.ParseException,
java.io.IOException
java.text.ParseExceptionjava.io.IOExceptionpublic void load(java.net.URL settingsURL)
throws java.text.ParseException,
java.io.IOException
java.text.ParseExceptionjava.io.IOExceptionpublic void defaultInit()
throws java.io.IOException
java.io.IOExceptionpublic void loadDefault()
throws java.text.ParseException,
java.io.IOException
java.text.ParseExceptionjava.io.IOExceptionpublic void loadDefault14()
throws java.text.ParseException,
java.io.IOException
java.text.ParseExceptionjava.io.IOExceptionpublic static java.net.URL getDefaultPropertiesURL()
public static java.net.URL getDefaultSettingsURL()
public static java.net.URL getDefault14SettingsURL()
public void setSettingsVariables(java.io.File settingsFile)
public void setSettingsVariables(java.net.URL settingsURL)
public void loadProperties(java.net.URL url)
throws java.io.IOException
java.io.IOExceptionpublic void loadProperties(java.net.URL url,
boolean overwrite)
throws java.io.IOException
java.io.IOExceptionpublic void loadProperties(java.io.File file)
throws java.io.IOException
java.io.IOExceptionpublic void loadProperties(java.io.File file,
boolean overwrite)
throws java.io.IOException
java.io.IOExceptionpublic void setVariable(java.lang.String varName,
java.lang.String value)
public void setVariable(java.lang.String varName,
java.lang.String value,
boolean overwrite)
public void setVariable(java.lang.String varName,
java.lang.String value,
boolean overwrite,
java.lang.String ifSetVar,
java.lang.String unlessSetVar)
public void addAllVariables(java.util.Map variables)
public void addAllVariables(java.util.Map<?,?> variables,
boolean overwrite)
public java.lang.String substitute(java.lang.String str)
substitute in interface DeliverEngineSettingssubstitute in interface PublishEngineSettingssubstitute in interface ParserSettingsstr - the string in which substitution should be madepublic java.util.Map substitute(java.util.Map strings)
substitute in interface ParserSettingsstrings - the map of strings in which substitution should be madepublic IvyVariableContainer getVariables()
getVariables in interface RetrieveEngineSettingspublic java.lang.Class typeDef(java.lang.String name,
java.lang.String className)
public java.lang.Class typeDef(java.lang.String name,
java.lang.String className,
boolean silentFail)
public void addClasspathURL(java.net.URL url)
public java.util.Map getTypeDefs()
public java.lang.Class getTypeDef(java.lang.String name)
public void addConfigured(DependencyResolver resolver)
public void addConfigured(ModuleDescriptorParser parser)
public void addConfigured(SignatureGenerator generator)
public void addSignatureGenerator(SignatureGenerator generator)
public SignatureGenerator getSignatureGenerator(java.lang.String name)
getSignatureGenerator in interface ResolverSettingspublic void addResolver(DependencyResolver resolver)
public void setDefaultCache(java.io.File cacheDirectory)
public void setDefaultResolver(java.lang.String resolverName)
public void addModuleConfiguration(java.util.Map attributes,
PatternMatcher matcher,
java.lang.String resolverName,
java.lang.String branch,
java.lang.String conflictManager,
java.lang.String resolveMode)
public java.io.File resolveFile(java.lang.String fileName)
If the specified file name is relative it is resolved with respect to the settings's base directory.
resolveFile in interface ParserSettingsfileName - The name of the file to resolve. Must not be null.public void setBaseDir(java.io.File baseDir)
public java.io.File getBaseDir()
public java.io.File getDefaultIvyUserDir()
public void setDefaultIvyUserDir(java.io.File defaultUserDir)
public java.io.File getDefaultCache()
public void setDefaultRepositoryCacheBasedir(java.lang.String repositoryCacheRoot)
public void setDefaultResolutionCacheBasedir(java.lang.String resolutionCacheRoot)
public java.io.File getDefaultRepositoryCacheBasedir()
public java.io.File getDefaultResolutionCacheBasedir()
public void setDictatorResolver(DependencyResolver resolver)
setDictatorResolver in interface ResolveEngineSettingspublic DependencyResolver getResolver(ModuleRevisionId mrid)
getResolver in interface ParserSettingspublic boolean hasResolver(java.lang.String resolverName)
public DependencyResolver getResolver(java.lang.String resolverName)
getResolver in interface CheckEngineSettingsgetResolver in interface InstallEngineSettingsgetResolver in interface PublishEngineSettingspublic DependencyResolver getDefaultResolver()
public java.lang.String getResolverName(ModuleRevisionId mrid)
getResolverName in interface ResolveEngineSettingspublic java.lang.String getDefaultBranch(ModuleId moduleId)
getDefaultBranch in interface ParserSettingspublic java.lang.String getDefaultBranch()
public void setDefaultBranch(java.lang.String defaultBranch)
public ConflictManager getConflictManager(ModuleId moduleId)
getConflictManager in interface ResolveEngineSettingspublic java.lang.String getResolveMode(ModuleId moduleId)
getResolveMode in interface ResolverSettingspublic java.lang.String getDefaultResolveMode()
public void setDefaultResolveMode(java.lang.String defaultResolveMode)
public void addConfigured(ConflictManager cm)
public ConflictManager getConflictManager(java.lang.String name)
getConflictManager in interface ParserSettingspublic void addConflictManager(java.lang.String name,
ConflictManager cm)
public void addConfigured(LatestStrategy latest)
public LatestStrategy getLatestStrategy(java.lang.String name)
getLatestStrategy in interface ResolverSettingspublic void addLatestStrategy(java.lang.String name,
LatestStrategy latest)
public void addConfigured(LockStrategy lockStrategy)
public LockStrategy getLockStrategy(java.lang.String name)
public void addLockStrategy(java.lang.String name,
LockStrategy lockStrategy)
public void addConfigured(Namespace ns)
public Namespace getNamespace(java.lang.String name)
getNamespace in interface ParserSettingsgetNamespace in interface ResolverSettingspublic final Namespace getSystemNamespace()
getSystemNamespace in interface ResolverSettingspublic void addNamespace(Namespace ns)
public void addConfigured(PatternMatcher m)
public PatternMatcher getMatcher(java.lang.String name)
getMatcher in interface InstallEngineSettingsgetMatcher in interface ParserSettingspublic void addMatcher(PatternMatcher m)
public void addConfigured(RepositoryCacheManager c)
public RepositoryCacheManager getRepositoryCacheManager(java.lang.String name)
getRepositoryCacheManager in interface ResolverSettingspublic void addRepositoryCacheManager(RepositoryCacheManager c)
public RepositoryCacheManager[] getRepositoryCacheManagers()
getRepositoryCacheManagers in interface ResolverSettingspublic void addConfigured(ReportOutputter outputter)
public ReportOutputter getReportOutputter(java.lang.String name)
public void addReportOutputter(ReportOutputter outputter)
public ReportOutputter[] getReportOutputters()
getReportOutputters in interface InstallEngineSettingsgetReportOutputters in interface ResolveEngineSettingspublic void addConfigured(VersionMatcher vmatcher)
public VersionMatcher getVersionMatcher(java.lang.String name)
public void addVersionMatcher(VersionMatcher vmatcher)
public VersionMatcher[] getVersionMatchers()
public VersionMatcher getVersionMatcher()
getVersionMatcher in interface SortEngineSettingsgetVersionMatcher in interface ResolverSettingspublic void configureDefaultVersionMatcher()
public CircularDependencyStrategy getCircularDependencyStrategy()
getCircularDependencyStrategy in interface SortEngineSettingspublic CircularDependencyStrategy getCircularDependencyStrategy(java.lang.String name)
public void setCircularDependencyStrategy(CircularDependencyStrategy strategy)
public void addConfigured(CircularDependencyStrategy strategy)
public StatusManager getStatusManager()
getStatusManager in interface InstallEngineSettingsgetStatusManager in interface ParserSettingspublic void setStatusManager(StatusManager statusManager)
public java.lang.String[] getIgnorableFilenames()
getIgnorableFilenames in interface RetrieveEngineSettingspublic void filterIgnore(java.util.Collection names)
filterIgnore in interface ResolverSettingsnames - public boolean isCheckUpToDate()
isCheckUpToDate in interface RetrieveEngineSettingspublic void setCheckUpToDate(boolean checkUpToDate)
public boolean doValidate()
doValidate in interface CheckEngineSettingspublic void setValidate(boolean validate)
public java.lang.String getVariable(java.lang.String name)
getVariable in interface ResolverSettingspublic ConflictManager getDefaultConflictManager()
public void setDefaultConflictManager(ConflictManager defaultConflictManager)
public LatestStrategy getDefaultLatestStrategy()
getDefaultLatestStrategy in interface ResolverSettingspublic void setDefaultLatestStrategy(LatestStrategy defaultLatestStrategy)
public LockStrategy getDefaultLockStrategy()
public void setDefaultLockStrategy(LockStrategy defaultLockStrategy)
public RepositoryCacheManager getDefaultRepositoryCacheManager()
getDefaultRepositoryCacheManager in interface ResolverSettingspublic void setDefaultRepositoryCacheManager(RepositoryCacheManager cache)
public ResolutionCacheManager getResolutionCacheManager()
getResolutionCacheManager in interface ParserSettingspublic void setResolutionCacheManager(ResolutionCacheManager resolutionCacheManager)
public void addTrigger(Trigger trigger)
public java.util.List getTriggers()
public void addConfigured(Trigger trigger)
public boolean isUseRemoteConfig()
public void setUseRemoteConfig(boolean useRemoteConfig)
public boolean logModulesInUse()
public boolean logModuleWhenFound()
logModuleWhenFound in interface ResolveEngineSettingspublic boolean logResolvedRevision()
logResolvedRevision in interface ResolveEngineSettingspublic boolean debugConflictResolution()
debugConflictResolution in interface ResolveEngineSettingspublic boolean debugLocking()
public boolean dumpMemoryUsage()
dumpMemoryUsage in interface RepositoryManagementEngineSettingspublic boolean logNotConvertedExclusionRule()
logNotConvertedExclusionRule in interface InstallEngineSettingslogNotConvertedExclusionRule in interface ResolveEngineSettingspublic void setLogNotConvertedExclusionRule(boolean logNotConvertedExclusionRule)
setLogNotConvertedExclusionRule in interface InstallEngineSettingspublic final long getInterruptTimeout()
public java.util.Collection getResolvers()
public java.util.Collection getResolverNames()
getResolverNames in interface InstallEngineSettingspublic java.util.Collection getMatcherNames()
getMatcherNames in interface InstallEngineSettingspublic IvyVariableContainer getVariableContainer()
public void setVariableContainer(IvyVariableContainer variables)
variables - public RelativeUrlResolver getRelativeUrlResolver()
getRelativeUrlResolver in interface ParserSettingspublic void setDefaultCacheIvyPattern(java.lang.String defaultCacheIvyPattern)
public java.lang.String getDefaultCacheIvyPattern()
public void setDefaultCacheArtifactPattern(java.lang.String defaultCacheArtifactPattern)
public java.lang.String getDefaultCacheArtifactPattern()
public void setDefaultUseOrigin(boolean useOrigin)
public boolean isDefaultUseOrigin()
public void useDeprecatedUseOrigin()
public void validate()
IllegalStateException if the current state is not
valid.java.lang.IllegalStateException - if the settings is not valid.public Namespace getContextNamespace()
ParserSettingsgetContextNamespace in interface ParserSettingspublic void addConfigured(ArchivePacking packing)
public PackingRegistry getPackingRegistry()