Class IvySettings

Method Details

• 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

  Parameters:

  remote - boolean

• typeDefs

  public void typeDefs(InputStream stream) throws IOException

  Throws:

  IOException

• typeDefs

  public void typeDefs(InputStream stream, boolean silentFail) throws IOException

  Throws:

  IOException

• typeDefs

  public void typeDefs(Properties p)

• typeDefs

  public void typeDefs(Properties p, boolean silentFail)

• load

  public void load(File settingsFile) throws ParseException, IOException

  Throws:

  ParseException

  IOException

• load

  public void load(URL settingsURL) throws ParseException, IOException

  Throws:

  ParseException

  IOException

• defaultInit

  public void defaultInit() throws IOException

  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 - if something goes wrong

• loadDefault

  public void loadDefault() throws ParseException, IOException

  Throws:

  ParseException

  IOException

• loadDefault14

  public void loadDefault14() throws ParseException, IOException

  Throws:

  ParseException

  IOException

• getDefaultPropertiesURL

  public static URL getDefaultPropertiesURL()

• getDefaultSettingsURL

  public static URL getDefaultSettingsURL()

• getDefault14SettingsURL

  public static URL getDefault14SettingsURL()

• setSettingsVariables

  public void setSettingsVariables(File settingsFile)

• setSettingsVariables

  public void setSettingsVariables(URL settingsURL)

• loadProperties

  public void loadProperties(URL url) throws IOException

  Throws:

  IOException

• loadProperties

  public void loadProperties(URL url, boolean overwrite) throws IOException

  Throws:

  IOException

• loadProperties

  public void loadProperties(File file) throws IOException

  Throws:

  IOException

• loadProperties

  public void loadProperties(File file, boolean overwrite) throws IOException

  Throws:

  IOException

• setVariable

  public void setVariable(String varName, String value)

• setVariable

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

• setVariable

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

• addAllVariables

  public void addAllVariables(Map<?,?> variables)

• addAllVariables

  public void addAllVariables(Map<?,?> variables, boolean overwrite)

• substitute

  public String substitute(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 ParserSettings

  Specified by:

  substitute in interface PublishEngineSettings

  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<String,String> substitute(Map<String,String> strings)

  Substitute variables in the given map values by their value found in the current set of variables

  Specified by:

  substitute in interface ParserSettings

  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

• getVariables

  public IvyVariableContainer getVariables()

  Returns the variables loaded in configuration file. Those variables may better be seen as ant properties

  Specified by:

  getVariables in interface RetrieveEngineSettings

  Returns:

  IvyVariableContainer

• typeDef

  public Class<?> typeDef(String name, String className)

• typeDef

  public Class<?> typeDef(String name, String className, boolean silentFail)

• addClasspathURL

  public void addClasspathURL(URL url)

• getTypeDefs

  public Map<String,Class<?>> getTypeDefs()

• getTypeDef

  public Class<?> getTypeDef(String name)

• addConfigured

  public void addConfigured(DependencyResolver resolver)

• addConfigured

  public void addConfigured(ModuleDescriptorParser parser)

• addConfigured

  public void addConfigured(SignatureGenerator generator)

• addSignatureGenerator

  public void addSignatureGenerator(SignatureGenerator generator)

• getSignatureGenerator

  public SignatureGenerator getSignatureGenerator(String name)

  Specified by:

  getSignatureGenerator in interface ResolverSettings

• addResolver

  public void addResolver(DependencyResolver resolver)

• setDefaultCache

  public void setDefaultCache(File cacheDirectory)

• setDefaultResolver

  public void setDefaultResolver(String resolverName)

• addModuleConfiguration

  public void addModuleConfiguration(Map<String,String> attributes, PatternMatcher matcher, String resolverName, String branch, String conflictManager, String resolveMode)

  regular expressions as explained in Pattern class may be used in attributes

  Parameters:

  attributes - Map

  matcher - PatternMatcher

  resolverName - String

  branch - String

  conflictManager - String

  resolveMode - String

• 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.

  Specified by:

  resolveFile in interface ParserSettings

  Parameters:

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

  Returns:

  the resolved File.

• setBaseDir

  public void setBaseDir(File baseDir)

• getBaseDir

  public File getBaseDir()

• getDefaultIvyUserDir

  public File getDefaultIvyUserDir()

• setDefaultIvyUserDir

  public void setDefaultIvyUserDir(File defaultUserDir)

• getDefaultCache

  public File getDefaultCache()

• setDefaultRepositoryCacheBasedir

  public void setDefaultRepositoryCacheBasedir(String repositoryCacheRoot)

• setDefaultResolutionCacheBasedir

  public void setDefaultResolutionCacheBasedir(String resolutionCacheRoot)

• getDefaultRepositoryCacheBasedir

  public File getDefaultRepositoryCacheBasedir()

• getDefaultResolutionCacheBasedir

  public File getDefaultResolutionCacheBasedir()

• setDictatorResolver

  public void setDictatorResolver(DependencyResolver resolver)

  Specified by:

  setDictatorResolver in interface ResolveEngineSettings

• getResolver

  public DependencyResolver getResolver(ModuleRevisionId mrid)

  Specified by:

  getResolver in interface ParserSettings

• hasResolver

  public boolean hasResolver(String resolverName)

• getResolver

  public DependencyResolver getResolver(String resolverName)

  Specified by:

  getResolver in interface CheckEngineSettings

  Specified by:

  getResolver in interface InstallEngineSettings

  Specified by:

  getResolver in interface PublishEngineSettings

• getDefaultResolver

  public DependencyResolver getDefaultResolver()

• getResolverName

  public String getResolverName(ModuleRevisionId mrid)

  Specified by:

  getResolverName in interface ResolveEngineSettings

• getDefaultBranch

  public String getDefaultBranch(ModuleId moduleId)

  Specified by:

  getDefaultBranch in interface ParserSettings

• getDefaultBranch

  public String getDefaultBranch()

• setDefaultBranch

  public void setDefaultBranch(String defaultBranch)

• getConflictManager

  public ConflictManager getConflictManager(ModuleId moduleId)

  Specified by:

  getConflictManager in interface ResolveEngineSettings

• getResolveMode

  public String getResolveMode(ModuleId moduleId)

  Specified by:

  getResolveMode in interface ResolverSettings

• getDefaultResolveMode

  public String getDefaultResolveMode()

• setDefaultResolveMode

  public void setDefaultResolveMode(String defaultResolveMode)

• addConfigured

  public void addConfigured(ConflictManager cm)

• getConflictManager

  public ConflictManager getConflictManager(String name)

  Specified by:

  getConflictManager in interface ParserSettings

• addConflictManager

  public void addConflictManager(String name, ConflictManager cm)

• addConfigured

  public void addConfigured(LatestStrategy latest)

• getLatestStrategy

  public LatestStrategy getLatestStrategy(String name)

  Specified by:

  getLatestStrategy in interface ResolverSettings

• addLatestStrategy

  public void addLatestStrategy(String name, LatestStrategy latest)

• addConfigured

  public void addConfigured(LockStrategy lockStrategy)

• getLockStrategy

  public LockStrategy getLockStrategy(String name)

• addLockStrategy

  public void addLockStrategy(String name, LockStrategy lockStrategy)

• addConfigured

  public void addConfigured(Namespace ns)

• getNamespace

  public Namespace getNamespace(String name)

  Specified by:

  getNamespace in interface ParserSettings

  Specified by:

  getNamespace in interface ResolverSettings

• getSystemNamespace

  public final Namespace getSystemNamespace()

  Specified by:

  getSystemNamespace in interface ResolverSettings

• addNamespace

  public void addNamespace(Namespace ns)

• addConfigured

  public void addConfigured(NamedTimeoutConstraint timeoutConstraint)

• getTimeoutConstraint

  public TimeoutConstraint getTimeoutConstraint(String name)

  Specified by:

  getTimeoutConstraint in interface ParserSettings

  Parameters:

  name - The name of the TimeoutConstraint

  Returns:

  Returns a TimeoutConstraint which is identified by the passed name. Returns null if no such TimeoutConstraint exists

• addConfigured

  public void addConfigured(PatternMatcher m)

• getMatcher

  public PatternMatcher getMatcher(String name)

  Specified by:

  getMatcher in interface InstallEngineSettings

  Specified by:

  getMatcher in interface ParserSettings

• addMatcher

  public void addMatcher(PatternMatcher m)

• addConfigured

  public void addConfigured(RepositoryCacheManager c)

• getRepositoryCacheManager

  public RepositoryCacheManager getRepositoryCacheManager(String name)

  Specified by:

  getRepositoryCacheManager in interface ResolverSettings

• addRepositoryCacheManager

  public void addRepositoryCacheManager(RepositoryCacheManager c)

• getRepositoryCacheManagers

  public RepositoryCacheManager[] getRepositoryCacheManagers()

  Specified by:

  getRepositoryCacheManagers in interface ResolverSettings

• addConfigured

  public void addConfigured(ReportOutputter outputter)

• getReportOutputter

  public ReportOutputter getReportOutputter(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(String name)

• addVersionMatcher

  public void addVersionMatcher(VersionMatcher vmatcher)

• getVersionMatchers

  public VersionMatcher[] getVersionMatchers()

• getVersionMatcher

  public VersionMatcher getVersionMatcher()

  Specified by:

  getVersionMatcher in interface ResolverSettings

  Specified by:

  getVersionMatcher in interface SortEngineSettings

• configureDefaultVersionMatcher

  public void configureDefaultVersionMatcher()

• getCircularDependencyStrategy

  public CircularDependencyStrategy getCircularDependencyStrategy()

  Specified by:

  getCircularDependencyStrategy in interface SortEngineSettings

• getCircularDependencyStrategy

  public CircularDependencyStrategy getCircularDependencyStrategy(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)

• getIgnorableFilenames

  public String[] getIgnorableFilenames()

  Returns the file names of the files that should be ignored when creating a file listing.

  Specified by:

  getIgnorableFilenames in interface RetrieveEngineSettings

  Returns:

  String[]

• filterIgnore

  public void filterIgnore(Collection<String> 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 - ditto

• isCheckUpToDate

  public boolean isCheckUpToDate()

  Specified by:

  isCheckUpToDate in interface RetrieveEngineSettings

• setCheckUpToDate

  public void setCheckUpToDate(boolean checkUpToDate)

• doValidate

  public boolean doValidate()

  Specified by:

  doValidate in interface CheckEngineSettings

• setValidate

  public void setValidate(boolean validate)

• getVariable

  public String getVariable(String name)

  Specified by:

  getVariable in interface ParserSettings

  Specified by:

  getVariable in interface ResolverSettings

• getVariableAsBoolean

  public boolean getVariableAsBoolean(String name, boolean valueIfUnset)

  Returns a variable as boolean value.

  Parameters:

  name - name of the variable

  valueIfUnset - value if the variable is unset

  Returns:

  true if the variable is 'true' (ignoring case) or the value of valueIfUnset if the variable is null

• 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()

• setDefaultLockStrategy

  public void setDefaultLockStrategy(LockStrategy defaultLockStrategy)

• getDefaultRepositoryCacheManager

  public RepositoryCacheManager getDefaultRepositoryCacheManager()

  Specified by:

  getDefaultRepositoryCacheManager in interface ResolverSettings

• setDefaultRepositoryCacheManager

  public void setDefaultRepositoryCacheManager(RepositoryCacheManager cache)

• getResolutionCacheManager

  public ResolutionCacheManager getResolutionCacheManager()

  Specified by:

  getResolutionCacheManager in interface ParserSettings

• setResolutionCacheManager

  public void setResolutionCacheManager(ResolutionCacheManager resolutionCacheManager)

• addTrigger

  public void addTrigger(Trigger trigger)

• getTriggers

  public List<Trigger> 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 boolean debugLocking()

• dumpMemoryUsage

  public boolean dumpMemoryUsage()

  Specified by:

  dumpMemoryUsage in interface RepositoryManagementEngineSettings

• 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

• getInterruptTimeout

  public final long getInterruptTimeout()

• getResolvers

  public Collection<DependencyResolver> getResolvers()

• getResolverNames

  public Collection<String> getResolverNames()

  Specified by:

  getResolverNames in interface InstallEngineSettings

• getMatcherNames

  public Collection<String> getMatcherNames()

  Specified by:

  getMatcherNames in interface InstallEngineSettings

• getVariableContainer

  public IvyVariableContainer getVariableContainer()

• setVariableContainer

  public void setVariableContainer(IvyVariableContainer variables)

  Use a different variable container.

  Parameters:

  variables - IvyVariableContainer

• getRelativeUrlResolver

  public RelativeUrlResolver getRelativeUrlResolver()

  Specified by:

  getRelativeUrlResolver in interface ParserSettings

• setDefaultCacheIvyPattern

  public void setDefaultCacheIvyPattern(String defaultCacheIvyPattern)

• getDefaultCacheIvyPattern

  public String getDefaultCacheIvyPattern()

• setDefaultCacheArtifactPattern

  public void setDefaultCacheArtifactPattern(String defaultCacheArtifactPattern)

• getDefaultCacheArtifactPattern

  public String getDefaultCacheArtifactPattern()

• setDefaultUseOrigin

  public void setDefaultUseOrigin(boolean useOrigin)

• isDefaultUseOrigin

  public boolean isDefaultUseOrigin()

• 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.

• getContextNamespace

  public Namespace getContextNamespace()

  Specified by:

  getContextNamespace in interface ParserSettings

  Returns:

  the namespace context in which the current descriptor is parsed.

• addConfigured

  public void addConfigured(ArchivePacking packing)

• getPackingRegistry

  public PackingRegistry getPackingRegistry()

• addConfigured

  public void addConfigured(AbstractWorkspaceResolver workspaceResolver)