org.apache.ivy.ant
Class IvyAntSettings

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by org.apache.ivy.ant.IvyAntSettings
All Implemented Interfaces:
java.lang.Cloneable
Direct Known Subclasses:
IvyConfigure

public class IvyAntSettings
extends org.apache.tools.ant.Task


Nested Class Summary
static class IvyAntSettings.Credentials
           
 
Field Summary
static java.lang.String OVERRIDE_FALSE
          Use to avoid overriding a previous definition of settings with the same id
static java.lang.String OVERRIDE_NOT_ALLOWED
          Use to raise an error if attempting to override a previous definition of settings with the same id
static java.lang.String OVERRIDE_TRUE
          Use to override a previous definition of settings with the same id
 
Fields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
 
Constructor Summary
IvyAntSettings()
           
 
Method Summary
 void addConfiguredCredentials(IvyAntSettings.Credentials c)
           
 void execute()
           
 Ivy getConfiguredIvyInstance()
          Return the configured Ivy instance.
static IvyAntSettings getDefaultInstance(org.apache.tools.ant.Project project)
          Returns the default ivy settings of this classloader.
protected  java.util.Properties getDefaultProperties()
           
 java.io.File getFile()
           
 java.lang.String getHost()
           
 java.lang.String getId()
           
 java.lang.String getPasswd()
           
 java.lang.String getRealm()
           
 java.net.URL getUrl()
           
 java.lang.String getUsername()
           
 void setFile(java.io.File file)
           
 void setHost(java.lang.String aHost)
           
 void setId(java.lang.String id)
           
 void setOverride(java.lang.String override)
           
 void setPasswd(java.lang.String aPasswd)
           
 void setRealm(java.lang.String aRealm)
           
 void setUrl(java.lang.String confUrl)
           
 void setUsername(java.lang.String aUserName)
           
 
Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OVERRIDE_TRUE

public static final java.lang.String OVERRIDE_TRUE
Use to override a previous definition of settings with the same id

See Also:
Constant Field Values

OVERRIDE_FALSE

public static final java.lang.String OVERRIDE_FALSE
Use to avoid overriding a previous definition of settings with the same id

See Also:
Constant Field Values

OVERRIDE_NOT_ALLOWED

public static final java.lang.String OVERRIDE_NOT_ALLOWED
Use to raise an error if attempting to override a previous definition of settings with the same id

See Also:
Constant Field Values
Constructor Detail

IvyAntSettings

public IvyAntSettings()
Method Detail

getDefaultInstance

public static IvyAntSettings getDefaultInstance(org.apache.tools.ant.Project project)
Returns the default ivy settings of this classloader. If it doesn't exist yet, a new one is created using the given project to back the VariableContainer.

Parameters:
project - TODO add text.
Returns:
An IvySetting instance.

getFile

public java.io.File getFile()

getUrl

public java.net.URL getUrl()

getPasswd

public java.lang.String getPasswd()

setPasswd

public void setPasswd(java.lang.String aPasswd)

getRealm

public java.lang.String getRealm()

setRealm

public void setRealm(java.lang.String aRealm)

getHost

public java.lang.String getHost()

setHost

public void setHost(java.lang.String aHost)

getUsername

public java.lang.String getUsername()

setUsername

public void setUsername(java.lang.String aUserName)

addConfiguredCredentials

public void addConfiguredCredentials(IvyAntSettings.Credentials c)

setFile

public void setFile(java.io.File file)

setUrl

public void setUrl(java.lang.String confUrl)
            throws java.net.MalformedURLException
Throws:
java.net.MalformedURLException

setOverride

public void setOverride(java.lang.String override)

setId

public void setId(java.lang.String id)

getId

public java.lang.String getId()

getConfiguredIvyInstance

public Ivy getConfiguredIvyInstance()
Return the configured Ivy instance.

Returns:
Returns the configured Ivy instance.

execute

public void execute()
             throws org.apache.tools.ant.BuildException
Overrides:
execute in class org.apache.tools.ant.Task
Throws:
org.apache.tools.ant.BuildException

getDefaultProperties

protected java.util.Properties getDefaultProperties()