org.apache.maven.embedder

Class MavenEmbedder

java.lang.Object

org.apache.maven.embedder.MavenEmbedder

public class MavenEmbedder
extends Object

Class intended to be used by clients who wish to embed Maven into their applications

Author:

Jason van Zyl

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LAYOUT_ID
static String	DEFAULT_LOCAL_REPO_ID
static String	userHome

Constructor Summary

Constructors

Constructor and Description
MavenEmbedder()

Method Summary

Methods

Modifier and Type	Method and Description
List	collectProjects(File basedir, String[] includes, String[] excludes)
org.apache.maven.artifact.Artifact	createArtifact(String groupId, String artifactId, String version, String scope, String type)
org.apache.maven.artifact.Artifact	createArtifactWithClassifier(String groupId, String artifactId, String version, String type, String classifier)
org.apache.maven.artifact.repository.ArtifactRepository	createLocalRepository(File localRepository)
org.apache.maven.artifact.repository.ArtifactRepository	createLocalRepository(org.apache.maven.settings.Settings settings)
org.apache.maven.artifact.repository.ArtifactRepository	createLocalRepository(String url, String repositoryId)
org.apache.maven.artifact.repository.ArtifactRepository	createRepository(String url, String repositoryId)
void	execute(List projects, List goals, org.apache.maven.monitor.event.EventMonitor eventMonitor, org.apache.maven.wagon.events.TransferListener transferListener, Properties properties, File executionRootDirectory)
void	execute(org.apache.maven.project.MavenProject project, List goals, org.apache.maven.monitor.event.EventMonitor eventMonitor, org.apache.maven.wagon.events.TransferListener transferListener, Properties properties, File executionRootDirectory)
List	getAvailablePlugins()
ClassLoader	getClassLoader()
String	getGlobalChecksumPolicy()
List	getLifecyclePhases()
org.apache.maven.artifact.repository.ArtifactRepository	getLocalRepository()
File	getLocalRepositoryDirectory()
MavenEmbedderLogger	getLogger()
org.apache.maven.plugin.descriptor.PluginDescriptor	getPluginDescriptor(SummaryPluginDescriptor summaryPluginDescriptor)
boolean	isAlignWithUserInstallation()
boolean	isInteractiveMode()
boolean	isOffline()
org.apache.maven.model.Model	readModel(File model)
org.apache.maven.project.MavenProject	readProject(File mavenProject)
org.apache.maven.project.MavenProject	readProjectWithDependencies(File mavenProject)
org.apache.maven.project.MavenProject	readProjectWithDependencies(File mavenProject, org.apache.maven.wagon.events.TransferListener transferListener)
void	resolve(org.apache.maven.artifact.Artifact artifact, List remoteRepositories, org.apache.maven.artifact.repository.ArtifactRepository localRepository)
void	setAlignWithUserInstallation(boolean alignWithUserInstallation)
void	setClassLoader(ClassLoader classLoader) Set the classloader to use with the maven embedder.
void	setGlobalChecksumPolicy(String globalChecksumPolicy)
void	setInteractiveMode(boolean interactiveMode)
void	setLocalRepositoryDirectory(File localRepositoryDirectory)
void	setLogger(MavenEmbedderLogger logger)
void	setOffline(boolean offline)
void	start()
void	stop()
void	writeModel(Writer writer, org.apache.maven.model.Model model)

Methods inherited from class java.lang.Object

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

Field Detail

userHome

public static final String userHome

DEFAULT_LOCAL_REPO_ID

public static final String DEFAULT_LOCAL_REPO_ID

See Also:

Constant Field Values

DEFAULT_LAYOUT_ID

public static final String DEFAULT_LAYOUT_ID

See Also:

Constant Field Values

Constructor Detail

MavenEmbedder

public MavenEmbedder()

Method Detail

setInteractiveMode

public void setInteractiveMode(boolean interactiveMode)

isInteractiveMode

public boolean isInteractiveMode()

setOffline

public void setOffline(boolean offline)

isOffline

public boolean isOffline()

setGlobalChecksumPolicy

public void setGlobalChecksumPolicy(String globalChecksumPolicy)

getGlobalChecksumPolicy

public String getGlobalChecksumPolicy()

isAlignWithUserInstallation

public boolean isAlignWithUserInstallation()

setAlignWithUserInstallation

public void setAlignWithUserInstallation(boolean alignWithUserInstallation)

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Set the classloader to use with the maven embedder.

Parameters:

classLoader -

getClassLoader

public ClassLoader getClassLoader()

setLocalRepositoryDirectory

public void setLocalRepositoryDirectory(File localRepositoryDirectory)

getLocalRepositoryDirectory

public File getLocalRepositoryDirectory()

getLocalRepository

public org.apache.maven.artifact.repository.ArtifactRepository getLocalRepository()

getLogger

public MavenEmbedderLogger getLogger()

setLogger

public void setLogger(MavenEmbedderLogger logger)

readModel

public org.apache.maven.model.Model readModel(File model)
                                       throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
                                              FileNotFoundException,
                                              IOException

Throws:

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

FileNotFoundException

IOException

writeModel

public void writeModel(Writer writer,
              org.apache.maven.model.Model model)
                throws IOException

Throws:

IOException

readProject

public org.apache.maven.project.MavenProject readProject(File mavenProject)
                                                  throws org.apache.maven.project.ProjectBuildingException

Throws:

org.apache.maven.project.ProjectBuildingException

readProjectWithDependencies

public org.apache.maven.project.MavenProject readProjectWithDependencies(File mavenProject,
                                                                org.apache.maven.wagon.events.TransferListener transferListener)
                                                                  throws org.apache.maven.project.ProjectBuildingException,
                                                                         org.apache.maven.artifact.resolver.ArtifactResolutionException,
                                                                         org.apache.maven.artifact.resolver.ArtifactNotFoundException

Throws:

org.apache.maven.project.ProjectBuildingException

org.apache.maven.artifact.resolver.ArtifactResolutionException

org.apache.maven.artifact.resolver.ArtifactNotFoundException

readProjectWithDependencies

public org.apache.maven.project.MavenProject readProjectWithDependencies(File mavenProject)
                                                                  throws org.apache.maven.project.ProjectBuildingException,
                                                                         org.apache.maven.artifact.resolver.ArtifactResolutionException,
                                                                         org.apache.maven.artifact.resolver.ArtifactNotFoundException

Throws:

org.apache.maven.project.ProjectBuildingException

org.apache.maven.artifact.resolver.ArtifactResolutionException

org.apache.maven.artifact.resolver.ArtifactNotFoundException

collectProjects

public List collectProjects(File basedir,
                   String[] includes,
                   String[] excludes)
                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

createArtifact

public org.apache.maven.artifact.Artifact createArtifact(String groupId,
                                                String artifactId,
                                                String version,
                                                String scope,
                                                String type)

createArtifactWithClassifier

public org.apache.maven.artifact.Artifact createArtifactWithClassifier(String groupId,
                                                              String artifactId,
                                                              String version,
                                                              String type,
                                                              String classifier)

resolve

public void resolve(org.apache.maven.artifact.Artifact artifact,
           List remoteRepositories,
           org.apache.maven.artifact.repository.ArtifactRepository localRepository)
             throws org.apache.maven.artifact.resolver.ArtifactResolutionException,
                    org.apache.maven.artifact.resolver.ArtifactNotFoundException

Throws:

org.apache.maven.artifact.resolver.ArtifactResolutionException

org.apache.maven.artifact.resolver.ArtifactNotFoundException

getAvailablePlugins

public List getAvailablePlugins()

getPluginDescriptor

public org.apache.maven.plugin.descriptor.PluginDescriptor getPluginDescriptor(SummaryPluginDescriptor summaryPluginDescriptor)
                                                                        throws MavenEmbedderException

Throws:

MavenEmbedderException

execute

public void execute(org.apache.maven.project.MavenProject project,
           List goals,
           org.apache.maven.monitor.event.EventMonitor eventMonitor,
           org.apache.maven.wagon.events.TransferListener transferListener,
           Properties properties,
           File executionRootDirectory)
             throws org.codehaus.plexus.util.dag.CycleDetectedException,
                    org.apache.maven.lifecycle.LifecycleExecutionException,
                    org.apache.maven.BuildFailureException,
                    org.apache.maven.project.DuplicateProjectException,
                    org.apache.maven.project.MissingProjectException

Throws:

org.codehaus.plexus.util.dag.CycleDetectedException

org.apache.maven.lifecycle.LifecycleExecutionException

org.apache.maven.BuildFailureException

org.apache.maven.project.DuplicateProjectException

org.apache.maven.project.MissingProjectException

execute

public void execute(List projects,
           List goals,
           org.apache.maven.monitor.event.EventMonitor eventMonitor,
           org.apache.maven.wagon.events.TransferListener transferListener,
           Properties properties,
           File executionRootDirectory)
             throws org.codehaus.plexus.util.dag.CycleDetectedException,
                    org.apache.maven.lifecycle.LifecycleExecutionException,
                    org.apache.maven.BuildFailureException,
                    org.apache.maven.project.DuplicateProjectException,
                    org.apache.maven.project.MissingProjectException

Throws:

org.codehaus.plexus.util.dag.CycleDetectedException

org.apache.maven.lifecycle.LifecycleExecutionException

org.apache.maven.BuildFailureException

org.apache.maven.project.DuplicateProjectException

org.apache.maven.project.MissingProjectException

getLifecyclePhases

public List getLifecyclePhases()
                        throws MavenEmbedderException

Throws:

MavenEmbedderException

createLocalRepository

public org.apache.maven.artifact.repository.ArtifactRepository createLocalRepository(File localRepository)
                                                                              throws org.codehaus.plexus.component.repository.exception.ComponentLookupException

Throws:

org.codehaus.plexus.component.repository.exception.ComponentLookupException

createLocalRepository

public org.apache.maven.artifact.repository.ArtifactRepository createLocalRepository(org.apache.maven.settings.Settings settings)
                                                                              throws org.codehaus.plexus.component.repository.exception.ComponentLookupException

Throws:

org.codehaus.plexus.component.repository.exception.ComponentLookupException

createLocalRepository

public org.apache.maven.artifact.repository.ArtifactRepository createLocalRepository(String url,
                                                                            String repositoryId)
                                                                              throws org.codehaus.plexus.component.repository.exception.ComponentLookupException

Throws:

org.codehaus.plexus.component.repository.exception.ComponentLookupException

createRepository

public org.apache.maven.artifact.repository.ArtifactRepository createRepository(String url,
                                                                       String repositoryId)
                                                                         throws org.codehaus.plexus.component.repository.exception.ComponentLookupException

Throws:

org.codehaus.plexus.component.repository.exception.ComponentLookupException

start

public void start()
           throws MavenEmbedderException

Throws:

MavenEmbedderException

stop

public void stop()
          throws MavenEmbedderException

Throws:

MavenEmbedderException