DefaultGrabService (SciJava Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.AbstractContextual
- - org.scijava.plugin.AbstractRichPlugin
  - - org.scijava.service.AbstractService
    - - org.scijava.grab.DefaultGrabService

All Implemented Interfaces:

Comparable<Prioritized>, Contextual, Disposable, GrabService, Identifiable, Initializable, Locatable, Logged, HasPluginInfo, RichPlugin, SciJavaPlugin, Prioritized, SciJavaService, Service, Versioned
```
public class DefaultGrabService
extends AbstractService
implements GrabService
```
Default implementation of GrabService.
Heavily adapted from Grape.java.

Author:

Hadrien Mary

Field Summary

Fields
Modifier and Type Field and Description

static String AUTO_DOWNLOAD_SETTING

static String DISABLE_CHECKSUMS_SETTING

static String SYSTEM_PROPERTIES_SETTING

Fields
Modifier and Type	Field and Description
`static String`	`AUTO_DOWNLOAD_SETTING`
`static String`	`DISABLE_CHECKSUMS_SETTING`
`static String`	`SYSTEM_PROPERTIES_SETTING`

Constructor Summary

Constructors
Constructor and Description

DefaultGrabService()

Constructors
Constructor and Description
`DefaultGrabService()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addResolver(Map<String,Object> args)`
`Map<String,Map<String,List<String>>>`	`dependencies()` Gets a table of dependencies which have previously been grabbed.
`boolean`	`getDisableChecksums()` Global flag to ignore checksums.
`boolean`	`getEnableAutoDownload()` This is a static access auto download enabler.
`void`	`grab(Map<String,Object> dependency)`
`void`	`grab(Map<String,Object> args, Map... dependencies)`
`void`	`grab(String endorsed)`
`boolean`	`isGrabEnabled()` This is a static access kill-switch.
`Map[]`	`listDependencies(ClassLoader cl)`
`URI[]`	`resolve(Map<String,Object> args, List depsInfo, Map... dependencies)`
`URI[]`	`resolve(Map<String,Object> args, Map... dependencies)`
`void`	`setDisableChecksums(boolean disableChecksums)` Sets global flag to ignore checksums.
`void`	`setEnableAutoDownload(boolean enableAutoDownload)` This toggles the auto download feature.
`void`	`setGrabEnabled(boolean enableGrab)` This is a static access kill-switch.

Methods inherited from class org.scijava.service.AbstractService
getContext, setContext, toString

Methods inherited from class org.scijava.plugin.AbstractRichPlugin
getInfo, getPriority, setInfo, setPriority

Methods inherited from class org.scijava.AbstractContextual
context

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.scijava.service.Service
initialize, registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin
getIdentifier, log

Methods inherited from interface org.scijava.Contextual
context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized
compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo
getInfo, setInfo

Methods inherited from interface org.scijava.Locatable
getLocation

Methods inherited from interface org.scijava.Versioned
getVersion

Methods inherited from interface org.scijava.Disposable
dispose

- Field Detail
  - AUTO_DOWNLOAD_SETTING
```
public static final String AUTO_DOWNLOAD_SETTING
```
    See Also:
    
    Constant Field Values
  - DISABLE_CHECKSUMS_SETTING
```
public static final String DISABLE_CHECKSUMS_SETTING
```
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTIES_SETTING
```
public static final String SYSTEM_PROPERTIES_SETTING
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DefaultGrabService
```
public DefaultGrabService()
```
- Method Detail
  - isGrabEnabled
```
public boolean isGrabEnabled()
```
    Description copied from interface: GrabService
    
    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.
    
    Specified by:
    
    isGrabEnabled in interface GrabService
  - setGrabEnabled
```
public void setGrabEnabled(boolean enableGrab)
```
    Description copied from interface: GrabService
    
    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.
    
    Specified by:
    
    setGrabEnabled in interface GrabService
  - getEnableAutoDownload
```
public boolean getEnableAutoDownload()
```
    Description copied from interface: GrabService
    
    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.
    This applies to the grab and resolve calls.
    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
    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.
    
    Specified by:
    
    getEnableAutoDownload in interface GrabService
  - setEnableAutoDownload
```
public void setEnableAutoDownload(boolean enableAutoDownload)
```
    Description copied from interface: GrabService
    
    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.
    This applies to the grab and resolve calls.
    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.
    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.
    
    Specified by:
    
    setEnableAutoDownload in interface GrabService
  - getDisableChecksums
```
public boolean getDisableChecksums()
```
    Description copied from interface: GrabService
    
    Global flag to ignore checksums. By default it is set to false.
    
    Specified by:
    
    getDisableChecksums in interface GrabService
  - setDisableChecksums
```
public void setDisableChecksums(boolean disableChecksums)
```
    Description copied from interface: GrabService
    
    Sets global flag to ignore checksums. By default it is set to false.
    
    Specified by:
    
    setDisableChecksums in interface GrabService
  - grab
```
public void grab(String endorsed)
```
    Specified by:
    
    grab in interface GrabService
  - grab
```
public void grab(Map<String,Object> dependency)
```
    Specified by:
    
    grab in interface GrabService
  - grab
```
public void grab(Map<String,Object> args,
                 Map... dependencies)
```
    Specified by:
    
    grab in interface GrabService
  - dependencies
```
public Map<String,Map<String,List<String>>> dependencies()
```
    Description copied from interface: GrabService
    
    Gets a table of dependencies which have previously been grabbed.
    
    Specified by:
    
    dependencies in interface GrabService
    
    Returns:
    
    A map keyed on groupId. Each key resolves to a map keyed on artifactIds of that groupId. Each artifactId key resolves to a list of resolved versions.
  - resolve
```
public URI[] resolve(Map<String,Object> args,
                     Map... dependencies)
```
    Specified by:
    
    resolve in interface GrabService
  - resolve
```
public URI[] resolve(Map<String,Object> args,
                     List depsInfo,
                     Map... dependencies)
```
    Specified by:
    
    resolve in interface GrabService
  - listDependencies
```
public Map[] listDependencies(ClassLoader cl)
```
    Specified by:
    
    listDependencies in interface GrabService
  - addResolver
```
public void addResolver(Map<String,Object> args)
```
    Specified by:
    
    addResolver in interface GrabService

Class DefaultGrabService

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.scijava.service.AbstractService

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

Methods inherited from class org.scijava.AbstractContextual

Methods inherited from class java.lang.Object

Methods inherited from interface org.scijava.service.Service

Methods inherited from interface org.scijava.plugin.RichPlugin

Methods inherited from interface org.scijava.Contextual

Methods inherited from interface org.scijava.Prioritized

Methods inherited from interface org.scijava.plugin.HasPluginInfo

Methods inherited from interface org.scijava.Locatable

Methods inherited from interface org.scijava.Versioned

Methods inherited from interface org.scijava.Disposable

Field Detail

AUTO_DOWNLOAD_SETTING

DISABLE_CHECKSUMS_SETTING

SYSTEM_PROPERTIES_SETTING

Constructor Detail

DefaultGrabService

Method Detail

isGrabEnabled

setGrabEnabled

getEnableAutoDownload

setEnableAutoDownload

getDisableChecksums

setDisableChecksums

grab

grab

grab

dependencies

resolve

resolve

listDependencies

addResolver