public interface IMaven
Unless specified otherwise or implied by method parameters, IMaven methods will join IMavenExecutionContext
associated with the current thread or create new default IMavenExecutionContext.
| Modifier and Type | Method and Description |
|---|---|
void |
addLocalRepositoryListener(ILocalRepositoryListener listener) |
void |
addSettingsChangeListener(ISettingsChangeListener listener) |
org.apache.maven.settings.Settings |
buildSettings(String globalSettings,
String userSettings) |
org.apache.maven.lifecycle.MavenExecutionPlan |
calculateExecutionPlan(org.apache.maven.project.MavenProject project,
List<String> goals,
boolean setup,
org.eclipse.core.runtime.IProgressMonitor monitor) |
org.apache.maven.lifecycle.MavenExecutionPlan |
calculateExecutionPlan(org.apache.maven.execution.MavenSession session,
org.apache.maven.project.MavenProject project,
List<String> goals,
boolean setup,
org.eclipse.core.runtime.IProgressMonitor monitor)
Deprecated.
this method does not properly join
IMavenExecutionContext, use
calculateExecutionPlan(MavenProject, List, boolean, IProgressMonitor) instead. |
org.apache.maven.artifact.repository.ArtifactRepository |
createArtifactRepository(String id,
String url) |
IMavenExecutionContext |
createExecutionContext()
Creates and returns new, possibly nested, maven execution context.
|
org.apache.maven.execution.MavenExecutionRequest |
createExecutionRequest(org.eclipse.core.runtime.IProgressMonitor monitor)
Deprecated.
|
org.apache.maven.execution.MavenSession |
createSession(org.apache.maven.execution.MavenExecutionRequest request,
org.apache.maven.project.MavenProject project)
Deprecated.
this method does not properly join
IMavenExecutionContext |
org.apache.maven.wagon.events.TransferListener |
createTransferListener(org.eclipse.core.runtime.IProgressMonitor monitor)
Deprecated.
IMaven API should not expose maven.repository.ArtifactTransferListener
|
org.apache.maven.settings.Server |
decryptPassword(org.apache.maven.settings.Server server) |
void |
detachFromSession(org.apache.maven.project.MavenProject project)
Makes MavenProject instances returned by #readProject methods suitable for caching and reuse with other
MavenSession instances.
Do note that MavenProject.getParentProject() cannot be used for detached MavenProject instances, #resolveParentProject to read parent project instance. |
<V> V |
execute(boolean offline,
boolean forceDependencyUpdate,
ICallable<V> callable,
org.eclipse.core.runtime.IProgressMonitor monitor)
This is convenience method fully equivalent to
|
<V> V |
execute(ICallable<V> callable,
org.eclipse.core.runtime.IProgressMonitor monitor)
Either joins existing session or starts new session with default configuration and executes the callable in the
context of the session.
|
org.apache.maven.execution.MavenExecutionResult |
execute(org.apache.maven.execution.MavenExecutionRequest request,
org.eclipse.core.runtime.IProgressMonitor monitor)
Deprecated.
this method does not properly join
IMavenExecutionContext |
void |
execute(org.apache.maven.project.MavenProject project,
org.apache.maven.plugin.MojoExecution execution,
org.eclipse.core.runtime.IProgressMonitor monitor) |
void |
execute(org.apache.maven.execution.MavenSession session,
org.apache.maven.plugin.MojoExecution execution,
org.eclipse.core.runtime.IProgressMonitor monitor)
Deprecated.
this method does not properly join
IMavenExecutionContext, use
#execute(MojoExecution, IProgressMonitor) instead. |
String |
getArtifactPath(org.apache.maven.artifact.repository.ArtifactRepository repository,
String groupId,
String artifactId,
String version,
String type,
String classifier)
Returns path of the specified artifact relative to repository baseDir.
|
List<org.apache.maven.artifact.repository.ArtifactRepository> |
getArtifactRepositories()
Convenience method, fully equivalent to getArtifactRepositories(true)
|
List<org.apache.maven.artifact.repository.ArtifactRepository> |
getArtifactRepositories(boolean injectSettings)
Returns list of remote artifact repositories configured in settings.xml.
|
<T> T |
getConfiguredMojo(org.apache.maven.execution.MavenSession session,
org.apache.maven.plugin.MojoExecution mojoExecution,
Class<T> clazz)
Returns new mojo instances configured according to provided mojoExecution.
|
IMavenExecutionContext |
getExecutionContext()
Returns execution context associated with the current thread or
null if the current thread does not
have associated maven execution context. |
org.apache.maven.artifact.repository.ArtifactRepository |
getLocalRepository() |
String |
getLocalRepositoryPath() |
org.apache.maven.settings.Mirror |
getMirror(org.apache.maven.artifact.repository.ArtifactRepository repo) |
List<org.apache.maven.settings.Mirror> |
getMirrors() |
<T> T |
getMojoParameterValue(org.apache.maven.project.MavenProject project,
org.apache.maven.plugin.MojoExecution mojoExecution,
String parameter,
Class<T> asType,
org.eclipse.core.runtime.IProgressMonitor monitor) |
<T> T |
getMojoParameterValue(org.apache.maven.project.MavenProject project,
String parameter,
Class<T> type,
org.apache.maven.model.Plugin plugin,
org.apache.maven.model.ConfigurationContainer configuration,
String goal,
org.eclipse.core.runtime.IProgressMonitor monitor) |
<T> T |
getMojoParameterValue(org.apache.maven.execution.MavenSession session,
org.apache.maven.plugin.MojoExecution mojoExecution,
String parameter,
Class<T> asType)
Deprecated.
this method does not properly join
IMavenExecutionContext, use
#getMojoParameterValue(MojoExecution, String, Class) instead. |
<T> T |
getMojoParameterValue(String parameter,
Class<T> type,
org.apache.maven.execution.MavenSession session,
org.apache.maven.model.Plugin plugin,
org.apache.maven.model.ConfigurationContainer configuration,
String goal)
Deprecated.
this method does not properly join
IMavenExecutionContext, use
#getMojoParameterValue(String, Class, Plugin, ConfigurationContainer, String) instead. |
List<org.apache.maven.artifact.repository.ArtifactRepository> |
getPluginArtifactRepositories() |
List<org.apache.maven.artifact.repository.ArtifactRepository> |
getPluginArtifactRepositories(boolean injectSettings) |
ClassLoader |
getProjectRealm(org.apache.maven.project.MavenProject project)
Gets class realm of the specified project.
|
org.apache.maven.wagon.proxy.ProxyInfo |
getProxyInfo(String protocol) |
org.apache.maven.settings.Settings |
getSettings()
TODO should we expose Settings or provide access to servers and proxies instead?
|
List<org.apache.maven.project.MavenProject> |
getSortedProjects(List<org.apache.maven.project.MavenProject> projects)
Sort projects by build order
|
boolean |
isUnavailable(String groupId,
String artifactId,
String version,
String type,
String classifier,
List<org.apache.maven.artifact.repository.ArtifactRepository> repositories)
Returns true if the artifact does NOT exist in the local repository and known to be UNavailable from all specified
repositories.
|
<T> T |
lookup(Class<T> clazz)
Lookup a component from the embedded PlexusContainer.
|
void |
populateDefaults(org.apache.maven.execution.MavenExecutionRequest request) |
org.apache.maven.execution.MavenExecutionResult |
readMavenProject(File pomFile,
org.apache.maven.project.ProjectBuildingRequest configuration) |
org.apache.maven.model.Model |
readModel(File pomFile) |
org.apache.maven.model.Model |
readModel(InputStream in) |
org.apache.maven.project.MavenProject |
readProject(File pomFile,
org.eclipse.core.runtime.IProgressMonitor monitor) |
org.apache.maven.execution.MavenExecutionResult |
readProject(org.apache.maven.execution.MavenExecutionRequest request,
org.eclipse.core.runtime.IProgressMonitor monitor)
Deprecated.
this method does not properly join
IMavenExecutionContext, use
#readMavenProject(File, IProgressMonitor) instead. |
void |
releaseMojo(Object mojo,
org.apache.maven.plugin.MojoExecution mojoExecution)
Releases resources used by Mojo acquired with
getConfiguredMojo(MavenSession, MojoExecution, Class) |
void |
reloadSettings() |
void |
removeLocalRepositoryListener(ILocalRepositoryListener listener) |
void |
removeSettingsChangeListener(ISettingsChangeListener listener) |
org.apache.maven.artifact.Artifact |
resolve(String groupId,
String artifactId,
String version,
String type,
String classifier,
List<org.apache.maven.artifact.repository.ArtifactRepository> artifactRepositories,
org.eclipse.core.runtime.IProgressMonitor monitor)
Resolves specified artifact from specified remote repositories.
|
org.apache.maven.project.MavenProject |
resolveParentProject(org.apache.maven.execution.MavenExecutionRequest request,
org.apache.maven.project.MavenProject project,
org.eclipse.core.runtime.IProgressMonitor monitor)
Deprecated.
this method does not properly join
IMavenExecutionContext, use
resolveParentProject(MavenProject, IProgressMonitor) instead. |
org.apache.maven.project.MavenProject |
resolveParentProject(org.apache.maven.project.MavenProject project,
org.eclipse.core.runtime.IProgressMonitor monitor) |
String |
resolvePluginVersion(String groupId,
String artifactId,
org.apache.maven.execution.MavenSession session) |
org.apache.maven.plugin.MojoExecution |
setupMojoExecution(org.apache.maven.project.MavenProject project,
org.apache.maven.plugin.MojoExecution execution,
org.eclipse.core.runtime.IProgressMonitor monitor) |
org.apache.maven.plugin.MojoExecution |
setupMojoExecution(org.apache.maven.execution.MavenSession session,
org.apache.maven.project.MavenProject project,
org.apache.maven.plugin.MojoExecution execution)
Deprecated.
this method does not properly join
IMavenExecutionContext, use
#setupMojoExecution(MavenProject, MojoExecution) instead. |
List<org.apache.maven.settings.building.SettingsProblem> |
validateSettings(String settings) |
void |
writeModel(org.apache.maven.model.Model model,
OutputStream out) |
void |
writeSettings(org.apache.maven.settings.Settings settings,
OutputStream out) |
org.apache.maven.execution.MavenExecutionRequest createExecutionRequest(org.eclipse.core.runtime.IProgressMonitor monitor)
throws org.eclipse.core.runtime.CoreException
IMavenExecutionContext.org.eclipse.core.runtime.CoreExceptionorg.apache.maven.model.Model readModel(InputStream in) throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionorg.apache.maven.model.Model readModel(File pomFile) throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionvoid writeModel(org.apache.maven.model.Model model,
OutputStream out)
throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionorg.apache.maven.artifact.Artifact resolve(String groupId, String artifactId, String version, String type, String classifier, List<org.apache.maven.artifact.repository.ArtifactRepository> artifactRepositories, org.eclipse.core.runtime.IProgressMonitor monitor) throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreException - if the artifact cannot be resolved.String getArtifactPath(org.apache.maven.artifact.repository.ArtifactRepository repository, String groupId, String artifactId, String version, String type, String classifier) throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionboolean isUnavailable(String groupId, String artifactId, String version, String type, String classifier, List<org.apache.maven.artifact.repository.ArtifactRepository> repositories) throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionorg.apache.maven.project.MavenProject readProject(File pomFile, org.eclipse.core.runtime.IProgressMonitor monitor) throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionorg.apache.maven.execution.MavenExecutionResult readProject(org.apache.maven.execution.MavenExecutionRequest request,
org.eclipse.core.runtime.IProgressMonitor monitor)
throws org.eclipse.core.runtime.CoreException
IMavenExecutionContext, use
#readMavenProject(File, IProgressMonitor) instead.org.eclipse.core.runtime.CoreExceptionorg.apache.maven.execution.MavenExecutionResult readMavenProject(File pomFile, org.apache.maven.project.ProjectBuildingRequest configuration) throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionvoid detachFromSession(org.apache.maven.project.MavenProject project)
throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionorg.apache.maven.project.MavenProject resolveParentProject(org.apache.maven.execution.MavenExecutionRequest request,
org.apache.maven.project.MavenProject project,
org.eclipse.core.runtime.IProgressMonitor monitor)
throws org.eclipse.core.runtime.CoreException
IMavenExecutionContext, use
resolveParentProject(MavenProject, IProgressMonitor) instead.org.eclipse.core.runtime.CoreExceptionorg.apache.maven.project.MavenProject resolveParentProject(org.apache.maven.project.MavenProject project,
org.eclipse.core.runtime.IProgressMonitor monitor)
throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionorg.apache.maven.execution.MavenExecutionResult execute(org.apache.maven.execution.MavenExecutionRequest request,
org.eclipse.core.runtime.IProgressMonitor monitor)
IMavenExecutionContextorg.apache.maven.execution.MavenSession createSession(org.apache.maven.execution.MavenExecutionRequest request,
org.apache.maven.project.MavenProject project)
IMavenExecutionContextvoid execute(org.apache.maven.execution.MavenSession session,
org.apache.maven.plugin.MojoExecution execution,
org.eclipse.core.runtime.IProgressMonitor monitor)
IMavenExecutionContext, use
#execute(MojoExecution, IProgressMonitor) instead.void execute(org.apache.maven.project.MavenProject project,
org.apache.maven.plugin.MojoExecution execution,
org.eclipse.core.runtime.IProgressMonitor monitor)
throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionorg.apache.maven.lifecycle.MavenExecutionPlan calculateExecutionPlan(org.apache.maven.execution.MavenSession session,
org.apache.maven.project.MavenProject project,
List<String> goals,
boolean setup,
org.eclipse.core.runtime.IProgressMonitor monitor)
throws org.eclipse.core.runtime.CoreException
IMavenExecutionContext, use
calculateExecutionPlan(MavenProject, List, boolean, IProgressMonitor) instead.org.eclipse.core.runtime.CoreExceptionorg.apache.maven.lifecycle.MavenExecutionPlan calculateExecutionPlan(org.apache.maven.project.MavenProject project,
List<String> goals,
boolean setup,
org.eclipse.core.runtime.IProgressMonitor monitor)
throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionorg.apache.maven.plugin.MojoExecution setupMojoExecution(org.apache.maven.execution.MavenSession session,
org.apache.maven.project.MavenProject project,
org.apache.maven.plugin.MojoExecution execution)
throws org.eclipse.core.runtime.CoreException
IMavenExecutionContext, use
#setupMojoExecution(MavenProject, MojoExecution) instead.org.eclipse.core.runtime.CoreExceptionorg.apache.maven.plugin.MojoExecution setupMojoExecution(org.apache.maven.project.MavenProject project,
org.apache.maven.plugin.MojoExecution execution,
org.eclipse.core.runtime.IProgressMonitor monitor)
throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreException<T> T getMojoParameterValue(org.apache.maven.execution.MavenSession session,
org.apache.maven.plugin.MojoExecution mojoExecution,
String parameter,
Class<T> asType)
throws org.eclipse.core.runtime.CoreException
IMavenExecutionContext, use
#getMojoParameterValue(MojoExecution, String, Class) instead.org.eclipse.core.runtime.CoreException<T> T getMojoParameterValue(org.apache.maven.project.MavenProject project,
org.apache.maven.plugin.MojoExecution mojoExecution,
String parameter,
Class<T> asType,
org.eclipse.core.runtime.IProgressMonitor monitor)
throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreException<T> T getMojoParameterValue(String parameter, Class<T> type, org.apache.maven.execution.MavenSession session, org.apache.maven.model.Plugin plugin, org.apache.maven.model.ConfigurationContainer configuration, String goal) throws org.eclipse.core.runtime.CoreException
IMavenExecutionContext, use
#getMojoParameterValue(String, Class, Plugin, ConfigurationContainer, String) instead.org.eclipse.core.runtime.CoreException<T> T getMojoParameterValue(org.apache.maven.project.MavenProject project,
String parameter,
Class<T> type,
org.apache.maven.model.Plugin plugin,
org.apache.maven.model.ConfigurationContainer configuration,
String goal,
org.eclipse.core.runtime.IProgressMonitor monitor)
throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionorg.apache.maven.settings.Settings getSettings()
throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionString getLocalRepositoryPath()
org.apache.maven.artifact.repository.ArtifactRepository getLocalRepository()
throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionvoid populateDefaults(org.apache.maven.execution.MavenExecutionRequest request)
throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionorg.apache.maven.artifact.repository.ArtifactRepository createArtifactRepository(String id, String url) throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionList<org.apache.maven.artifact.repository.ArtifactRepository> getArtifactRepositories() throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionList<org.apache.maven.artifact.repository.ArtifactRepository> getArtifactRepositories(boolean injectSettings) throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionList<org.apache.maven.artifact.repository.ArtifactRepository> getPluginArtifactRepositories() throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionList<org.apache.maven.artifact.repository.ArtifactRepository> getPluginArtifactRepositories(boolean injectSettings) throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionorg.apache.maven.settings.Settings buildSettings(String globalSettings, String userSettings) throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionvoid writeSettings(org.apache.maven.settings.Settings settings,
OutputStream out)
throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionList<org.apache.maven.settings.building.SettingsProblem> validateSettings(String settings)
List<org.apache.maven.settings.Mirror> getMirrors() throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionorg.apache.maven.settings.Mirror getMirror(org.apache.maven.artifact.repository.ArtifactRepository repo)
throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionvoid addSettingsChangeListener(ISettingsChangeListener listener)
void removeSettingsChangeListener(ISettingsChangeListener listener)
void reloadSettings()
throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionorg.apache.maven.settings.Server decryptPassword(org.apache.maven.settings.Server server)
throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionvoid addLocalRepositoryListener(ILocalRepositoryListener listener)
void removeLocalRepositoryListener(ILocalRepositoryListener listener)
org.apache.maven.wagon.events.TransferListener createTransferListener(org.eclipse.core.runtime.IProgressMonitor monitor)
org.apache.maven.wagon.proxy.ProxyInfo getProxyInfo(String protocol) throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionList<org.apache.maven.project.MavenProject> getSortedProjects(List<org.apache.maven.project.MavenProject> projects) throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionString resolvePluginVersion(String groupId, String artifactId, org.apache.maven.execution.MavenSession session) throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreException<T> T getConfiguredMojo(org.apache.maven.execution.MavenSession session,
org.apache.maven.plugin.MojoExecution mojoExecution,
Class<T> clazz)
throws org.eclipse.core.runtime.CoreException
releaseMojo(Object, MojoExecution). This method is intended to allow introspection of mojo configuration
parameters, use execute(MavenSession, MojoExecution, IProgressMonitor) to execute mojo.org.eclipse.core.runtime.CoreExceptionvoid releaseMojo(Object mojo, org.apache.maven.plugin.MojoExecution mojoExecution) throws org.eclipse.core.runtime.CoreException
getConfiguredMojo(MavenSession, MojoExecution, Class)org.eclipse.core.runtime.CoreExceptionClassLoader getProjectRealm(org.apache.maven.project.MavenProject project)
<V> V execute(boolean offline,
boolean forceDependencyUpdate,
ICallable<V> callable,
org.eclipse.core.runtime.IProgressMonitor monitor)
throws org.eclipse.core.runtime.CoreException
IMavenExecutionContext context = createExecutionContext(); context.getExecutionRequest().setOffline(offline); context.getExecutionRequest().setUpdateSnapshots(forceDependencyUpdate); return context.execute(callable, monitor);
org.eclipse.core.runtime.CoreException<V> V execute(ICallable<V> callable, org.eclipse.core.runtime.IProgressMonitor monitor) throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionIMavenExecutionContext createExecutionContext() throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreExceptionIMavenExecutionContext getExecutionContext()
null if the current thread does not
have associated maven execution context.<T> T lookup(Class<T> clazz) throws org.eclipse.core.runtime.CoreException
clazz - the requested roleorg.eclipse.core.runtime.CoreException - if the requested component is not availableCopyright © 2005–2021 Eclipse Foundation. All rights reserved.