-
Notifications
You must be signed in to change notification settings - Fork 564
/
RepositoryApi.java
509 lines (467 loc) · 23.3 KB
/
RepositoryApi.java
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
/*
* Sonatype Nexus (TM) Open Source Version
* Copyright (c) 2008-present Sonatype, Inc.
* All rights reserved. Includes the third-party code listed at http://links.sonatype.com/products/nexus/oss/attributions.
*
* This program and the accompanying materials are made available under the terms of the Eclipse Public License Version 1.0,
* which accompanies this distribution and is available at http://www.eclipse.org/legal/epl-v10.html.
*
* Sonatype Nexus (TM) Professional Version is available from Sonatype, Inc. "Sonatype" and "Sonatype Nexus" are trademarks
* of Sonatype, Inc. Apache Maven is a trademark of the Apache Software Foundation. M2eclipse is a trademark of the
* Eclipse Foundation. All other trademarks are the property of their respective owners.
*/
package org.sonatype.nexus.script.plugin;
import java.util.List;
import org.sonatype.nexus.common.script.ScriptApi;
import org.sonatype.nexus.repository.Repository;
import org.sonatype.nexus.repository.config.Configuration;
import org.sonatype.nexus.repository.maven.LayoutPolicy;
import org.sonatype.nexus.repository.maven.VersionPolicy;
import org.sonatype.nexus.repository.config.WritePolicy;
/**
* Repository provisioning capabilities of the repository manager.
*
* @since 3.0
*/
public interface RepositoryApi
extends ScriptApi
{
default String getName() {
return "repository";
}
/**
* Create an Apt proxy repository.
* @param name The name of the new Repository
* @param remoteUrl The url of the external proxy for this Repository
* @param blobStoreName The BlobStore the Repository should use
* @param distribution The name of the required distribution
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @return the newly created Repository
*/
Repository createAptProxy(final String name,
final String remoteUrl,
final String blobStoreName,
final String distribution,
final boolean strictContentTypeValidation);
/**
* Create an Apt hosted repository.
* @param name The name of the new Repository
* @param distribution The name of the required distribution
* @param pgpPrivateKey GPG private key
* @param blobStoreName The BlobStore the Repository should use
* @param writePolicy The {@link WritePolicy} for the Repository
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @return the newly created Repository
*/
Repository createAptHosted(final String name,
final String distribution,
final String pgpPrivateKey,
final String pgpPassPhrase,
final String blobStoreName,
final WritePolicy writePolicy,
final boolean strictContentTypeValidation);
/**
* Create a Cocoapods proxy repository.
* @param name The name of the new Repository
* @param remoteUrl The url of the external proxy for this Repository
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @return the newly created Repository
*/
Repository createCocoapodsProxy(final String name,
final String remoteUrl,
final String blobStoreName,
final boolean strictContentTypeValidation);
/**
* Create a Maven hosted repository.
* @param name The name of the new Repository
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @param versionPolicy The {@link VersionPolicy} for the Repository
* @param writePolicy The {@link WritePolicy} for the Repository
* @param layoutPolicy The {@link LayoutPolicy} for the Repository
* @return the newly created Repository
*/
Repository createMavenHosted(final String name,
final String blobStoreName,
final boolean strictContentTypeValidation,
final VersionPolicy versionPolicy,
final WritePolicy writePolicy,
final LayoutPolicy layoutPolicy);
/**
* Create a Maven proxy repository.
* @param name The name of the new Repository
* @param remoteUrl The url of the external proxy for this Repository
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @param versionPolicy The {@link VersionPolicy} for the Repository
* @param layoutPolicy The {@link LayoutPolicy} for the Repository
* @return the newly created Repository
*/
Repository createMavenProxy(final String name,
final String remoteUrl,
final String blobStoreName,
final boolean strictContentTypeValidation,
final VersionPolicy versionPolicy,
final LayoutPolicy layoutPolicy);
/**
* Create a Maven group repository.
* @param name The name of the new Repository
* @param blobStoreName The BlobStore the Repository should use
* @param members The names of the Repositories in the group
* @return the newly created Repository
*/
Repository createMavenGroup(final String name,
final List<String> members,
final String blobStoreName);
/**
* Create an Npm hosted repository.
* @param name The name of the new Repository
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @param writePolicy The {@link WritePolicy} for the Repository
* @return the newly created Repository
*/
Repository createNpmHosted(final String name,
final String blobStoreName,
final boolean strictContentTypeValidation,
final WritePolicy writePolicy);
/**
* Create an Npm proxy repository.
* @param name The name of the new Repository
* @param remoteUrl The url of the external proxy for this Repository
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @return the newly created Repository
*/
Repository createNpmProxy(final String name,
final String remoteUrl,
final String blobStoreName,
final boolean strictContentTypeValidation);
/**
* Create an Npm group repository.
* @param name The name of the new Repository
* @param blobStoreName The BlobStore the Repository should use
* @param members The names of the Repositories in the group
* @return the newly created Repository
*/
Repository createNpmGroup(final String name,
final List<String> members,
final String blobStoreName);
/**
* Create a Nuget hosted repository.
* @param name The name of the new Repository
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @param writePolicy The {@link WritePolicy} for the Repository
* @return the newly created Repository
*/
Repository createNugetHosted(final String name,
final String blobStoreName,
final boolean strictContentTypeValidation,
final WritePolicy writePolicy);
/**
* Create a Nuget proxy repository.
* @param name The name of the new Repository
* @param remoteUrl The url of the external proxy for this Repository
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @return the newly created Repository
*/
Repository createNugetProxy(final String name,
final String remoteUrl,
final String blobStoreName,
final boolean strictContentTypeValidation);
/**
* Create a Nuget group repository.
* @param name The name of the new Repository
* @param blobStoreName The BlobStore the Repository should use
* @param members The names of the Repositories in the group
* @return the newly created Repository
*/
Repository createNugetGroup(final String name,
final List<String> members,
final String blobStoreName);
/**
* Create a Raw hosted repository.
* @param name The name of the new Repository
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @param writePolicy The {@link WritePolicy} for the Repository
* @return the newly created Repository
*/
Repository createRawHosted(final String name,
final String blobStoreName,
final boolean strictContentTypeValidation,
final WritePolicy writePolicy);
/**
* Create a Raw proxy repository.
* @param name The name of the new Repository
* @param remoteUrl The url of the external proxy for this Repository
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @return
*/
Repository createRawProxy(final String name,
final String remoteUrl,
final String blobStoreName,
final boolean strictContentTypeValidation);
/**
* Create a Raw group repository.
* @param name The name of the new Repository
* @param blobStoreName The BlobStore the Repository should use
* @param members The names of the Repositories in the group
* @return the newly created Repository
*/
Repository createRawGroup(final String name,
final List<String> members,
final String blobStoreName);
/**
* Create a Docker hosted repository.
* @param name The name of the new Repository
* @param httpPort The http port to accept traffic for this Repository on (optional)
* @param httpsPort The https port to accept traffic for this Repository on (optional)
* @param blobStoreName The BlobStore the Repository should use
* @param v1Enabled Whether or not this Repository supports Docker V1 format
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @param writePolicy The {@link WritePolicy} for the Repository
* @return the newly created Repository
*/
Repository createDockerHosted(final String name,
Integer httpPort,
Integer httpsPort,
final String blobStoreName,
final boolean v1Enabled,
final boolean strictContentTypeValidation,
final WritePolicy writePolicy);
/**
* Create a Docker hosted repository.
*
* @since 3.14
* @param name The name of the new Repository
* @param httpPort The http port to accept traffic for this Repository on (optional)
* @param httpsPort The https port to accept traffic for this Repository on (optional)
* @param blobStoreName The BlobStore the Repository should use
* @param v1Enabled Whether or not this Repository supports Docker V1 format
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @param writePolicy The {@link WritePolicy} for the Repository
* @param forceBasicAuth whether to force basic auth. False is required to enable token auth which can be used for anonymous access
* @return the newly created Repository
*/
Repository createDockerHosted(final String name, //NOSONAR
Integer httpPort,
Integer httpsPort,
final String blobStoreName,
final boolean v1Enabled,
final boolean strictContentTypeValidation,
final WritePolicy writePolicy,
final boolean forceBasicAuth);
/**
* Create a Docker proxy repository.
*
* @param name The name of the new Repository
* @param remoteUrl The url of the external proxy for this Repository
* @param indexType Use 'REGISTRY' to use the proxy url for the index as well. Use 'HUB' to use the
* index from DockerHub. Use 'CUSTOM' in conjunction with the 'indexUrl' param to
* specify a custom index location
* @param indexUrl The url of a 'CUSTOM' index; only used in conjunction with the 'indexType'
* parameter
* @param httpPort The http port to accept traffic for this Repository on (optional)
* @param httpsPort The https port to accept traffic for this Repository on (optional)
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @param v1Enabled Whether or not this Repository supports Docker V1 format
* @return the newly created Repository
*/
Repository createDockerProxy(final String name, //NOSONAR
final String remoteUrl,
final String indexType,
final String indexUrl,
Integer httpPort,
Integer httpsPort,
final String blobStoreName,
final boolean strictContentTypeValidation,
final boolean v1Enabled);
/**
* Create a Docker group repository.
* @param name The name of the new Repository
* @param httpPort The http port to accept traffic for this Repository on (optional)
* @param httpsPort The https port to accept traffic for this Repository on (optional)
* @param v1Enabled Whether or not this Repository supports Docker V1 format
* @param blobStoreName The BlobStore the Repository should use
* @param members The names of the Repositories in the group
* @return the newly created Repository
*/
Repository createDockerGroup(final String name,
Integer httpPort,
Integer httpsPort,
final List<String> members,
final boolean v1Enabled,
final String blobStoreName);
/**
* Create a Ruby gems hosted repository.
*
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @param writePolicy The {@link WritePolicy} for the Repository
* @return the newly created Repository
*/
Repository createRubygemsHosted(final String name,
final String blobStoreName,
final boolean strictContentTypeValidation,
final WritePolicy writePolicy);
/**
* Create a Ruby gems proxy repository.
*
* @param name The name of the new Repository
* @param remoteUrl The url of the external proxy for this Repository
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @return the newly created Repository
*/
Repository createRubygemsProxy(final String name,
final String remoteUrl,
final String blobStoreName,
final boolean strictContentTypeValidation);
/**
* Create a Rubygems group repository.
*
* @param name The name of the new Repository
* @param blobStoreName The BlobStore the Repository should use
* @param members The names of the Repositories in the group
* @return the newly created Repository
*/
Repository createRubygemsGroup(final String name,
final List<String> members,
final String blobStoreName);
/**
* Create a PyPi hosted repository.
* @param name The name of the new Repository
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @param writePolicy The {@link WritePolicy} for the Repository
* @return the newly created Repository
*/
Repository createPyPiHosted(final String name,
final String blobStoreName,
final boolean strictContentTypeValidation,
final WritePolicy writePolicy);
/**
* Create a PyPi proxy repository.
* @param name The name of the new Repository
* @param remoteUrl The url of the external proxy for this Repository
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @return the newly created Repository
*/
Repository createPyPiProxy(final String name,
final String remoteUrl,
final String blobStoreName,
final boolean strictContentTypeValidation);
/**
* Create a PyPi group repository.
* @param name The name of the new Repository
* @param blobStoreName The BlobStore the Repository should use
* @param members The names of the Repositories in the group
* @return the newly created Repository
*/
Repository createPyPiGroup(final String name,
final List<String> members,
final String blobStoreName);
/**
* Create a Yum hosted repository.
* @param name The name of the new Repository
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @param writePolicy The {@link WritePolicy} for the Repository
* @param depth the repodata depth
* @return the newly created Repository
*/
Repository createYumHosted(final String name,
final String blobStoreName,
final boolean strictContentTypeValidation,
final WritePolicy writePolicy,
final int depth);
/**
* Create a Yum proxy repository.
* @param name The name of the new Repository
* @param remoteUrl The url of the external proxy for this Repository
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @return the newly created Repository
*/
Repository createYumProxy(final String name,
final String remoteUrl,
final String blobStoreName,
final boolean strictContentTypeValidation);
/**
* Create a Go hosted repository.
* @param name The name of the new Repository
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @param writePolicy The {@link WritePolicy} for the Repository
* @return the newly created Repository
*/
Repository createGolangHosted(final String name,
final String blobStoreName,
final boolean strictContentTypeValidation,
final WritePolicy writePolicy);
/**
* Create a Go proxy repository.
* @param name The name of the new Repository
* @param remoteUrl The url of the external proxy for this Repository
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @return the newly created Repository
*/
Repository createGolangProxy(final String name,
final String remoteUrl,
final String blobStoreName,
final boolean strictContentTypeValidation);
/**
* Create a Go group repository.
* @param name The name of the new Repository
* @param blobStoreName The BlobStore the Repository should use
* @param members The names of the Repositories in the group
* @return the newly created Repository
*/
Repository createGolangGroup(final String name,
final List<String> members,
final String blobStoreName);
/**
* Create a GitLFS hosted repository.
*
* @param name The name of the new Repository
* @param blobStoreName The BlobStore the Repository should use
* @param strictContentTypeValidation Whether or not the Repository should enforce strict content types
* @param writePolicy The {@link WritePolicy} for the Repository
* @return The newly created Repository
*/
Repository createGitLfsHosted(final String name,
final String blobStoreName,
final boolean strictContentTypeValidation,
final WritePolicy writePolicy);
/**
* Create a hosted configuration for the given recipeName.
*/
Configuration createHosted(final String name,
final String recipeName,
final String blobStoreName,
final WritePolicy writePolicy,
final boolean strictContentTypeValidation);
/**
* Create a proxy configuration for the given recipeName.
*/
Configuration createProxy(final String name,
final String recipeName,
final String remoteUrl,
final String blobStoreName,
final boolean strictContentTypeValidation);
/**
* Create a group configuration for the given recipeName.
*/
Configuration createGroup(final String name,
final String recipeName,
final String blobStoreName,
final String... members);
}