1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
package org.apache.maven.plugin.prefix;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.List;
import org.apache.maven.model.Model;
import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.repository.RemoteRepository;
/**
* Collects settings required to resolve a plugin prefix.
*
* @since 3.0
* @author Benjamin Bentmann
*/
public interface PluginPrefixRequest
{
/**
* Gets the prefix of the plugin.
*
* @return The prefix of the plugin.
*/
String getPrefix();
/**
* Sets the prefix of the plugin.
*
* @param prefix The prefix of the plugin.
* @return This request, never {@code null}.
*/
PluginPrefixRequest setPrefix( String prefix );
/**
* Gets the list of group ids to scan for the plugin prefix.
*
* @return The list of group ids to scan for the plugin prefix, never {@code null}.
*/
List<String> getPluginGroups();
/**
* Sets the list of group ids to scan for the plugin prefix.
*
* @param pluginGroups The list of group ids to scan for the plugin prefix, may be {@code null}.
* @return This request, never {@code null}.
*/
PluginPrefixRequest setPluginGroups( List<String> pluginGroups );
/**
* Gets the POM whose build plugins are to be scanned for the prefix.
*
* @return The POM whose build plugins are to be scanned for the prefix or {@code null} to only search the plugin
* repositories.
*/
Model getPom();
/**
* Sets the POM whose build plugins are to be scanned for the prefix.
*
* @param pom The POM whose build plugins are to be scanned for the prefix, may be {@code null} to only search the
* plugin repositories.
* @return This request, never {@code null}.
*/
PluginPrefixRequest setPom( Model pom );
/**
* Gets the remote repositories to use.
*
* @return The remote repositories to use, never {@code null}.
*/
List<RemoteRepository> getRepositories();
/**
* Sets the remote repositories to use. <em>Note:</em> When creating a request from a project, be sure to use the
* plugin repositories and not the regular project repositories.
*
* @param repositories The remote repositories to use.
* @return This request, never {@code null}.
*/
PluginPrefixRequest setRepositories( List<RemoteRepository> repositories );
/**
* Gets the session to use for repository access.
*
* @return The repository session or {@code null} if not set.
*/
RepositorySystemSession getRepositorySession();
/**
* Sets the session to use for repository access.
*
* @param repositorySession The repository session to use.
* @return This request, never {@code null}.
*/
PluginPrefixRequest setRepositorySession( RepositorySystemSession repositorySession );
}
|
