Package org.apache.maven.plugin.version
Class DefaultPluginVersionRequest
java.lang.Object
org.apache.maven.plugin.version.DefaultPluginVersionRequest
- All Implemented Interfaces:
PluginVersionRequest
Collects settings required to resolve the version for a plugin.
- Since:
- 3.0
-
Constructor Summary
ConstructorDescriptionCreates an empty request.DefaultPluginVersionRequest
(Plugin plugin, MavenSession session) Creates a request for the specified plugin by copying settings from the specified build session.DefaultPluginVersionRequest
(Plugin plugin, org.eclipse.aether.RepositorySystemSession session, List<org.eclipse.aether.repository.RemoteRepository> repositories) Creates a request for the specified plugin using the given repository session and plugin repositories. -
Method Summary
Modifier and TypeMethodDescriptionGets the artifact id of the plugin.Gets the group id of the plugin.getPom()
Gets the POM whose build plugins are to be scanned for the version.List
<org.eclipse.aether.repository.RemoteRepository> Gets the remote repositories to use.org.eclipse.aether.RepositorySystemSession
Gets the session to use for repository access.setArtifactId
(String artifactId) Sets the artifact id of the plugin.setGroupId
(String groupId) Sets the group id of the plugin.Sets the POM whose build plugins are to be scanned for the version.setRepositories
(List<org.eclipse.aether.repository.RemoteRepository> repositories) Sets the remote repositories to use.setRepositorySession
(org.eclipse.aether.RepositorySystemSession session) Sets the session to use for repository access.
-
Constructor Details
-
DefaultPluginVersionRequest
public DefaultPluginVersionRequest()Creates an empty request. -
DefaultPluginVersionRequest
Creates a request for the specified plugin by copying settings from the specified build session. If the session has a current project, its plugin repositories will be used as well.- Parameters:
plugin
- The plugin for which to resolve a version, must not benull
.session
- The Maven session to use, must not benull
.
-
DefaultPluginVersionRequest
public DefaultPluginVersionRequest(Plugin plugin, org.eclipse.aether.RepositorySystemSession session, List<org.eclipse.aether.repository.RemoteRepository> repositories) Creates a request for the specified plugin using the given repository session and plugin repositories.- Parameters:
plugin
- The plugin for which to resolve a version, must not benull
.session
- The repository session to use, must not benull
.repositories
- The plugin repositories to query, may benull
.
-
-
Method Details
-
getGroupId
Description copied from interface:PluginVersionRequest
Gets the group id of the plugin.- Specified by:
getGroupId
in interfacePluginVersionRequest
- Returns:
- The group id of the plugin.
-
setGroupId
Description copied from interface:PluginVersionRequest
Sets the group id of the plugin.- Specified by:
setGroupId
in interfacePluginVersionRequest
- Parameters:
groupId
- The group id of the plugin.- Returns:
- This request, never
null
.
-
getArtifactId
Description copied from interface:PluginVersionRequest
Gets the artifact id of the plugin.- Specified by:
getArtifactId
in interfacePluginVersionRequest
- Returns:
- The artifact id of the plugin.
-
setArtifactId
Description copied from interface:PluginVersionRequest
Sets the artifact id of the plugin.- Specified by:
setArtifactId
in interfacePluginVersionRequest
- Parameters:
artifactId
- The artifact id of the plugin.- Returns:
- This request, never
null
.
-
getPom
Description copied from interface:PluginVersionRequest
Gets the POM whose build plugins are to be scanned for the version.- Specified by:
getPom
in interfacePluginVersionRequest
- Returns:
- The POM whose build plugins are to be scanned for the version or
null
to only search the plugin repositories.
-
setPom
Description copied from interface:PluginVersionRequest
Sets the POM whose build plugins are to be scanned for the version.- Specified by:
setPom
in interfacePluginVersionRequest
- 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
Description copied from interface:PluginVersionRequest
Gets the remote repositories to use.- Specified by:
getRepositories
in interfacePluginVersionRequest
- Returns:
- The remote repositories to use, never
null
.
-
setRepositories
public DefaultPluginVersionRequest setRepositories(List<org.eclipse.aether.repository.RemoteRepository> repositories) Description copied from interface:PluginVersionRequest
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.- Specified by:
setRepositories
in interfacePluginVersionRequest
- Parameters:
repositories
- The remote repositories to use.- Returns:
- This request, never
null
.
-
getRepositorySession
public org.eclipse.aether.RepositorySystemSession getRepositorySession()Description copied from interface:PluginVersionRequest
Gets the session to use for repository access.- Specified by:
getRepositorySession
in interfacePluginVersionRequest
- Returns:
- The repository session or
null
if not set.
-
setRepositorySession
public DefaultPluginVersionRequest setRepositorySession(org.eclipse.aether.RepositorySystemSession session) Description copied from interface:PluginVersionRequest
Sets the session to use for repository access.- Specified by:
setRepositorySession
in interfacePluginVersionRequest
- Parameters:
session
- The repository session to use.- Returns:
- This request, never
null
.
-