Package org.apache.maven.plugin.prefix

Class DefaultPluginPrefixRequest

  • All Implemented Interfaces:
    PluginPrefixRequest
    public class DefaultPluginPrefixRequest
extends java.lang.Object
implements PluginPrefixRequest
    Collects settings required to resolve a plugin prefix.
    Since:
    3.0

    • Field Detail

      • prefix

        private java.lang.String prefix

      • pluginGroups

        private java.util.List<java.lang.String> pluginGroups

      • repositories

        private java.util.List<org.eclipse.aether.repository.RemoteRepository> repositories

      • session

        private org.eclipse.aether.RepositorySystemSession session

    • Constructor Detail

      • DefaultPluginPrefixRequest

        public DefaultPluginPrefixRequest()
        Creates an empty request.

      • DefaultPluginPrefixRequest

        public DefaultPluginPrefixRequest​(java.lang.String prefix,
                                  MavenSession session)
        Creates a request for the specified plugin prefix and build session. The provided build session will be used to configure repository settings. If the session has a current project, its plugin repositories and model will be used as well.
        Parameters:
        prefix - The plugin prefix to resolve, must not be null.
        session - The build session from which to derive further settings, must not be null.

    • Method Detail

      • getPluginGroups

        public java.util.List<java.lang.String> getPluginGroups()
        Description copied from interface: PluginPrefixRequest
        Gets the list of group ids to scan for the plugin prefix.
        Specified by:
        getPluginGroups in interface PluginPrefixRequest
        Returns:
        The list of group ids to scan for the plugin prefix, never null.

      • setPluginGroups

        public DefaultPluginPrefixRequest setPluginGroups​(java.util.List<java.lang.String> pluginGroups)
        Description copied from interface: PluginPrefixRequest
        Sets the list of group ids to scan for the plugin prefix.
        Specified by:
        setPluginGroups in interface PluginPrefixRequest
        Parameters:
        pluginGroups - The list of group ids to scan for the plugin prefix, may be null.
        Returns:
        This request, never null.

      • getPom

        public Model getPom()
        Description copied from interface: PluginPrefixRequest
        Gets the POM whose build plugins are to be scanned for the prefix.
        Specified by:
        getPom in interface PluginPrefixRequest
        Returns:
        The POM whose build plugins are to be scanned for the prefix or null to only search the plugin repositories.

      • setPom

        public DefaultPluginPrefixRequest setPom​(Model pom)
        Description copied from interface: PluginPrefixRequest
        Sets the POM whose build plugins are to be scanned for the prefix.
        Specified by:
        setPom in interface PluginPrefixRequest
        Parameters:
        pom - The POM whose build plugins are to be scanned for the prefix, may be null to only search the plugin repositories.
        Returns:
        This request, never null.

      • getRepositories

        public java.util.List<org.eclipse.aether.repository.RemoteRepository> getRepositories()
        Description copied from interface: PluginPrefixRequest
        Gets the remote repositories to use.
        Specified by:
        getRepositories in interface PluginPrefixRequest
        Returns:
        The remote repositories to use, never null.

      • setRepositories

        public DefaultPluginPrefixRequest setRepositories​(java.util.List<org.eclipse.aether.repository.RemoteRepository> repositories)
        Description copied from interface: PluginPrefixRequest
        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 interface PluginPrefixRequest
        Parameters:
        repositories - The remote repositories to use.
        Returns:
        This request, never null.

      • getRepositorySession

        public org.eclipse.aether.RepositorySystemSession getRepositorySession()
        Description copied from interface: PluginPrefixRequest
        Gets the session to use for repository access.
        Specified by:
        getRepositorySession in interface PluginPrefixRequest
        Returns:
        The repository session or null if not set.