-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathGrabService.java
More file actions
128 lines (109 loc) · 4.57 KB
/
GrabService.java
File metadata and controls
128 lines (109 loc) · 4.57 KB
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
/*-
* #%L
* SciJava Common shared library for SciJava software.
* %%
* Copyright (C) 2017 - 2024 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
package org.scijava.grab;
import java.net.URI;
import java.util.List;
import java.util.Map;
import org.scijava.service.SciJavaService;
/**
* Interface for services which acquire dependencies at runtime.
*
* @author Hadrien Mary
*/
public interface GrabService extends SciJavaService {
void addResolver(Map<String, Object> args);
/**
* Gets a table of dependencies which have previously been grabbed.
*
* @return A map keyed on {@code groupId}. Each key resolves to a map keyed on
* {@code artifactId}s of that {@code groupId}. Each
* {@code artifactId} key resolves to a list of resolved
* {@code version}s.
*/
Map<String, Map<String, List<String>>> dependencies();
/** Global flag to ignore checksums. By default it is set to false. */
boolean getDisableChecksums();
/**
* This is a static access auto download enabler. It will set the
* 'autoDownload' value to the passed in arguments map if not already set. If
* 'autoDownload' is set the value will not be adjusted.
* <p>
* This applies to the grab and resolve calls.
* <p>
* If it is set to false, only previously downloaded grapes will be used. This
* may cause failure in the grape call if the library has not yet been
* downloaded
* <p>
* If it is set to true, then any jars not already downloaded will
* automatically be downloaded. Also, any versions expressed as a range will
* be checked for new versions and downloaded (with dependencies) if found.
* <p>
* By default it is set to true.
*/
boolean getEnableAutoDownload();
/**
* This is a static access kill-switch. All of the static shortcut methods in
* this class will not work if this property is set to false. By default it is
* set to true.
*/
boolean isGrabEnabled();
void grab(String endorsed);
void grab(Map<String, Object> dependency);
void grab(Map<String, Object> args, Map... dependencies);
Map[] listDependencies(ClassLoader cl);
URI[] resolve(Map<String, Object> args, Map... dependencies);
URI[] resolve(Map<String, Object> args, List depsInfo, Map... dependencies);
/**
* Sets global flag to ignore checksums. By default it is set to false.
*/
void setDisableChecksums(boolean disableChecksums);
/**
* This toggles the auto download feature. It will set the 'autoDownload'
* value to the passed in arguments map if not already set. If 'autoDownload'
* is set the value will not be adjusted.
* <p>
* This applies to the grab and resolve calls.
* <p>
* If it is set to false, only previously downloaded grapes will be used. This
* may cause failure in the grape call if the library has not yet been
* downloaded.
* <p>
* If it is set to true, then any jars not already downloaded will
* automatically be downloaded. Also, any versions expressed as a range will
* be checked for new versions and downloaded (with dependencies) if found. By
* default it is set to true.
*/
void setEnableAutoDownload(boolean enableAutoDownload);
/**
* This is a static access kill-switch. All of the static shortcut methods in
* this class will not work if this property is set to false. By default it is
* set to true.
*/
void setGrabEnabled(boolean grabEnabled);
}