ConnectBroker (Nuxeo ECM Projects 8.1-SNAPSHOT API)

java.lang.Object
- org.nuxeo.launcher.connect.ConnectBroker

public class ConnectBroker
extends Object

Since:: 5.6

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DISTRIBUTION_MP_DIR_DEFAULT`
`protected static int`	`LAUNCHER_CHANGED_EXIT_CODE`
`protected static String`	`LAUNCHER_CHANGED_PROPERTY`
`static String`	`OPTION_ACCEPT_DEFAULT`
`static String`	`OPTION_RELAX_DEFAULT`
`static String`	`PACKAGES_XML`
`static String`	`PARAM_MP_DIR`
`static String[]`	`POSITIVE_ANSWERS`

Constructor Summary

Constructors
Constructor and Description

ConnectBroker(Environment env)

Constructors
Constructor and Description
`ConnectBroker(Environment env)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected boolean`	`addDistributionPackage(String md5)`
`boolean`	`addDistributionPackages()`
`protected boolean`	`downloadPackages(List<String> packagesToDownload)`
`boolean`	`executePending(File commandsFile, boolean doExecute, boolean useResolver, boolean ignoreMissing)`
`protected org.nuxeo.connect.update.Package`	`findPackage(String pkg)` Looks for a package.
`protected List<String>`	`getAllLocalPackageIdsFromName(String pkgName)`
`protected String`	`getBestIdForNameInList(String pkgName, List<? extends org.nuxeo.connect.update.Package> pkgList)`
`String`	`getCLID()`
`CommandSetInfo`	`getCommandSet()`
`protected Map<String,org.nuxeo.connect.update.model.PackageDefinition>`	`getDistributionDefinitions(List<String> md5Filenames)`
`protected List<String>`	`getDistributionFilenames()`
`protected org.nuxeo.connect.update.LocalPackage`	`getInstalledPackage(String pkgName)`
`protected String`	`getInstalledPackageIdFromName(String pkgName)`
`protected org.nuxeo.connect.update.LocalPackage`	`getLocalPackage(String pkgIdOrName)` Looks for a local package from its name or id
`protected File`	`getLocalPackageFile(String pkgFile)` Looks for a package file from its path
`protected String`	`getLocalPackageIdFromName(String pkgName)`
`org.nuxeo.connect.packages.PackageManager`	`getPackageManager()`
`List<org.nuxeo.connect.update.LocalPackage>`	`getPkgList()`
`protected String`	`getRemotePackageId(String pkgNameOrId)` Looks for a remote package from its name or id
`protected String`	`getRemotePackageIdFromName(String pkgName)`
`StandaloneUpdateService`	`getUpdateService()`
`protected boolean`	`isInstalledPackage(String pkgName)`
`protected boolean`	`isLocalPackageFile(String pkgFile)`
`protected boolean`	`isLocalPackageId(String pkgId)`
`protected boolean`	`isRemotePackageId(String pkgId)`
`boolean`	`listPending(File commandsFile)`
`static String`	`parseAnswer(String answer)`
`protected void`	`performTask(org.nuxeo.connect.update.task.Task task)`
`boolean`	`pkgAdd(List<String> pkgsToAdd)` Deprecated. Since 7.10. Use a method with an explicit value for `ignoreMissing`.
`boolean`	`pkgAdd(List<String> pkgsToAdd, boolean ignoreMissing)` Add a list of packages into the cache, downloading them if needed and possible.
`org.nuxeo.connect.update.LocalPackage`	`pkgAdd(String packageFileName)` Deprecated. Since 7.10. Use a method with an explicit value for `ignoreMissing`.
`org.nuxeo.connect.update.LocalPackage`	`pkgAdd(String packageFileName, boolean ignoreMissing)` Add a package file into the cache
`boolean`	`pkgHotfix()`
`boolean`	`pkgInstall(List<String> packageIdsToInstall)` Deprecated. Since 7.10. Use a method with an explicit value for `ignoreMissing`.
`boolean`	`pkgInstall(List<String> packageIdsToInstall, boolean ignoreMissing)` Install a list of local packages.
`org.nuxeo.connect.update.LocalPackage`	`pkgInstall(String pkgId)` Deprecated. Since 7.10. Use a method with an explicit value for `ignoreMissing`.
`org.nuxeo.connect.update.LocalPackage`	`pkgInstall(String pkgId, boolean ignoreMissing)` Install a local package.
`void`	`pkgList()`
`void`	`pkgList(List<? extends org.nuxeo.connect.update.Package> packagesList)`
`void`	`pkgListAll()`
`boolean`	`pkgPurge()`
`boolean`	`pkgRemove(List<String> pkgsToRemove)` Remove a list of packages from cache.
`org.nuxeo.connect.update.LocalPackage`	`pkgRemove(String pkgId)` Remove a package from cache.
`boolean`	`pkgRequest(List<String> pkgsToAdd, List<String> pkgsToInstall, List<String> pkgsToUninstall, List<String> pkgsToRemove)` Deprecated. Since 7.10. Use `pkgRequest(List, List, List, List, boolean, boolean)` instead.
`boolean`	`pkgRequest(List<String> pkgsToAdd, List<String> pkgsToInstall, List<String> pkgsToUninstall, List<String> pkgsToRemove, boolean keepExisting)` Deprecated. Since 7.10. Use `pkgRequest(List, List, List, List, boolean, boolean)` instead.
`boolean`	`pkgRequest(List<String> pkgsToAdd, List<String> pkgsToInstall, List<String> pkgsToUninstall, List<String> pkgsToRemove, boolean keepExisting, boolean ignoreMissing)`
`boolean`	`pkgReset()`
`boolean`	`pkgSet(List<String> pkgList)` Deprecated. Since 7.10. Use #pkgSet(List, boolean) instead.
`boolean`	`pkgSet(List<String> pkgList, boolean ignoreMissing)` Installs a list of packages and uninstalls the rest (no dependency check)
`boolean`	`pkgShow(List<String> packages)`
`boolean`	`pkgUninstall(List<String> packageIdsToRemove)` Uninstall a list of packages.
`org.nuxeo.connect.update.LocalPackage`	`pkgUninstall(String pkgId)` Uninstall a local package.
`boolean`	`pkgUpgrade()`
`protected boolean`	`pkgUpgradeByType(org.nuxeo.connect.update.PackageType type)`
`protected String`	`readConsole(String message, String defaultValue, Object... objects)` Prompt user for yes/no answer
`void`	`refreshCache()`
`void`	`setAccept(String acceptValue)`
`void`	`setAllowSNAPSHOT(boolean allow)`
`void`	`setCLID(String file)`
`void`	`setRelax(String relaxValue)` Must be called after `setAccept(String)` which overwrites its value.

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

- Field Detail
  - PARAM_MP_DIR
```
public static final String PARAM_MP_DIR
```
    See Also:
    
    Constant Field Values
  - DISTRIBUTION_MP_DIR_DEFAULT
```
public static final String DISTRIBUTION_MP_DIR_DEFAULT
```
    See Also:
    
    Constant Field Values
  - PACKAGES_XML
```
public static final String PACKAGES_XML
```
    See Also:
    
    Constant Field Values
  - LAUNCHER_CHANGED_PROPERTY
```
protected static final String LAUNCHER_CHANGED_PROPERTY
```
    See Also:
    
    Constant Field Values
  - LAUNCHER_CHANGED_EXIT_CODE
```
protected static final int LAUNCHER_CHANGED_EXIT_CODE
```
    See Also:
    
    Constant Field Values
  - POSITIVE_ANSWERS
```
public static final String[] POSITIVE_ANSWERS
```
  - OPTION_RELAX_DEFAULT
```
public static final String OPTION_RELAX_DEFAULT
```
    See Also:
    
    Constant Field Values
  - OPTION_ACCEPT_DEFAULT
```
public static final String OPTION_ACCEPT_DEFAULT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ConnectBroker
```
public ConnectBroker(Environment env)
              throws IOException,
                     org.nuxeo.connect.update.PackageException
```
    Throws:
    
    IOException
    
    org.nuxeo.connect.update.PackageException
- Method Detail
  - getCLID
```
public String getCLID()
               throws org.nuxeo.connect.identity.LogicalInstanceIdentifier.NoCLID
```
    Throws:
    
    org.nuxeo.connect.identity.LogicalInstanceIdentifier.NoCLID
  - setCLID
```
public void setCLID(String file)
             throws org.nuxeo.connect.identity.LogicalInstanceIdentifier.NoCLID
```
    Throws:
    
    org.nuxeo.connect.identity.LogicalInstanceIdentifier.NoCLID
    
    Since:
    
    6.0
  - getUpdateService
```
public StandaloneUpdateService getUpdateService()
```
  - getPackageManager
```
public org.nuxeo.connect.packages.PackageManager getPackageManager()
```
  - refreshCache
```
public void refreshCache()
```
  - getCommandSet
```
public CommandSetInfo getCommandSet()
```
  - getInstalledPackage
```
protected org.nuxeo.connect.update.LocalPackage getInstalledPackage(String pkgName)
```
  - isInstalledPackage
```
protected boolean isInstalledPackage(String pkgName)
```
  - isLocalPackageId
```
protected boolean isLocalPackageId(String pkgId)
```
  - isRemotePackageId
```
protected boolean isRemotePackageId(String pkgId)
```
  - getBestIdForNameInList
```
protected String getBestIdForNameInList(String pkgName,
                                        List<? extends org.nuxeo.connect.update.Package> pkgList)
```
  - getLocalPackageIdFromName
```
protected String getLocalPackageIdFromName(String pkgName)
```
  - getAllLocalPackageIdsFromName
```
protected List<String> getAllLocalPackageIdsFromName(String pkgName)
```
  - getInstalledPackageIdFromName
```
protected String getInstalledPackageIdFromName(String pkgName)
```
  - getRemotePackageIdFromName
```
protected String getRemotePackageIdFromName(String pkgName)
```
  - getRemotePackageId
```
protected String getRemotePackageId(String pkgNameOrId)
```
    Looks for a remote package from its name or id
    
    Parameters:
    
    pkgNameOrId -
    
    Returns:
    
    the remote package Id; null if not found
    
    Since:
    
    5.7
  - getLocalPackage
```
protected org.nuxeo.connect.update.LocalPackage getLocalPackage(String pkgIdOrName)
                                                         throws org.nuxeo.connect.update.PackageException
```
    Looks for a local package from its name or id
    
    Parameters:
    
    pkgIdOrName -
    
    Returns:
    
    the local package Id; null if not found
    
    Throws:
    
    org.nuxeo.connect.update.PackageException
    
    Since:
    
    5.7
  - getLocalPackageFile
```
protected File getLocalPackageFile(String pkgFile)
```
    Looks for a package file from its path
    
    Parameters:
    
    pkgFile - Absolute or relative package file path
    
    Returns:
    
    the file if found, else null
  - isLocalPackageFile
```
protected boolean isLocalPackageFile(String pkgFile)
```
  - getDistributionFilenames
```
protected List<String> getDistributionFilenames()
```
  - getDistributionDefinitions
```
protected Map<String,org.nuxeo.connect.update.model.PackageDefinition> getDistributionDefinitions(List<String> md5Filenames)
```
  - addDistributionPackage
```
protected boolean addDistributionPackage(String md5)
```
  - addDistributionPackages
```
public boolean addDistributionPackages()
```
  - getPkgList
```
public List<org.nuxeo.connect.update.LocalPackage> getPkgList()
```
  - pkgList
```
public void pkgList()
```
  - pkgListAll
```
public void pkgListAll()
```
  - pkgList
```
public void pkgList(List<? extends org.nuxeo.connect.update.Package> packagesList)
```
  - performTask
```
protected void performTask(org.nuxeo.connect.update.task.Task task)
                    throws org.nuxeo.connect.update.PackageException
```
    Throws:
    
    org.nuxeo.connect.update.PackageException
  - pkgReset
```
public boolean pkgReset()
```
  - pkgPurge
```
public boolean pkgPurge()
                 throws org.nuxeo.connect.update.PackageException
```
    Throws:
    
    org.nuxeo.connect.update.PackageException
  - pkgUninstall
```
public boolean pkgUninstall(List<String> packageIdsToRemove)
```
    Uninstall a list of packages. If the list contains a package name (versus an ID), only the considered as best matching package is uninstalled.
    
    Parameters:
    
    packageIdsToRemove - The list can contain package IDs and names
    
    See Also:
    
    pkgUninstall(String)
  - pkgUninstall
```
public org.nuxeo.connect.update.LocalPackage pkgUninstall(String pkgId)
```
    Uninstall a local package. The package is not removed from cache.
    
    Parameters:
    
    pkgId - Package ID or Name
    
    Returns:
    
    The uninstalled LocalPackage or null if failed
  - pkgRemove
```
public boolean pkgRemove(List<String> pkgsToRemove)
```
    Remove a list of packages from cache. If the list contains a package name (versus an ID), all matching packages are removed.
    
    Parameters:
    
    pkgsToRemove - The list can contain package IDs and names
    
    See Also:
    
    pkgRemove(String)
  - pkgRemove
```
public org.nuxeo.connect.update.LocalPackage pkgRemove(String pkgId)
```
    Remove a package from cache. If it was installed, the package is uninstalled then removed.
    
    Parameters:
    
    pkgId - Package ID or Name
    
    Returns:
    
    The removed LocalPackage or null if failed
  - pkgAdd
```
@Deprecated
public boolean pkgAdd(List<String> pkgsToAdd)
```
    Deprecated. Since 7.10. Use a method with an explicit value for ignoreMissing.
    
    Add a list of packages into the cache, downloading them if needed and possible.
    
    Parameters:
    
    pkgsToAdd -
    
    Returns:
    
    true if command succeeded
    
    See Also:
    
    pkgAdd(List, boolean), pkgAdd(String, boolean)
  - pkgAdd
```
public boolean pkgAdd(List<String> pkgsToAdd,
                      boolean ignoreMissing)
```
    Add a list of packages into the cache, downloading them if needed and possible.
    
    Parameters:
    
    pkgsToAdd -
    
    ignoreMissing -
    
    Returns:
    
    true if command succeeded
    
    Since:
    
    6.0
    
    See Also:
    
    pkgAdd(String, boolean)
  - pkgAdd
```
@Deprecated
public org.nuxeo.connect.update.LocalPackage pkgAdd(String packageFileName)
```
    Deprecated. Since 7.10. Use a method with an explicit value for ignoreMissing.
    
    Add a package file into the cache
    
    Parameters:
    
    packageFileName -
    
    Returns:
    
    The added LocalPackage or null if failed
    
    See Also:
    
    pkgAdd(List, boolean), pkgAdd(String, boolean)
  - pkgAdd
```
public org.nuxeo.connect.update.LocalPackage pkgAdd(String packageFileName,
                                                    boolean ignoreMissing)
```
    Add a package file into the cache
    
    Parameters:
    
    packageFileName -
    
    ignoreMissing -
    
    Returns:
    
    The added LocalPackage or null if failed
    
    Since:
    
    6.0
    
    See Also:
    
    pkgAdd(List, boolean)
  - pkgInstall
```
@Deprecated
public boolean pkgInstall(List<String> packageIdsToInstall)
```
    Deprecated. Since 7.10. Use a method with an explicit value for ignoreMissing.
    
    Install a list of local packages. If the list contains a package name (versus an ID), only the considered as best matching package is installed.
    
    Parameters:
    
    packageIdsToInstall - The list can contain package IDs and names
    
    See Also:
    
    pkgInstall(List, boolean), pkgInstall(String, boolean)
  - pkgInstall
```
public boolean pkgInstall(List<String> packageIdsToInstall,
                          boolean ignoreMissing)
```
    Install a list of local packages. If the list contains a package name (versus an ID), only the considered as best matching package is installed.
    
    Parameters:
    
    packageIdsToInstall - The list can contain package IDs and names
    
    ignoreMissing - If true, doesn't throw an exception on unknown packages
    
    Since:
    
    6.0
    
    See Also:
    
    pkgInstall(String, boolean)
  - pkgInstall
```
@Deprecated
public org.nuxeo.connect.update.LocalPackage pkgInstall(String pkgId)
```
    Deprecated. Since 7.10. Use a method with an explicit value for ignoreMissing.
    
    Install a local package.
    
    Parameters:
    
    pkgId - Package ID or Name
    
    Returns:
    
    The installed LocalPackage or null if failed
    
    See Also:
    
    pkgInstall(List, boolean), pkgInstall(String, boolean)
  - pkgInstall
```
public org.nuxeo.connect.update.LocalPackage pkgInstall(String pkgId,
                                                        boolean ignoreMissing)
```
    Install a local package.
    
    Parameters:
    
    pkgId - Package ID or Name
    
    ignoreMissing - If true, doesn't throw an exception on unknown packages
    
    Returns:
    
    The installed LocalPackage or null if failed
    
    Since:
    
    6.0
    
    See Also:
    
    pkgInstall(List, boolean)
  - listPending
```
public boolean listPending(File commandsFile)
```
  - executePending
```
public boolean executePending(File commandsFile,
                              boolean doExecute,
                              boolean useResolver,
                              boolean ignoreMissing)
```
    Parameters:
    
    commandsFile - File containing the commands to execute
    
    doExecute - Whether to execute or list the actions
    
    useResolver - Whether to use full resolution or just execute individual actions
    
    Since:
    
    5.6
  - downloadPackages
```
protected boolean downloadPackages(List<String> packagesToDownload)
```
  - pkgRequest
```
@Deprecated
public boolean pkgRequest(List<String> pkgsToAdd,
                                      List<String> pkgsToInstall,
                                      List<String> pkgsToUninstall,
                                      List<String> pkgsToRemove)
```
    Deprecated. Since 7.10. Use pkgRequest(List, List, List, List, boolean, boolean) instead.
  - pkgRequest
```
@Deprecated
public boolean pkgRequest(List<String> pkgsToAdd,
                                      List<String> pkgsToInstall,
                                      List<String> pkgsToUninstall,
                                      List<String> pkgsToRemove,
                                      boolean keepExisting)
```
    Deprecated. Since 7.10. Use pkgRequest(List, List, List, List, boolean, boolean) instead.
    
    Parameters:
    
    keepExisting - If false, the request will remove existing packages that are not part of the resolution
    
    Since:
    
    5.9.2
  - pkgRequest
```
public boolean pkgRequest(List<String> pkgsToAdd,
                          List<String> pkgsToInstall,
                          List<String> pkgsToUninstall,
                          List<String> pkgsToRemove,
                          boolean keepExisting,
                          boolean ignoreMissing)
```
    Parameters:
    
    keepExisting - If false, the request will remove existing packages that are not part of the resolution
    
    ignoreMissing - Do not error out on missing packages, just handle the rest
    
    Since:
    
    5.9.2
  - pkgSet
```
@Deprecated
public boolean pkgSet(List<String> pkgList)
```
    Deprecated. Since 7.10. Use #pkgSet(List, boolean) instead.
    
    Installs a list of packages and uninstalls the rest (no dependency check)
    
    Since:
    
    5.9.2
  - pkgSet
```
public boolean pkgSet(List<String> pkgList,
                      boolean ignoreMissing)
```
    Installs a list of packages and uninstalls the rest (no dependency check)
    
    Since:
    
    6.0
  - readConsole
```
protected String readConsole(String message,
                             String defaultValue,
                             Object... objects)
```
    Prompt user for yes/no answer
    
    Parameters:
    
    message - The message to display
    
    defaultValue - The default answer if there's no console or if "Enter" key is pressed.
    
    objects - Parameters to use in the message (like in String.format(String, Object...))
    
    Returns:
    
    "true" if answer is in POSITIVE_ANSWERS, else return "false"
  - parseAnswer
```
public static String parseAnswer(String answer)
```
    Returns:
    
    "true" if answer is in POSITIVE_ANSWERS, and "ask" if answer values "ask", else return "false"
    
    Since:
    
    6.0
  - pkgUpgradeByType
```
protected boolean pkgUpgradeByType(org.nuxeo.connect.update.PackageType type)
```
  - pkgHotfix
```
public boolean pkgHotfix()
```
  - pkgUpgrade
```
public boolean pkgUpgrade()
```
  - setRelax
```
public void setRelax(String relaxValue)
```
    Must be called after setAccept(String) which overwrites its value.
    
    Parameters:
    
    relaxValue - true, false or ask; ignored if null
  - setAccept
```
public void setAccept(String acceptValue)
```
    Parameters:
    
    acceptValue - true, false or ask; if true or ask, then calls setRelax(String) with the same value; ignored if null
  - pkgShow
```
public boolean pkgShow(List<String> packages)
```
    Parameters:
    
    packages - List of packages identified by their ID, name or local filename.
    
    Since:
    
    5.7
  - findPackage
```
protected org.nuxeo.connect.update.Package findPackage(String pkg)
                                                throws org.nuxeo.connect.update.PackageException
```
    Looks for a package. First look if it's a local ZIP file, second if it's a local package and finally if it's a remote package.
    
    Parameters:
    
    pkg - A ZIP filename or file path, or package ID or a package name.
    
    Returns:
    
    The first package found matching the given string.
    
    Throws:
    
    org.nuxeo.connect.update.PackageException - If no package is found or if an issue occurred while searching.
    
    See Also:
    
    PackageDefinition, LocalPackage, DownloadablePackage
  - setAllowSNAPSHOT
```
public void setAllowSNAPSHOT(boolean allow)
```
    Since:
    
    5.9.1

Class ConnectBroker

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PARAM_MP_DIR

DISTRIBUTION_MP_DIR_DEFAULT

PACKAGES_XML

LAUNCHER_CHANGED_PROPERTY

LAUNCHER_CHANGED_EXIT_CODE

POSITIVE_ANSWERS

OPTION_RELAX_DEFAULT

OPTION_ACCEPT_DEFAULT

Constructor Detail

ConnectBroker

Method Detail

getCLID

setCLID

getUpdateService

getPackageManager

refreshCache

getCommandSet

getInstalledPackage

isInstalledPackage

isLocalPackageId

isRemotePackageId

getBestIdForNameInList

getLocalPackageIdFromName

getAllLocalPackageIdsFromName

getInstalledPackageIdFromName

getRemotePackageIdFromName

getRemotePackageId

getLocalPackage

getLocalPackageFile

isLocalPackageFile

getDistributionFilenames

getDistributionDefinitions

addDistributionPackage

addDistributionPackages

getPkgList

pkgList

pkgListAll

pkgList

performTask

pkgReset

pkgPurge

pkgUninstall

pkgUninstall

pkgRemove

pkgRemove

pkgAdd

pkgAdd

pkgAdd

pkgAdd

pkgInstall

pkgInstall

pkgInstall

pkgInstall

listPending

executePending

downloadPackages

pkgRequest

pkgRequest

pkgRequest

pkgSet

pkgSet

readConsole

parseAnswer

pkgUpgradeByType

pkgHotfix

pkgUpgrade

setRelax

setAccept

pkgShow

findPackage

setAllowSNAPSHOT