org.nuxeo.launcher.connect

Class ConnectBroker

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
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)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addDistributionPackages()
boolean	executePending(File commandsFile, boolean doExecute, boolean useResolver)
String	getCLID()
CommandSetInfo	getCommandSet()
org.nuxeo.connect.packages.PackageManager	getPackageManager()
List<org.nuxeo.connect.update.LocalPackage>	getPkgList()
StandaloneUpdateService	getUpdateService()
boolean	listPending(File commandsFile)
static String	parseAnswer(String answer)
boolean	pkgAdd(List<String> pkgsToAdd) Add a list of packages into the cache, downloading them if needed and possible.
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) Add a package file into the cache
org.nuxeo.connect.update.LocalPackage	pkgAdd(String packageFileName, boolean ignoreMissing) Add a package file into the cache
boolean	pkgHotfix()
boolean	pkgInstall(List<String> packageIdsToInstall) Install a list of local packages.
boolean	pkgInstall(List<String> packageIdsToInstall, boolean ignoreMissing) Install a list of local packages.
org.nuxeo.connect.update.LocalPackage	pkgInstall(String pkgId) Install a local package.
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)
boolean	pkgRequest(List<String> pkgsToAdd, List<String> pkgsToInstall, List<String> pkgsToUninstall, List<String> pkgsToRemove, boolean keepExisting)
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) Installs a list of packages and uninstalls the rest (no dependency check)
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()
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

equals, 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

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()

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)

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

public boolean pkgAdd(List<String> pkgsToAdd)

Add a list of packages into the cache, downloading them if needed and possible.

Parameters:

pkgsToAdd -

Returns:

true if command succeeded

See Also:

pkgAdd(String)

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)

pkgAdd

public org.nuxeo.connect.update.LocalPackage pkgAdd(String packageFileName)

Add a package file into the cache

Parameters:

packageFileName -

Returns:

The added LocalPackage or null if failed

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

pkgInstall

public boolean pkgInstall(List<String> packageIdsToInstall)

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(String)

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 unkown packages

Since:

6.0

See Also:

pkgInstall(String)

pkgInstall

public org.nuxeo.connect.update.LocalPackage pkgInstall(String pkgId)

Install a local package.

Parameters:

pkgId - Package ID or Name

Returns:

The installed LocalPackage or null if failed

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 unkown packages

Returns:

The installed LocalPackage or null if failed

Since:

6.0

listPending

public boolean listPending(File commandsFile)

executePending

public boolean executePending(File commandsFile,
                     boolean doExecute,
                     boolean useResolver)

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

pkgRequest

public boolean pkgRequest(List<String> pkgsToAdd,
                 List<String> pkgsToInstall,
                 List<String> pkgsToUninstall,
                 List<String> pkgsToRemove)

pkgRequest

public boolean pkgRequest(List<String> pkgsToAdd,
                 List<String> pkgsToInstall,
                 List<String> pkgsToUninstall,
                 List<String> pkgsToRemove,
                 boolean keepExisting)

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

public boolean pkgSet(List<String> pkgList)

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

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

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

setAllowSNAPSHOT

public void setAllowSNAPSHOT(boolean allow)

Since:

5.9.1