Package org.apache.maven.archetype.common

Class DefaultArchetypeArtifactManager

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.archetype.common.DefaultArchetypeArtifactManager

All Implemented Interfaces:

ArchetypeArtifactManager, org.codehaus.plexus.logging.LogEnabled

@Component(role=ArchetypeArtifactManager.class)
public class DefaultArchetypeArtifactManager
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements ArchetypeArtifactManager

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Map<java.lang.String,java.io.File>	archetypeCache
private Downloader	downloader
private PomManager	pomManager

Fields inherited from interface org.apache.maven.archetype.common.ArchetypeArtifactManager

ROLE

Constructor Summary

Constructors

Constructor	Description
DefaultArchetypeArtifactManager()

Method Summary

Modifier and Type	Method	Description
boolean	exists(java.lang.String archetypeGroupId, java.lang.String archetypeArtifactId, java.lang.String archetypeVersion, org.apache.maven.artifact.repository.ArtifactRepository archetypeRepository, org.apache.maven.artifact.repository.ArtifactRepository localRepository, java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories, org.apache.maven.project.ProjectBuildingRequest buildingRequest)
private java.io.File	getArchetype(java.lang.String archetypeGroupId, java.lang.String archetypeArtifactId, java.lang.String archetypeVersion)
private java.io.Reader	getArchetypeDescriptorReader(java.util.zip.ZipFile zipFile)
java.io.File	getArchetypeFile(java.lang.String groupId, java.lang.String artifactId, java.lang.String version, org.apache.maven.artifact.repository.ArtifactRepository archetypeRepository, org.apache.maven.artifact.repository.ArtifactRepository localRepository, java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> repositories, org.apache.maven.project.ProjectBuildingRequest buildingRequest)
java.lang.ClassLoader	getArchetypeJarLoader(java.io.File archetypeFile)
org.apache.maven.model.Model	getArchetypePom(java.io.File jar)
java.util.zip.ZipFile	getArchetypeZipFile(java.io.File archetypeFile)
private java.io.Reader	getDescriptorReader(java.util.zip.ZipFile zipFile, java.lang.String descriptor)
ArchetypeDescriptor	getFileSetArchetypeDescriptor(java.io.File archetypeFile)
ArchetypeDescriptor	getFileSetArchetypeDescriptor(java.lang.String groupId, java.lang.String artifactId, java.lang.String version, org.apache.maven.artifact.repository.ArtifactRepository archetypeRepository, org.apache.maven.artifact.repository.ArtifactRepository localRepository, java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> repositories, org.apache.maven.project.ProjectBuildingRequest buildingRequest)
java.util.List<java.lang.String>	getFilesetArchetypeResources(java.io.File archetypeFile)
ArchetypeDescriptor	getOldArchetypeDescriptor(java.io.File archetypeFile)
ArchetypeDescriptor	getOldArchetypeDescriptor(java.lang.String groupId, java.lang.String artifactId, java.lang.String version, org.apache.maven.artifact.repository.ArtifactRepository archetypeRepository, org.apache.maven.artifact.repository.ArtifactRepository localRepository, java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> repositories, org.apache.maven.project.ProjectBuildingRequest buildingRequest)
private java.io.Reader	getOldArchetypeDescriptorReader(java.util.zip.ZipFile zipFile)
java.lang.String	getPostGenerationScript(java.io.File archetypeFile)	Get the archetype file's post-generation script content, read as UTF-8 content.
boolean	isFileSetArchetype(java.io.File archetypeFile)
boolean	isFileSetArchetype(java.lang.String groupId, java.lang.String artifactId, java.lang.String version, org.apache.maven.artifact.repository.ArtifactRepository archetypeRepository, org.apache.maven.artifact.repository.ArtifactRepository localRepository, java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> repositories, org.apache.maven.project.ProjectBuildingRequest buildingRequest)
private boolean	isFileSetArchetype(java.util.zip.ZipFile zipFile)
boolean	isOldArchetype(java.io.File archetypeFile)
boolean	isOldArchetype(java.lang.String groupId, java.lang.String artifactId, java.lang.String version, org.apache.maven.artifact.repository.ArtifactRepository archetypeRepository, org.apache.maven.artifact.repository.ArtifactRepository localRepository, java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> repositories, org.apache.maven.project.ProjectBuildingRequest buildingRequest)
private boolean	isOldArchetype(java.util.zip.ZipFile zipFile)
private ArchetypeDescriptor	loadFileSetArchetypeDescriptor(java.util.zip.ZipFile zipFile)
private ArchetypeDescriptor	loadOldArchetypeDescriptor(java.util.zip.ZipFile zipFile)
private java.util.zip.ZipEntry	searchEntry(java.util.zip.ZipFile zipFile, java.lang.String searchString)
private void	setArchetype(java.lang.String archetypeGroupId, java.lang.String archetypeArtifactId, java.lang.String archetypeVersion, java.io.File archetype)

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

downloader

@Requirement
private Downloader downloader

pomManager

@Requirement
private PomManager pomManager

archetypeCache

private java.util.Map<java.lang.String,java.io.File> archetypeCache

Constructor Detail

DefaultArchetypeArtifactManager

public DefaultArchetypeArtifactManager()

Method Detail

getArchetypeFile

public java.io.File getArchetypeFile(java.lang.String groupId,
                                     java.lang.String artifactId,
                                     java.lang.String version,
                                     org.apache.maven.artifact.repository.ArtifactRepository archetypeRepository,
                                     org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                                     java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> repositories,
                                     org.apache.maven.project.ProjectBuildingRequest buildingRequest)
                              throws UnknownArchetype

Specified by:

getArchetypeFile in interface ArchetypeArtifactManager

buildingRequest - TODO

Throws:

UnknownArchetype

getArchetypeJarLoader

public java.lang.ClassLoader getArchetypeJarLoader(java.io.File archetypeFile)
                                            throws UnknownArchetype

Specified by:

getArchetypeJarLoader in interface ArchetypeArtifactManager

Throws:

UnknownArchetype

getArchetypePom

public org.apache.maven.model.Model getArchetypePom(java.io.File jar)
                                             throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
                                                    UnknownArchetype,
                                                    java.io.IOException

Specified by:

getArchetypePom in interface ArchetypeArtifactManager

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

UnknownArchetype

java.io.IOException

getArchetypeZipFile

public java.util.zip.ZipFile getArchetypeZipFile(java.io.File archetypeFile)
                                          throws UnknownArchetype

Specified by:

getArchetypeZipFile in interface ArchetypeArtifactManager

Throws:

UnknownArchetype

isFileSetArchetype

public boolean isFileSetArchetype(java.io.File archetypeFile)

Specified by:

isFileSetArchetype in interface ArchetypeArtifactManager

isFileSetArchetype

public boolean isFileSetArchetype(java.lang.String groupId,
                                  java.lang.String artifactId,
                                  java.lang.String version,
                                  org.apache.maven.artifact.repository.ArtifactRepository archetypeRepository,
                                  org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                                  java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> repositories,
                                  org.apache.maven.project.ProjectBuildingRequest buildingRequest)

Specified by:

isFileSetArchetype in interface ArchetypeArtifactManager

buildingRequest - TODO

isOldArchetype

public boolean isOldArchetype(java.io.File archetypeFile)

Specified by:

isOldArchetype in interface ArchetypeArtifactManager

isOldArchetype

public boolean isOldArchetype(java.lang.String groupId,
                              java.lang.String artifactId,
                              java.lang.String version,
                              org.apache.maven.artifact.repository.ArtifactRepository archetypeRepository,
                              org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                              java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> repositories,
                              org.apache.maven.project.ProjectBuildingRequest buildingRequest)

Specified by:

isOldArchetype in interface ArchetypeArtifactManager

buildingRequest - TODO

exists

public boolean exists(java.lang.String archetypeGroupId,
                      java.lang.String archetypeArtifactId,
                      java.lang.String archetypeVersion,
                      org.apache.maven.artifact.repository.ArtifactRepository archetypeRepository,
                      org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                      java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories,
                      org.apache.maven.project.ProjectBuildingRequest buildingRequest)

Specified by:

exists in interface ArchetypeArtifactManager

buildingRequest - TODO

getPostGenerationScript

public java.lang.String getPostGenerationScript(java.io.File archetypeFile)
                                         throws UnknownArchetype

Description copied from interface: ArchetypeArtifactManager

Get the archetype file's post-generation script content, read as UTF-8 content.

Specified by:

getPostGenerationScript in interface ArchetypeArtifactManager

Parameters:

archetypeFile - the archetype file

Returns:

the archetype file's post-generation script content or null if there is no script in the archetype

Throws:

UnknownArchetype

getFileSetArchetypeDescriptor

public ArchetypeDescriptor getFileSetArchetypeDescriptor(java.io.File archetypeFile)
                                                  throws UnknownArchetype

Specified by:

getFileSetArchetypeDescriptor in interface ArchetypeArtifactManager

Throws:

UnknownArchetype

getFileSetArchetypeDescriptor

public ArchetypeDescriptor getFileSetArchetypeDescriptor(java.lang.String groupId,
                                                         java.lang.String artifactId,
                                                         java.lang.String version,
                                                         org.apache.maven.artifact.repository.ArtifactRepository archetypeRepository,
                                                         org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                                                         java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> repositories,
                                                         org.apache.maven.project.ProjectBuildingRequest buildingRequest)
                                                  throws UnknownArchetype

Specified by:

getFileSetArchetypeDescriptor in interface ArchetypeArtifactManager

buildingRequest - TODO

Throws:

UnknownArchetype

getFilesetArchetypeResources

public java.util.List<java.lang.String> getFilesetArchetypeResources(java.io.File archetypeFile)
                                                              throws UnknownArchetype

Specified by:

getFilesetArchetypeResources in interface ArchetypeArtifactManager

Throws:

UnknownArchetype

getOldArchetypeDescriptor

public ArchetypeDescriptor getOldArchetypeDescriptor(java.io.File archetypeFile)
                                              throws UnknownArchetype

Specified by:

getOldArchetypeDescriptor in interface ArchetypeArtifactManager

Throws:

UnknownArchetype

getOldArchetypeDescriptor

public ArchetypeDescriptor getOldArchetypeDescriptor(java.lang.String groupId,
                                                     java.lang.String artifactId,
                                                     java.lang.String version,
                                                     org.apache.maven.artifact.repository.ArtifactRepository archetypeRepository,
                                                     org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                                                     java.util.List<org.apache.maven.artifact.repository.ArtifactRepository> repositories,
                                                     org.apache.maven.project.ProjectBuildingRequest buildingRequest)
                                              throws UnknownArchetype

Specified by:

getOldArchetypeDescriptor in interface ArchetypeArtifactManager

buildingRequest - TODO

Throws:

UnknownArchetype

getArchetype

private java.io.File getArchetype(java.lang.String archetypeGroupId,
                                  java.lang.String archetypeArtifactId,
                                  java.lang.String archetypeVersion)

setArchetype

private void setArchetype(java.lang.String archetypeGroupId,
                          java.lang.String archetypeArtifactId,
                          java.lang.String archetypeVersion,
                          java.io.File archetype)

isFileSetArchetype

private boolean isFileSetArchetype(java.util.zip.ZipFile zipFile)
                            throws java.io.IOException

Throws:

java.io.IOException

isOldArchetype

private boolean isOldArchetype(java.util.zip.ZipFile zipFile)
                        throws java.io.IOException

Throws:

java.io.IOException

loadFileSetArchetypeDescriptor

private ArchetypeDescriptor loadFileSetArchetypeDescriptor(java.util.zip.ZipFile zipFile)
                                                    throws java.io.IOException,
                                                           org.codehaus.plexus.util.xml.pull.XmlPullParserException

Throws:

java.io.IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

loadOldArchetypeDescriptor

private ArchetypeDescriptor loadOldArchetypeDescriptor(java.util.zip.ZipFile zipFile)
                                                throws java.io.IOException,
                                                       org.codehaus.plexus.util.xml.pull.XmlPullParserException

Throws:

java.io.IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

getArchetypeDescriptorReader

private java.io.Reader getArchetypeDescriptorReader(java.util.zip.ZipFile zipFile)
                                             throws java.io.IOException

Throws:

java.io.IOException

getOldArchetypeDescriptorReader

private java.io.Reader getOldArchetypeDescriptorReader(java.util.zip.ZipFile zipFile)
                                                throws java.io.IOException

Throws:

java.io.IOException

getDescriptorReader

private java.io.Reader getDescriptorReader(java.util.zip.ZipFile zipFile,
                                           java.lang.String descriptor)
                                    throws java.io.IOException

Throws:

java.io.IOException

searchEntry

private java.util.zip.ZipEntry searchEntry(java.util.zip.ZipFile zipFile,
                                           java.lang.String searchString)