UpgradeChecker (Bio-Formats API)

java.lang.Object
- loci.formats.UpgradeChecker

```
public class UpgradeChecker
extends Object
```
Class that allows checking for new versions of Bio-Formats, as well as updating to the latest stable, daily, or trunk version.

Field Summary

Fields
Modifier and Type	Field and Description
`private static int`	`CHUNK_SIZE` Number of bytes to read from the CI server at a time.
`static String`	`CI_SERVER` Location of the OME continuous integration server.
`static String`	`DAILY_BUILD` Location of the JAR artifacts for Bio-Formats' daily build.
`static String`	`DEFAULT_CALLER` Value of "bioformats.caller" for Bio-Formats utilities.
`static String[]`	`INDIVIDUAL_JARS` Names of the individual JARs.
`private static org.slf4j.Logger`	`LOGGER`
`static String`	`OLD_TOOLS` Name of the previous versions' tools JAR.
`static String`	`OME_TOOLS` Name of the OME tools JAR.
`static String`	`REGISTRY` Location of the OME registry.
`static String`	`REGISTRY_IMAGEJ` Registry ID identifying usage of Bio-Formats in ImageJ.
`static String`	`REGISTRY_LIBRARY` Registry ID identifying usage of Bio-Formats as a library in general.
`private static String[]`	`REGISTRY_PROPERTIES` Properties that are sent to the OME registry.
`static String`	`STABLE_BUILD` Location of the JAR artifacts for the stable releases.
`static String`	`STABLE_VERSION` Version number of the latest stable release.
`static String`	`TOOLS` Name of the ueber tools JAR.
`static String`	`TRUNK_BUILD` Location of the JAR artifacts for Bio-Formats' trunk build.
`private static String`	`UPGRADE_CHECK_ALLOWED_PROPERTY` System property indicating whether the upgrade check is ever allowed.
`private static String`	`UPGRADE_CHECK_PROPERTY` System property to set once the upgrade check is performed.

Constructor Summary

Constructors
Constructor and Description

UpgradeChecker()

Constructors
Constructor and Description
`UpgradeChecker()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`alreadyChecked()` Return true if an upgrade check has already been performed in this JVM session.
`boolean`	`canDoUpgradeCheck()` Return whether or not we are ever allowed to perform an upgrade check.
`boolean`	`install(String urlPath, String downloadPath)` Download and install a JAR file from the given URL.
`boolean`	`installIndividualJars(String urlDir, String downloadDir)` Download and install all of the individual JAR files into the given directory.
`boolean`	`newVersionAvailable(String caller)` Contact the OME registry and return true if a new version is available.
`boolean`	`newVersionAvailable(String registryID, String caller)` Contact the OME registry and return true if a new version is available.
`void`	`setCanDoUpgradeCheck(boolean canDo)` Set whether or not we are ever allowed to perform an upgrade check.

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

- Field Detail
  - REGISTRY_IMAGEJ
```
public static final String REGISTRY_IMAGEJ
```
    Registry ID identifying usage of Bio-Formats in ImageJ.
    
    See Also:
    
    Constant Field Values
  - REGISTRY_LIBRARY
```
public static final String REGISTRY_LIBRARY
```
    Registry ID identifying usage of Bio-Formats as a library in general.
    
    See Also:
    
    Constant Field Values
  - STABLE_VERSION
```
public static final String STABLE_VERSION
```
    Version number of the latest stable release.
    
    See Also:
    
    Constant Field Values
  - CI_SERVER
```
public static final String CI_SERVER
```
    Location of the OME continuous integration server.
    
    See Also:
    
    Constant Field Values
  - TRUNK_BUILD
```
public static final String TRUNK_BUILD
```
    Location of the JAR artifacts for Bio-Formats' trunk build.
    
    See Also:
    
    Constant Field Values
  - DAILY_BUILD
```
public static final String DAILY_BUILD
```
    Location of the JAR artifacts for Bio-Formats' daily build.
    
    See Also:
    
    Constant Field Values
  - STABLE_BUILD
```
public static final String STABLE_BUILD
```
    Location of the JAR artifacts for the stable releases.
    
    See Also:
    
    Constant Field Values
  - TOOLS
```
public static final String TOOLS
```
    Name of the ueber tools JAR.
    
    See Also:
    
    Constant Field Values
  - OLD_TOOLS
```
public static final String OLD_TOOLS
```
    Name of the previous versions' tools JAR.
    
    See Also:
    
    Constant Field Values
  - OME_TOOLS
```
public static final String OME_TOOLS
```
    Name of the OME tools JAR.
    
    See Also:
    
    Constant Field Values
  - INDIVIDUAL_JARS
```
public static final String[] INDIVIDUAL_JARS
```
    Names of the individual JARs.
  - REGISTRY
```
public static final String REGISTRY
```
    Location of the OME registry.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CALLER
```
public static final String DEFAULT_CALLER
```
    Value of "bioformats.caller" for Bio-Formats utilities.
    
    See Also:
    
    Constant Field Values
  - REGISTRY_PROPERTIES
```
private static final String[] REGISTRY_PROPERTIES
```
    Properties that are sent to the OME registry.
  - UPGRADE_CHECK_PROPERTY
```
private static final String UPGRADE_CHECK_PROPERTY
```
    System property to set once the upgrade check is performed.
    
    See Also:
    
    Constant Field Values
  - UPGRADE_CHECK_ALLOWED_PROPERTY
```
private static final String UPGRADE_CHECK_ALLOWED_PROPERTY
```
    System property indicating whether the upgrade check is ever allowed.
    
    See Also:
    
    Constant Field Values
  - CHUNK_SIZE
```
private static final int CHUNK_SIZE
```
    Number of bytes to read from the CI server at a time.
    
    See Also:
    
    Constant Field Values
  - LOGGER
```
private static final org.slf4j.Logger LOGGER
```
- Constructor Detail
  - UpgradeChecker
```
public UpgradeChecker()
```
- Method Detail
  - alreadyChecked
```
public boolean alreadyChecked()
```
    Return true if an upgrade check has already been performed in this JVM session.
  - canDoUpgradeCheck
```
public boolean canDoUpgradeCheck()
```
    Return whether or not we are ever allowed to perform an upgrade check.
  - setCanDoUpgradeCheck
```
public void setCanDoUpgradeCheck(boolean canDo)
```
    Set whether or not we are ever allowed to perform an upgrade check.
  - newVersionAvailable
```
public boolean newVersionAvailable(String caller)
```
    Contact the OME registry and return true if a new version is available. OMERO.registry will identify this as a generic library usage of Bio-Formats (i.e. not associated with a specific client application).
    
    Parameters:
    
    caller - name of the calling application, e.g. "MATLAB"
  - newVersionAvailable
```
public boolean newVersionAvailable(String registryID,
                                   String caller)
```
    Contact the OME registry and return true if a new version is available.
    
    Parameters:
    
    registryID - how the application identifies itself to OMERO.registry
    
    caller - name of the calling application, e.g. "MATLAB"
    
    See Also:
    
    REGISTRY_IMAGEJ, REGISTRY_LIBRARY
  - installIndividualJars
```
public boolean installIndividualJars(String urlDir,
                                     String downloadDir)
```
    Download and install all of the individual JAR files into the given directory.
    
    Parameters:
    
    urlDir - the location from which to download the JAR files
    
    downloadDir - the directory into which to save the JAR files
    
    Returns:
    
    true if installation was successfull
    
    See Also:
    
    install(String, String)
  - install
```
public boolean install(String urlPath,
                       String downloadPath)
```
    Download and install a JAR file from the given URL.
    
    Parameters:
    
    urlPath - the location from which to download the JAR
    
    downloadPath - the location in which to write the JAR; if this location already exists, it will be overwritten
    
    Returns:
    
    true if installation was successful

Class UpgradeChecker

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REGISTRY_IMAGEJ

REGISTRY_LIBRARY

STABLE_VERSION

CI_SERVER

TRUNK_BUILD

DAILY_BUILD

STABLE_BUILD

TOOLS

OLD_TOOLS

OME_TOOLS

INDIVIDUAL_JARS

REGISTRY

DEFAULT_CALLER

REGISTRY_PROPERTIES

UPGRADE_CHECK_PROPERTY

UPGRADE_CHECK_ALLOWED_PROPERTY

CHUNK_SIZE

LOGGER

Constructor Detail

UpgradeChecker

Method Detail

alreadyChecked

canDoUpgradeCheck

setCanDoUpgradeCheck

newVersionAvailable

newVersionAvailable

installIndividualJars

install