Package org.apache.ivy.core.settings

Class IvySettings

    • Field Detail

      • typeDefs

        private java.util.Map<java.lang.String,​java.lang.Class<?>> typeDefs

      • resolversMap

        private java.util.Map<java.lang.String,​DependencyResolver> resolversMap

      • defaultResolverName

        private java.lang.String defaultResolverName

      • defaultCache

        private java.io.File defaultCache

      • defaultBranch

        private java.lang.String defaultBranch

      • checkUpToDate

        private boolean checkUpToDate

      • conflictsManager

        private java.util.Map<java.lang.String,​ConflictManager> conflictsManager

      • latestStrategies

        private java.util.Map<java.lang.String,​LatestStrategy> latestStrategies

      • lockStrategies

        private java.util.Map<java.lang.String,​LockStrategy> lockStrategies

      • namespaces

        private java.util.Map<java.lang.String,​Namespace> namespaces

      • matchers

        private java.util.Map<java.lang.String,​PatternMatcher> matchers

      • reportOutputters

        private java.util.Map<java.lang.String,​ReportOutputter> reportOutputters

      • versionMatchers

        private java.util.Map<java.lang.String,​VersionMatcher> versionMatchers

      • circularDependencyStrategies

        private java.util.Map<java.lang.String,​CircularDependencyStrategy> circularDependencyStrategies

      • repositoryCacheManagers

        private java.util.Map<java.lang.String,​RepositoryCacheManager> repositoryCacheManagers

      • signatureGenerators

        private java.util.Map<java.lang.String,​SignatureGenerator> signatureGenerators

      • triggers

        private java.util.List<Trigger> triggers

      • validate

        private boolean validate

      • defaultLockStrategy

        private LockStrategy defaultLockStrategy

      • listingIgnore

        private java.util.List<java.lang.String> listingIgnore

      • repositoriesConfigured

        private boolean repositoriesConfigured

      • useRemoteConfig

        private boolean useRemoteConfig

      • defaultUserDir

        private java.io.File defaultUserDir

      • baseDir

        private java.io.File baseDir

      • classpathURLs

        private java.util.List<java.net.URL> classpathURLs

      • classloader

        private java.lang.ClassLoader classloader

      • debugConflictResolution

        private java.lang.Boolean debugConflictResolution

      • logNotConvertedExclusionRule

        private boolean logNotConvertedExclusionRule

      • debugLocking

        private java.lang.Boolean debugLocking

      • dumpMemoryUsage

        private java.lang.Boolean dumpMemoryUsage

      • defaultCacheIvyPattern

        private java.lang.String defaultCacheIvyPattern

      • defaultCacheArtifactPattern

        private java.lang.String defaultCacheArtifactPattern

      • defaultUseOrigin

        private boolean defaultUseOrigin

      • defaultResolveMode

        private java.lang.String defaultResolveMode

      • timeoutConstraints

        private final java.util.Map<java.lang.String,​TimeoutConstraint> timeoutConstraints

    • Constructor Detail

      • IvySettings

        public IvySettings()

    • Method Detail

      • addSystemProperties

        private void addSystemProperties()

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

      • defaultInit

        public void defaultInit()
                 throws java.io.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:
        java.io.IOException - if something goes wrong

      • 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

      • loadDefaultProperties

        private void loadDefaultProperties()
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • getDefaultPropertiesURL

        public static java.net.URL getDefaultPropertiesURL()

      • getDefaultSettingsURL

        public static java.net.URL getDefaultSettingsURL()

      • getDefault14SettingsURL

        public static java.net.URL getDefault14SettingsURL()

      • getDefaultSettingsDir

        private java.lang.String getDefaultSettingsDir()

      • getSettingsURL

        private static java.net.URL getSettingsURL​(java.lang.String file)

      • setSettingsVariables

        public void setSettingsVariables​(java.io.File settingsFile)

      • setDeprecatedVariable

        private void setDeprecatedVariable​(java.lang.String deprecatedKey,
                                   java.lang.String newKey)
        Sets a deprecated variable with the value of the new variable
        Parameters:
        deprecatedKey - the deprecated variable name
        newKey - the new variable name

      • setSettingsVariables

        public void setSettingsVariables​(java.net.URL settingsURL)

      • dumpSettings

        private void dumpSettings()

      • 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

      • loadProperties

        private void loadProperties​(java.io.InputStream stream,
                            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)

      • setVariable

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

      • 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 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 java.util.Map<java.lang.String,​java.lang.String> substitute​(java.util.Map<java.lang.String,​java.lang.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

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

      • classForName

        private java.lang.Class<?> classForName​(java.lang.String className,
                                        boolean silentFail)

      • getClassLoader

        private java.lang.ClassLoader getClassLoader()

      • addClasspathURL

        public void addClasspathURL​(java.net.URL url)

      • getTypeDefs

        public java.util.Map<java.lang.String,​java.lang.Class<?>> getTypeDefs()

      • getTypeDef

        public java.lang.Class<?> getTypeDef​(java.lang.String name)

      • addSignatureGenerator

        public void addSignatureGenerator​(SignatureGenerator generator)

      • setDefaultCache

        public void setDefaultCache​(java.io.File cacheDirectory)

      • setDefaultResolver

        public void setDefaultResolver​(java.lang.String resolverName)

      • checkResolverName

        private void checkResolverName​(java.lang.String resolverName)

      • addModuleConfiguration

        public void addModuleConfiguration​(java.util.Map<java.lang.String,​java.lang.String> 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
        Parameters:
        attributes - Map
        matcher - PatternMatcher
        resolverName - String
        branch - String
        conflictManager - String
        resolveMode - String

      • resolveFile

        public java.io.File resolveFile​(java.lang.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​(java.io.File baseDir)

      • getBaseDir

        public java.io.File getBaseDir()

      • getDefaultIvyUserDir

        public java.io.File getDefaultIvyUserDir()

      • setDefaultIvyUserDir

        public void setDefaultIvyUserDir​(java.io.File defaultUserDir)

      • getDefaultCache

        public java.io.File getDefaultCache()

      • setDefaultRepositoryCacheBasedir

        public void setDefaultRepositoryCacheBasedir​(java.lang.String repositoryCacheRoot)

      • setDefaultResolutionCacheBasedir

        public void setDefaultResolutionCacheBasedir​(java.lang.String resolutionCacheRoot)

      • getDefaultRepositoryCacheBasedir

        public java.io.File getDefaultRepositoryCacheBasedir()

      • getDefaultResolutionCacheBasedir

        public java.io.File getDefaultResolutionCacheBasedir()

      • hasResolver

        public boolean hasResolver​(java.lang.String resolverName)

      • getDefaultBranch

        public java.lang.String getDefaultBranch()

      • setDefaultBranch

        public void setDefaultBranch​(java.lang.String defaultBranch)

      • getDefaultResolveMode

        public java.lang.String getDefaultResolveMode()

      • setDefaultResolveMode

        public void setDefaultResolveMode​(java.lang.String defaultResolveMode)

      • addConflictManager

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

      • addConfigured

        public void addConfigured​(LatestStrategy latest)

      • addLatestStrategy

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

      • addConfigured

        public void addConfigured​(LockStrategy lockStrategy)

      • getLockStrategy

        public LockStrategy getLockStrategy​(java.lang.String name)

      • addLockStrategy

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

      • addConfigured

        public void addConfigured​(Namespace ns)

      • addNamespace

        public void addNamespace​(Namespace ns)

      • getReportOutputter

        public ReportOutputter getReportOutputter​(java.lang.String name)

      • addReportOutputter

        public void addReportOutputter​(ReportOutputter outputter)

      • addConfigured

        public void addConfigured​(VersionMatcher vmatcher)

      • getVersionMatcher

        public VersionMatcher getVersionMatcher​(java.lang.String name)

      • addVersionMatcher

        public void addVersionMatcher​(VersionMatcher vmatcher)

      • configureDefaultVersionMatcher

        public void configureDefaultVersionMatcher()

      • configureDefaultCircularDependencyStrategies

        private void configureDefaultCircularDependencyStrategies()

      • setStatusManager

        public void setStatusManager​(StatusManager statusManager)

      • getIgnorableFilenames

        public java.lang.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​(java.util.Collection<java.lang.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

      • setCheckUpToDate

        public void setCheckUpToDate​(boolean checkUpToDate)

      • setValidate

        public void setValidate​(boolean validate)

      • getVariableAsBoolean

        public boolean getVariableAsBoolean​(java.lang.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)

      • setDefaultLatestStrategy

        public void setDefaultLatestStrategy​(LatestStrategy defaultLatestStrategy)

      • getDefaultLockStrategy

        public LockStrategy getDefaultLockStrategy()

      • setDefaultLockStrategy

        public void setDefaultLockStrategy​(LockStrategy defaultLockStrategy)

      • setDefaultRepositoryCacheManager

        public void setDefaultRepositoryCacheManager​(RepositoryCacheManager cache)

      • setResolutionCacheManager

        public void setResolutionCacheManager​(ResolutionCacheManager resolutionCacheManager)

      • addTrigger

        public void addTrigger​(Trigger trigger)

      • getTriggers

        public java.util.List<Trigger> getTriggers()

      • addConfigured

        public void addConfigured​(Trigger trigger)

      • isUseRemoteConfig

        public boolean isUseRemoteConfig()

      • setUseRemoteConfig

        public void setUseRemoteConfig​(boolean useRemoteConfig)

      • logModulesInUse

        public boolean logModulesInUse()

      • debugLocking

        public boolean debugLocking()

      • init

        private void init​(java.lang.Object obj)

      • getInterruptTimeout

        public final long getInterruptTimeout()

      • setVariableContainer

        public void setVariableContainer​(IvyVariableContainer variables)
        Use a different variable container.
        Parameters:
        variables - IvyVariableContainer

      • setDefaultCacheIvyPattern

        public void setDefaultCacheIvyPattern​(java.lang.String defaultCacheIvyPattern)

      • getDefaultCacheIvyPattern

        public java.lang.String getDefaultCacheIvyPattern()

      • setDefaultCacheArtifactPattern

        public void setDefaultCacheArtifactPattern​(java.lang.String defaultCacheArtifactPattern)

      • getDefaultCacheArtifactPattern

        public java.lang.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:
        java.lang.IllegalStateException - if the settings is not valid.

      • validateAll

        private void validateAll​(java.util.Collection<?> values)
        Validates all Validatable objects in the collection.
        Parameters:
        values - the collection of objects to validate.
        Throws:
        java.lang.IllegalStateException - if any of the objects is not valid.

      • addConfigured

        public void addConfigured​(ArchivePacking packing)