Package org.apache.ivy.ant

Class IvyArtifactReport

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.ivy.ant.IvyTask

org.apache.ivy.ant.IvyPostResolveTask

org.apache.ivy.ant.IvyArtifactReport

All Implemented Interfaces:

java.lang.Cloneable

public class IvyArtifactReport
extends IvyPostResolveTask

Generates a report of all artifacts involved during the last resolve.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	pattern
private java.io.File	tofile

Fields inherited from class org.apache.ivy.ant.IvyTask

ANT_PROJECT_CONTEXT_KEY

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

Constructors

Constructor	Description
IvyArtifactReport()

Method Summary

Modifier and Type	Method	Description
private javax.xml.transform.sax.TransformerHandler	createTransformerHandler(java.io.FileOutputStream fileOutputStream)
void	doExecute()	The real logic of task execution after project has been set in the context.
private void	generateXml(IvyNode[] dependencies, java.util.Map<ModuleRevisionId,java.util.Set<ArtifactDownloadReport>> moduleRevToArtifactsMap, java.util.Map<ArtifactDownloadReport,java.util.Set<java.lang.String>> artifactsToCopy)
java.lang.String	getPattern()
java.io.File	getTofile()
java.lang.String	removeLeadingPath(java.io.File leading, java.io.File path)
void	setPattern(java.lang.String aPattern)
void	setTofile(java.io.File aFile)
private void	startArtifact(javax.xml.transform.sax.TransformerHandler saxHandler, Artifact artifact)
private void	startModule(javax.xml.transform.sax.TransformerHandler saxHandler, IvyNode dependency)
private void	writeCacheLocationIfPresent(RepositoryCacheManager cache, javax.xml.transform.sax.TransformerHandler saxHandler, ArtifactDownloadReport artifact)
private void	writeOriginLocationIfPresent(RepositoryCacheManager cache, javax.xml.transform.sax.TransformerHandler saxHandler, ArtifactDownloadReport artifact)
private void	writeRetrieveLocation(javax.xml.transform.sax.TransformerHandler saxHandler, java.lang.String artifactDestPath)

Methods inherited from class org.apache.ivy.ant.IvyPostResolveTask

createConflict, createDependency, createExclude, ensureResolved, getArtifactFilter, getBranch, getConf, getConfsToResolve, getConfsToResolve, getFile, getLog, getModule, getOrganisation, getResolvedModuleId, getResolvedMrid, getResolvedReport, getResolveId, getResolveMode, getRevision, getType, isChanging, isHaltonfailure, isInline, isKeep, isRefresh, isTransitive, isUseOrigin, prepareAndCheck, setBranch, setCache, setChanging, setConf, setFile, setHaltonfailure, setInline, setKeep, setLog, setModule, setOrganisation, setRefresh, setResolveId, setResolveMode, setRevision, setTransitive, setType, setupResolve, setUseOrigin

Methods inherited from class org.apache.ivy.ant.IvyTask

cacheAttributeNotSupported, doValidate, execute, finalizeTask, getIvyInstance, getProperty, getProperty, getProperty, getProperty, getPubDate, getResolvedConfigurations, getResolvedDescriptor, getResolvedDescriptor, getResolvedDescriptor, getResolvedDescriptor, getResolvedReport, getSettings, getSettingsRef, isValidate, mergeConfs, prepareTask, setResolved, setResolved, setSettingsRef, setValidate, splitConfs, toString

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, wait, wait, wait

Field Detail

tofile

private java.io.File tofile

pattern

private java.lang.String pattern

Constructor Detail

IvyArtifactReport

public IvyArtifactReport()

Method Detail

getTofile

public java.io.File getTofile()

setTofile

public void setTofile(java.io.File aFile)

getPattern

public java.lang.String getPattern()

setPattern

public void setPattern(java.lang.String aPattern)

doExecute

public void doExecute()
               throws org.apache.tools.ant.BuildException

Description copied from class: IvyTask

The real logic of task execution after project has been set in the context. MUST be implemented by subclasses

Specified by:

doExecute in class IvyTask

Throws:

org.apache.tools.ant.BuildException - if something goes wrong

generateXml

private void generateXml(IvyNode[] dependencies,
                         java.util.Map<ModuleRevisionId,java.util.Set<ArtifactDownloadReport>> moduleRevToArtifactsMap,
                         java.util.Map<ArtifactDownloadReport,java.util.Set<java.lang.String>> artifactsToCopy)

createTransformerHandler

private javax.xml.transform.sax.TransformerHandler createTransformerHandler(java.io.FileOutputStream fileOutputStream)
                                                                     throws javax.xml.transform.TransformerFactoryConfigurationError,
                                                                            javax.xml.transform.TransformerConfigurationException

Throws:

javax.xml.transform.TransformerFactoryConfigurationError

javax.xml.transform.TransformerConfigurationException

startModule

private void startModule(javax.xml.transform.sax.TransformerHandler saxHandler,
                         IvyNode dependency)
                  throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

startArtifact

private void startArtifact(javax.xml.transform.sax.TransformerHandler saxHandler,
                           Artifact artifact)
                    throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

writeOriginLocationIfPresent

private void writeOriginLocationIfPresent(RepositoryCacheManager cache,
                                          javax.xml.transform.sax.TransformerHandler saxHandler,
                                          ArtifactDownloadReport artifact)
                                   throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

writeCacheLocationIfPresent

private void writeCacheLocationIfPresent(RepositoryCacheManager cache,
                                         javax.xml.transform.sax.TransformerHandler saxHandler,
                                         ArtifactDownloadReport artifact)
                                  throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

writeRetrieveLocation

private void writeRetrieveLocation(javax.xml.transform.sax.TransformerHandler saxHandler,
                                   java.lang.String artifactDestPath)
                            throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

removeLeadingPath

public java.lang.String removeLeadingPath(java.io.File leading,
                                          java.io.File path)