Package org.apache.maven.plugin.version
Interface PluginVersionRequest
-
- All Known Implementing Classes:
DefaultPluginVersionRequest
public interface PluginVersionRequest
Collects settings required to resolve the version for a plugin.- Since:
- 3.0
- Author:
- Benjamin Bentmann
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getArtifactId()
Gets the artifact id of the plugin.String
getGroupId()
Gets the group id of the plugin.Model
getPom()
Gets the POM whose build plugins are to be scanned for the version.List<org.eclipse.aether.repository.RemoteRepository>
getRepositories()
Gets the remote repositories to use.org.eclipse.aether.RepositorySystemSession
getRepositorySession()
Gets the session to use for repository access.PluginVersionRequest
setArtifactId(String artifactId)
Sets the artifact id of the plugin.PluginVersionRequest
setGroupId(String groupId)
Sets the group id of the plugin.PluginVersionRequest
setPom(Model pom)
Sets the POM whose build plugins are to be scanned for the version.PluginVersionRequest
setRepositories(List<org.eclipse.aether.repository.RemoteRepository> repositories)
Sets the remote repositories to use.PluginVersionRequest
setRepositorySession(org.eclipse.aether.RepositorySystemSession repositorySession)
Sets the session to use for repository access.
-
-
-
Method Detail
-
getGroupId
String getGroupId()
Gets the group id of the plugin.- Returns:
- The group id of the plugin.
-
setGroupId
PluginVersionRequest setGroupId(String groupId)
Sets the group id of the plugin.- Parameters:
groupId
- The group id of the plugin.- Returns:
- This request, never
null
.
-
getArtifactId
String getArtifactId()
Gets the artifact id of the plugin.- Returns:
- The artifact id of the plugin.
-
setArtifactId
PluginVersionRequest setArtifactId(String artifactId)
Sets the artifact id of the plugin.- Parameters:
artifactId
- The artifact id of the plugin.- Returns:
- This request, never
null
.
-
getPom
Model getPom()
Gets the POM whose build plugins are to be scanned for the version.- Returns:
- The POM whose build plugins are to be scanned for the version or
null
to only search the plugin repositories.
-
setPom
PluginVersionRequest setPom(Model pom)
Sets the POM whose build plugins are to be scanned for the version.- Parameters:
pom
- The POM whose build plugins are to be scanned for the version, may benull
to only search the plugin repositories.- Returns:
- This request, never
null
.
-
getRepositories
List<org.eclipse.aether.repository.RemoteRepository> getRepositories()
Gets the remote repositories to use.- Returns:
- The remote repositories to use, never
null
.
-
setRepositories
PluginVersionRequest setRepositories(List<org.eclipse.aether.repository.RemoteRepository> repositories)
Sets the remote repositories to use. Note: When creating a request from a project, be sure to use the plugin repositories and not the regular project repositories.- Parameters:
repositories
- The remote repositories to use.- Returns:
- This request, never
null
.
-
getRepositorySession
org.eclipse.aether.RepositorySystemSession getRepositorySession()
Gets the session to use for repository access.- Returns:
- The repository session or
null
if not set.
-
setRepositorySession
PluginVersionRequest setRepositorySession(org.eclipse.aether.RepositorySystemSession repositorySession)
Sets the session to use for repository access.- Parameters:
repositorySession
- The repository session to use.- Returns:
- This request, never
null
.
-
-