NuxeoLauncher (Nuxeo ECM Projects 9.10 API)

java.lang.Object
- org.nuxeo.launcher.NuxeoLauncher

Direct Known Subclasses:

NuxeoJettyLauncher, NuxeoTomcatLauncher
```
public abstract class NuxeoLauncher
extends Object
```
Since:

5.4.2

Author:

jcarsique

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class NuxeoLauncher.ShutdownThread

Nested Classes
Modifier and Type	Class and Description
`protected class`	`NuxeoLauncher.ShutdownThread`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`command`
`protected ConfigurationGenerator`	`configurationGenerator`
`static String`	`CONNECT_TC_URL`
`CommandSetInfo`	`cset`
`static int`	`EXIT_CODE_ERROR` Generic or unspecified error.
`static int`	`EXIT_CODE_INVALID` Invalid or excess argument(s).
`static int`	`EXIT_CODE_NOT_CONFIGURED` Program is not configured.
`static int`	`EXIT_CODE_NOT_INSTALLED` Program is not installed.
`static int`	`EXIT_CODE_NOT_RUNNING` Program is not running.
`static int`	`EXIT_CODE_OK`
`static int`	`EXIT_CODE_UNAUTHORIZED` User had insufficient privilege.
`static int`	`EXIT_CODE_UNIMPLEMENTED` Unimplemented feature.
`protected Process`	`nuxeoProcess`
`protected static String`	`OPTION_ACCEPT`
`protected static String`	`OPTION_CLID`
`protected static String`	`OPTION_DEBUG`
`protected static String`	`OPTION_DEBUG_CATEGORY`
`protected static String`	`OPTION_ENCRYPT`
`protected static String`	`OPTION_FORCE`
`protected static String`	`OPTION_GET`
`protected static String`	`OPTION_GET_REGEXP`
`protected static String`	`OPTION_GUI`
`protected static String`	`OPTION_GZIP_OUTPUT`
`protected static String`	`OPTION_HELP`
`protected static String`	`OPTION_HIDE_DEPRECATION`
`protected static String`	`OPTION_HIDE_DEPRECATION_DESC`
`protected static String`	`OPTION_IGNORE_MISSING`
`protected static String`	`OPTION_IGNORE_MISSING_DESC`
`protected static String`	`OPTION_JSON`
`protected static String`	`OPTION_NODEPS`
`protected static String`	`OPTION_OUTPUT`
`protected static String`	`OPTION_PRETTY_PRINT`
`protected static String`	`OPTION_QUIET`
`protected static String`	`OPTION_RELAX`
`protected static String`	`OPTION_RENEW`
`protected static String`	`OPTION_SET`
`protected static String`	`OPTION_SNAPSHOT`
`protected static String`	`OPTION_STRICT`
`protected static String`	`OPTION_XML`
`protected static String`	`OUTPUT_UNSET_VALUE`
`protected boolean`	`overrideJavaTmpDir`
`protected String[]`	`params`
`protected String`	`pid`
`protected ProcessManager`	`processManager`
`static int`	`STATUS_CODE_OFF` Program is not running.
`static int`	`STATUS_CODE_ON` Program is running or service is OK.
`static int`	`STATUS_CODE_UNKNOWN` Program or service status is unknown.

Constructor Summary

Constructors
Constructor and Description

NuxeoLauncher(ConfigurationGenerator configurationGenerator)

Constructors
Constructor and Description
`NuxeoLauncher(ConfigurationGenerator configurationGenerator)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`addShutdownHook()`
`protected String`	`addToClassPath(String cp, String filename)`
`void`	`checkNoRunningServer()` Check if some server is already running (from another thread) and throw a Runtime exception if it finds one.
`boolean`	`commandIs(String aCommand)`
`protected boolean`	`commandRequiresNoGUI()`
`protected boolean`	`commandRequiresNoRunningServer()`
`protected void`	`config()`
`void`	`configure()` Configure the server after checking installation
`static NuxeoLauncher`	`createLauncher(String[] args)`
`protected void`	`decrypt()`
`boolean`	`doStart()` Call `doStart(boolean)` with false as parameter.
`boolean`	`doStart(boolean logProcessOutput)` Starts the server in background.
`boolean`	`doStartAndWait()`
`boolean`	`doStartAndWait(boolean logProcessOutput)` Whereas `doStart()` considers the server as started when the process is running, `doStartAndWait()` waits for effective start by watching the logs
`protected boolean`	`dumpConnectReport(OutputStream out, boolean prettyprint)`
`protected void`	`encrypt()`
`protected abstract String`	`getClassPath()`
`protected String`	`getClassPath(String classpath, File baseDir)`
`String`	`getCommand()`
`protected void`	`getConfigProperties()`
`ConfigurationGenerator`	`getConfigurationGenerator()`
`protected ConnectBroker`	`getConnectBroker()`
`protected ConnectRegistrationBroker`	`getConnectRegistrationBroker()`
`int`	`getErrorValue()` Last error value set by any method.
`protected File[]`	`getFilename(File baseDir, String filePattern)`
`NuxeoLauncherGUI`	`getGUI()`
`InstanceInfo`	`getInfo()` Provides this instance info
`protected List<String>`	`getJavaOptsProperty(Function<String,String> mapper)` Gets the Java options defined in Nuxeo configuration files, e.g.
`File`	`getLogFile()`
`protected Collection<? extends String>`	`getNuxeoProperties()`
`protected abstract String`	`getServerPrint()`
`protected abstract Collection<? extends String>`	`getServerProperties()`
`protected abstract String`	`getShutdownClassPath()`
`String`	`getStartupSummary()`
`int`	`getStatus()` Last status value set by `status()`.
`String`	`getURL()`
`void`	`init()`
`protected void`	`initConnectBroker()`
`protected static org.apache.commons.cli.Options`	`initParserOptions()`
`boolean`	`isQuiet()`
`boolean`	`isRunning()` Work best with current nuxeoProcess.
`boolean`	`isStarted()`
`boolean`	`isUsingGui()`
`protected XMLStreamWriter`	`jsonWriter(JAXBContext context, OutputStream out)`
`static void`	`launch(NuxeoLauncher launcher)`
`ArrayList<ThreadedStreamGobbler>`	`logProcessStreams(Process process, boolean logProcessOutput)`
`static void`	`main(String[] args)`
`protected static OutputStream`	`openOutput(Path path, boolean gzip)`
`protected boolean`	`pack()` Since 5.5
`protected static org.apache.commons.cli.CommandLine`	`parseOptions(String[] args)`
`protected boolean`	`pkgAdd(String[] pkgNames)`
`protected boolean`	`pkgCompoundRequest(List<String> request)` Combined install/uninstall request
`protected boolean`	`pkgHotfix()` Install the hotfixes available for the instance
`protected boolean`	`pkgInit()` Add packages from the distribution to the local cache
`protected boolean`	`pkgInstall(String[] pkgIDs)`
`protected void`	`pkgList()` List all local packages.
`protected void`	`pkgListAll()` List all packages including remote ones.
`protected boolean`	`pkgPurge()` Uninstall and remove all packages from the local cache
`protected boolean`	`pkgRefreshCache()` Update the cached list of remote packages
`protected boolean`	`pkgRemove(String[] pkgIDs)`
`protected boolean`	`pkgRequest(List<String> pkgsToAdd, List<String> pkgsToInstall, List<String> pkgsToUninstall, List<String> pkgsToRemove)`
`protected boolean`	`pkgReset()`
`protected boolean`	`pkgSetRequest(List<String> request, boolean nodeps)`
`protected boolean`	`pkgShow(String[] packages)` dpkg-like command which returns package location, version, dependencies, conflicts, ...
`protected boolean`	`pkgUninstall(String[] pkgIDs)`
`protected boolean`	`pkgUpgrade()` Upgrade the Nuxeo Packages (addons) available for the instance
`protected void`	`printInstanceXMLOutput(InstanceInfo instance)`
`protected void`	`printInstanceXMLOutput(InstanceInfo instance, OutputStream out)`
`static void`	`printLongHelp()`
`static void`	`printShortHelp()`
`protected void`	`printXMLOutput()`
`protected void`	`printXMLOutput(JAXBContext jaxbContext, Object objectToOutput)`
`protected void`	`printXMLOutput(JAXBContext context, Object object, OutputStream out)`
`String`	`prompt(String message, Predicate<String> predicate, String error)` Prompt for a value read from the console or stdin.
`String`	`promptDescription()`
`String`	`promptEmail()` Prompts for a valid email address according to RFC 822 standards.
`org.nuxeo.connect.connector.NuxeoClientInstanceType`	`promptInstanceType()`
`char[]`	`promptPassword(boolean confirmation)`
`char[]`	`promptPassword(String message)`
`org.nuxeo.connect.data.ConnectProject`	`promptProject(List<org.nuxeo.connect.data.ConnectProject> projects)`
`boolean`	`register()` Register the instance, generating the CLID or using the passed one; or renew a registration.
`protected boolean`	`registerRemoteInstance()`
`protected boolean`	`registerRemoteInstance(String username, char[] password, org.nuxeo.connect.data.ConnectProject project, org.nuxeo.connect.connector.NuxeoClientInstanceType type, String description)`
`protected boolean`	`registerRenew()`
`protected boolean`	`registerSaveCLID()`
`boolean`	`registerTrial()` Deprecated. Since 9.3: To register for a free 30 day trial on Nuxeo Online Services, please visit https://connect.nuxeo.com/register
`protected void`	`removeShutdownHook()`
`protected void`	`setConfigProperties()`
`protected static void`	`setDebug(boolean activateDebug)`
`protected static void`	`setDebug(String categories)`
`protected static void`	`setDebug(String[] categories, String defaultCategory)`
`protected static void`	`setDebug(String categories, boolean activateDebug)`
`void`	`setGUI(NuxeoLauncherGUI gui)`
`protected void`	`setJSONOutput()`
`protected static void`	`setQuiet()` Set launcher in quiet mode
`protected abstract void`	`setServerStartCommand(List<String> command)`
`protected abstract void`	`setServerStopCommand(List<String> command)`
`protected static void`	`setStrict(boolean isStrict)`
`protected void`	`setXMLOutput()`
`protected void`	`showConfig()`
`protected void`	`start(boolean logProcessOutput)` Do not directly call this method without a call to `checkNoRunningServer()`
`protected boolean`	`startWizard()`
`String`	`status()` Return process status (running or not) as String, depending on OS capability to manage processes.
`void`	`stop()`
`void`	`stop(boolean logProcessOutput)` Stops the server.
`protected boolean`	`waitForEffectiveStart()`
`void`	`waitForProcessStreams(ArrayList<ThreadedStreamGobbler> sgArray)` Stop stream gobblers contained in the given ArrayList
`boolean`	`wasStartupFine()` Must be called after `getStartupSummary()`
`protected XMLStreamWriter`	`xmlWriter(JAXBContext context, OutputStream out)`

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

Field Detail
- OUTPUT_UNSET_VALUE
```
protected static final String OUTPUT_UNSET_VALUE
```
  Since:
  
  7.4
  
  See Also:
  
  Constant Field Values
- OPTION_NODEPS
```
protected static final String OPTION_NODEPS
```
  Since:
  
  5.6
  
  See Also:
  
  Constant Field Values
- OPTION_GUI
```
protected static final String OPTION_GUI
```
  Since:
  
  5.6
  
  See Also:
  
  Constant Field Values
- OPTION_JSON
```
protected static final String OPTION_JSON
```
  Since:
  
  5.6
  
  See Also:
  
  Constant Field Values
- OPTION_XML
```
protected static final String OPTION_XML
```
  Since:
  
  5.6
  
  See Also:
  
  Constant Field Values
- OPTION_DEBUG
```
protected static final String OPTION_DEBUG
```
  Since:
  
  5.6
  
  See Also:
  
  Constant Field Values
- OPTION_DEBUG_CATEGORY
```
protected static final String OPTION_DEBUG_CATEGORY
```
  Since:
  
  5.6
  
  See Also:
  
  Constant Field Values
- OPTION_QUIET
```
protected static final String OPTION_QUIET
```
  Since:
  
  5.6
  
  See Also:
  
  Constant Field Values
- OPTION_HELP
```
protected static final String OPTION_HELP
```
  Since:
  
  5.6
  
  See Also:
  
  Constant Field Values
- OPTION_RELAX
```
protected static final String OPTION_RELAX
```
  Since:
  
  5.6
  
  See Also:
  
  Constant Field Values
- OPTION_ACCEPT
```
protected static final String OPTION_ACCEPT
```
  Since:
  
  5.6
  
  See Also:
  
  Constant Field Values
- OPTION_SNAPSHOT
```
protected static final String OPTION_SNAPSHOT
```
  Since:
  
  5.9.1
  
  See Also:
  
  Constant Field Values
- OPTION_FORCE
```
protected static final String OPTION_FORCE
```
  Since:
  
  5.9.1
  
  See Also:
  
  Constant Field Values
- OPTION_STRICT
```
protected static final String OPTION_STRICT
```
  Since:
  
  7.4
  
  See Also:
  
  Constant Field Values
- OPTION_HIDE_DEPRECATION
```
protected static final String OPTION_HIDE_DEPRECATION
```
  Since:
  
  5.6
  
  See Also:
  
  Constant Field Values
- OPTION_HIDE_DEPRECATION_DESC
```
protected static final String OPTION_HIDE_DEPRECATION_DESC
```
  See Also:
  
  Constant Field Values
- OPTION_IGNORE_MISSING
```
protected static final String OPTION_IGNORE_MISSING
```
  Since:
  
  6.0
  
  See Also:
  
  Constant Field Values
- OPTION_IGNORE_MISSING_DESC
```
protected static final String OPTION_IGNORE_MISSING_DESC
```
  See Also:
  
  Constant Field Values
- OPTION_CLID
```
protected static final String OPTION_CLID
```
  Since:
  
  6.0
  
  See Also:
  
  Constant Field Values
- OPTION_RENEW
```
protected static final String OPTION_RENEW
```
  Since:
  
  8.10-HF15
  
  See Also:
  
  Constant Field Values
- OPTION_ENCRYPT
```
protected static final String OPTION_ENCRYPT
```
  Since:
  
  7.4
  
  See Also:
  
  Constant Field Values
- OPTION_SET
```
protected static final String OPTION_SET
```
  Since:
  
  7.4
  
  See Also:
  
  Constant Field Values
- OPTION_GET
```
protected static final String OPTION_GET
```
  Since:
  
  7.4
  
  See Also:
  
  Constant Field Values
- OPTION_GET_REGEXP
```
protected static final String OPTION_GET_REGEXP
```
  Since:
  
  7.4
  
  See Also:
  
  Constant Field Values
- OPTION_GZIP_OUTPUT
```
protected static final String OPTION_GZIP_OUTPUT
```
  Since:
  
  8.3
  
  See Also:
  
  Constant Field Values
- OPTION_OUTPUT
```
protected static final String OPTION_OUTPUT
```
  Since:
  
  8.3
  
  See Also:
  
  Constant Field Values
- OPTION_PRETTY_PRINT
```
protected static final String OPTION_PRETTY_PRINT
```
  Since:
  
  8.3
  
  See Also:
  
  Constant Field Values
- overrideJavaTmpDir
```
protected boolean overrideJavaTmpDir
```
- STATUS_CODE_ON
```
public static final int STATUS_CODE_ON
```
  Program is running or service is OK.
  
  Since:
  
  5.7
  
  See Also:
  
  Constant Field Values
- STATUS_CODE_OFF
```
public static final int STATUS_CODE_OFF
```
  Program is not running.
  
  Since:
  
  5.7
  
  See Also:
  
  Constant Field Values
- STATUS_CODE_UNKNOWN
```
public static final int STATUS_CODE_UNKNOWN
```
  Program or service status is unknown.
  
  Since:
  
  5.7
  
  See Also:
  
  Constant Field Values
- EXIT_CODE_OK
```
public static final int EXIT_CODE_OK
```
  Since:
  
  5.7
  
  See Also:
  
  Constant Field Values
- EXIT_CODE_ERROR
```
public static final int EXIT_CODE_ERROR
```
  Generic or unspecified error.
  
  Since:
  
  5.7
  
  See Also:
  
  Constant Field Values
- EXIT_CODE_INVALID
```
public static final int EXIT_CODE_INVALID
```
  Invalid or excess argument(s).
  
  Since:
  
  5.7
  
  See Also:
  
  Constant Field Values
- EXIT_CODE_UNIMPLEMENTED
```
public static final int EXIT_CODE_UNIMPLEMENTED
```
  Unimplemented feature.
  
  Since:
  
  5.7
  
  See Also:
  
  Constant Field Values
- EXIT_CODE_UNAUTHORIZED
```
public static final int EXIT_CODE_UNAUTHORIZED
```
  User had insufficient privilege.
  
  Since:
  
  5.7
  
  See Also:
  
  Constant Field Values
- EXIT_CODE_NOT_INSTALLED
```
public static final int EXIT_CODE_NOT_INSTALLED
```
  Program is not installed.
  
  Since:
  
  5.7
  
  See Also:
  
  Constant Field Values
- EXIT_CODE_NOT_CONFIGURED
```
public static final int EXIT_CODE_NOT_CONFIGURED
```
  Program is not configured.
  
  Since:
  
  5.7
  
  See Also:
  
  Constant Field Values
- EXIT_CODE_NOT_RUNNING
```
public static final int EXIT_CODE_NOT_RUNNING
```
  Program is not running.
  
  Since:
  
  5.7
  
  See Also:
  
  Constant Field Values
- CONNECT_TC_URL
```
public static final String CONNECT_TC_URL
```
  See Also:
  
  Constant Field Values
- configurationGenerator
```
protected ConfigurationGenerator configurationGenerator
```
- processManager
```
protected ProcessManager processManager
```
- nuxeoProcess
```
protected Process nuxeoProcess
```
- pid
```
protected String pid
```
- params
```
protected String[] params
```
- command
```
protected String command
```
- cset
```
public CommandSetInfo cset
```

Constructor Detail

NuxeoLauncher

public NuxeoLauncher(ConfigurationGenerator configurationGenerator)

Method Detail

commandRequiresNoRunningServer

protected boolean commandRequiresNoRunningServer()

Since:: 7.4

commandRequiresNoGUI

protected boolean commandRequiresNoGUI()

Since:: 7.4

getConfigurationGenerator

public final ConfigurationGenerator getConfigurationGenerator()

getCommand
```
public String getCommand()
```

commandIs

public boolean commandIs(String aCommand)

Since:: 7.4

isUsingGui
```
public boolean isUsingGui()
```
Since:

5.5

isQuiet
```
public boolean isQuiet()
```
Returns:

true if quiet mode is active

Since:

5.5

getGUI
```
public NuxeoLauncherGUI getGUI()
```
Since:

5.5

setGUI

public void setGUI(NuxeoLauncherGUI gui)

Since:: 5.5

init
```
public void init()
```
Since:

5.6

start
```
protected void start(boolean logProcessOutput)
              throws IOException,
                     InterruptedException
```
Do not directly call this method without a call to checkNoRunningServer()

Throws:

IOException - In case of issue with process.

InterruptedException - If any thread has interrupted the current thread.

See Also:

doStart()

getJavaOptsProperty
```
protected List<String> getJavaOptsProperty(Function<String,String> mapper)
```
Gets the Java options defined in Nuxeo configuration files, e.g. bin/nuxeo.conf and bin/nuxeoctl.

Returns:

the Java options.

checkNoRunningServer
```
public void checkNoRunningServer()
                          throws IllegalStateException
```
Check if some server is already running (from another thread) and throw a Runtime exception if it finds one. That method will work where isRunning() won't.

Throws:

IllegalThreadStateException - Thrown if a server is already running.

IllegalStateException

logProcessStreams

public ArrayList<ThreadedStreamGobbler> logProcessStreams(Process process,
                                                          boolean logProcessOutput)

Returns:: (since 5.5) Array list with created stream gobbler threads.

getServerPrint

protected abstract String getServerPrint()

getServerProperties

protected abstract Collection<? extends String> getServerProperties()

setServerStartCommand

protected abstract void setServerStartCommand(List<String> command)

getClassPath

protected abstract String getClassPath()

getShutdownClassPath

protected abstract String getShutdownClassPath()

Since:: 5.6

getNuxeoProperties

protected Collection<? extends String> getNuxeoProperties()

addToClassPath

protected String addToClassPath(String cp,
                                String filename)

initParserOptions

protected static org.apache.commons.cli.Options initParserOptions()

Since:: 5.6

parseOptions

protected static org.apache.commons.cli.CommandLine parseOptions(String[] args)
                                                          throws org.apache.commons.cli.ParseException

Throws:: org.apache.commons.cli.ParseException
Since:: 5.6

main

public static void main(String[] args)

launch

public static void launch(NuxeoLauncher launcher)
                   throws IOException,
                          org.nuxeo.connect.update.PackageException,
                          ConfigurationException,
                          org.apache.commons.cli.ParseException,
                          GeneralSecurityException

Throws:: IOException; org.nuxeo.connect.update.PackageException; ConfigurationException; org.apache.commons.cli.ParseException; GeneralSecurityException
Since:: 5.5

openOutput

protected static OutputStream openOutput(Path path,
                                         boolean gzip)
                                  throws IOException

Throws:: IOException

promptEmail
```
public String promptEmail()
                   throws IOException,
                          ConfigurationException
```
Prompts for a valid email address according to RFC 822 standards. The remote service may apply stricter constraints on email validation such as some black listed domains.

Returns:

the user input. Never null.

Throws:

ConfigurationException - If the user input is read from stdin and is null or does not match the regex

IOException

Since:

8.3

promptDescription

public String promptDescription()
                         throws ConfigurationException,
                                IOException

Throws:: ConfigurationException; IOException
Since:: 8.3

prompt
```
public String prompt(String message,
                     Predicate<String> predicate,
                     String error)
              throws IOException,
                     ConfigurationException
```
Prompt for a value read from the console or stdin.

Parameters:

message - message to display at prompt

predicate - a predicate that must match a correct user input. Ignored if null.

error - an error message to display or raise when the user input is null or does not match the regex

Returns:

the user input. Never null.

Throws:

ConfigurationException - If the user input is read from stdin and is null or does not match the regex

IOException

Since:

8.3

promptPassword

public char[] promptPassword(String message)
                      throws IOException

Parameters:: message - message to display at prompt
Throws:: IOException
Since:: 8.3

promptPassword

public char[] promptPassword(boolean confirmation)
                      throws IOException,
                             ConfigurationException

Parameters:: confirmation - if true, password is asked twice.
Throws:: IOException; ConfigurationException
Since:: 8.3

promptInstanceType

public org.nuxeo.connect.connector.NuxeoClientInstanceType promptInstanceType()
                                                                       throws IOException,
                                                                              ConfigurationException

Returns:: a NuxeoClientInstanceType. Never null.
Throws:: IOException; ConfigurationException
Since:: 8.3

promptProject

public org.nuxeo.connect.data.ConnectProject promptProject(@NotNull
                                                           List<org.nuxeo.connect.data.ConnectProject> projects)
                                                    throws ConfigurationException,
                                                           IOException,
                                                           org.nuxeo.connect.update.PackageException

Parameters:: projects - available projects the user must choose one amongst.
Returns:: a project. Never null.
Throws:: ConfigurationException - If projects is empty or if there is not such a project named as the parameter read from stdin.; IOException; org.nuxeo.connect.update.PackageException
Since:: 8.3

register

public boolean register()
                 throws IOException,
                        ConfigurationException,
                        org.nuxeo.connect.update.PackageException

 
 nuxeoctl register [<username> [<project> [<type> <description>] [pwd]]]

 nuxeoctl register --clid <file>

 nuxeoctl register --renew [--clid <file>]

Missing parameters are read from stdin.

Returns:: true if succeed
Throws:: IOException; ConfigurationException; org.nuxeo.connect.update.PackageException
Since:: 8.3

registerRenew

protected boolean registerRenew()
                         throws IOException,
                                org.nuxeo.connect.update.PackageException

Throws:: IOException; org.nuxeo.connect.update.PackageException

registerSaveCLID

protected boolean registerSaveCLID()
                            throws IOException,
                                   ConfigurationException,
                                   org.nuxeo.connect.update.PackageException

Throws:: IOException; ConfigurationException; org.nuxeo.connect.update.PackageException

registerRemoteInstance

protected boolean registerRemoteInstance()
                                  throws IOException,
                                         ConfigurationException,
                                         org.nuxeo.connect.update.PackageException

Throws:: IOException; ConfigurationException; org.nuxeo.connect.update.PackageException

registerRemoteInstance

protected boolean registerRemoteInstance(String username,
                                         char[] password,
                                         org.nuxeo.connect.data.ConnectProject project,
                                         org.nuxeo.connect.connector.NuxeoClientInstanceType type,
                                         String description)
                                  throws IOException,
                                         ConfigurationException,
                                         org.nuxeo.connect.update.PackageException

Throws:: IOException; ConfigurationException; org.nuxeo.connect.update.PackageException

registerTrial

@Deprecated
public boolean registerTrial()
                                  throws IOException,
                                         ConfigurationException,
                                         org.nuxeo.connect.update.PackageException

Deprecated. Since 9.3: To register for a free 30 day trial on Nuxeo Online Services, please visit https://connect.nuxeo.com/register

 
 nuxeoctl register-trial [ <first> <last> <email> <company> <project> ]

Throws:: IOException; ConfigurationException; org.nuxeo.connect.update.PackageException
Since:: 8.3

encrypt

protected void encrypt()
                throws ConfigurationException,
                       GeneralSecurityException

Throws:: ConfigurationException; GeneralSecurityException
Since:: 7.4

decrypt

protected void decrypt()
                throws ConfigurationException

Throws:: ConfigurationException
Since:: 7.4

config

protected void config()
               throws ConfigurationException,
                      IOException,
                      GeneralSecurityException

Throws:: ConfigurationException; IOException; GeneralSecurityException
Since:: 7.4

getConfigProperties
```
protected void getConfigProperties()
```
Since:

7.4

setConfigProperties

protected void setConfigProperties()
                            throws ConfigurationException,
                                   IOException,
                                   GeneralSecurityException

Throws:: ConfigurationException; IOException; GeneralSecurityException
Since:: 7.4

pack
```
protected boolean pack()
```
Since 5.5

startWizard

protected boolean startWizard()
                       throws org.nuxeo.connect.update.PackageException

Throws:: org.nuxeo.connect.update.PackageException

doStartAndWait

public boolean doStartAndWait()
                       throws org.nuxeo.connect.update.PackageException

Throws:: org.nuxeo.connect.update.PackageException
See Also:: doStartAndWait(boolean)

stop
```
public void stop()
```
See Also:

stop(boolean)

doStart
```
public boolean doStart()
                throws org.nuxeo.connect.update.PackageException
```
Call doStart(boolean) with false as parameter.

Returns:

true if the server started successfully

Throws:

org.nuxeo.connect.update.PackageException

See Also:

doStart(boolean)

doStartAndWait
```
public boolean doStartAndWait(boolean logProcessOutput)
                       throws org.nuxeo.connect.update.PackageException
```
Whereas doStart() considers the server as started when the process is running, doStartAndWait() waits for effective start by watching the logs

Parameters:

logProcessOutput - Must process output stream must be logged or not.

Returns:

true if the server started successfully

Throws:

org.nuxeo.connect.update.PackageException

removeShutdownHook
```
protected void removeShutdownHook()
```

waitForEffectiveStart

protected boolean waitForEffectiveStart()
                                 throws InterruptedException

Returns:: true if Nuxeo is ready
Throws:: InterruptedException

wasStartupFine
```
public boolean wasStartupFine()
```
Must be called after getStartupSummary()

Returns:

last detected status of running Nuxeo server

Since:

5.5

getStartupSummary
```
public String getStartupSummary()
```
Returns:

Nuxeo startup summary

Since:

5.5

doStart
```
public boolean doStart(boolean logProcessOutput)
                throws org.nuxeo.connect.update.PackageException
```
Starts the server in background.

Returns:

true if server successfully started

Throws:

org.nuxeo.connect.update.PackageException

printXMLOutput
```
protected void printXMLOutput()
```
Since:

5.6

printXMLOutput

protected void printXMLOutput(JAXBContext jaxbContext,
                              Object objectToOutput)

Since:: 5.6

printXMLOutput

protected void printXMLOutput(JAXBContext context,
                              Object object,
                              OutputStream out)
                       throws XMLStreamException,
                              FactoryConfigurationError,
                              JAXBException

Throws:: XMLStreamException; FactoryConfigurationError; JAXBException
Since:: 8.3

jsonWriter

protected XMLStreamWriter jsonWriter(JAXBContext context,
                                     OutputStream out)

xmlWriter

protected XMLStreamWriter xmlWriter(JAXBContext context,
                                    OutputStream out)
                             throws XMLStreamException,
                                    FactoryConfigurationError

Throws:: XMLStreamException; FactoryConfigurationError

waitForProcessStreams
```
public void waitForProcessStreams(ArrayList<ThreadedStreamGobbler> sgArray)
```
Stop stream gobblers contained in the given ArrayList

Since:

5.5

See Also:

logProcessStreams(Process, boolean)

getClassPath

protected String getClassPath(String classpath,
                              File baseDir)
                       throws IOException

Returns:: classpath with all jar files in baseDir
Throws:: IOException
Since:: 5.5

getFilename

protected File[] getFilename(File baseDir,
                             String filePattern)

Returns:: filename matching filePattern in baseDir
Since:: 5.5

addShutdownHook
```
protected void addShutdownHook()
```

stop
```
public void stop(boolean logProcessOutput)
```
Stops the server. Will try to call specific class for a clean stop, retry, waiting between each try, then kill the process if still running.

setServerStopCommand

protected abstract void setServerStopCommand(List<String> command)

configure
```
public void configure()
               throws ConfigurationException
```
Configure the server after checking installation

Throws:

ConfigurationException - If an installation error is detected or if configuration fails

status
```
public String status()
```
Return process status (running or not) as String, depending on OS capability to manage processes. Set status value following "http://refspecs.freestandards.org/LSB_4.1.0/LSB-Core-generic/LSB-Core- generic/iniscrptact.html"

See Also:

getStatus()

getStatus
```
public int getStatus()
```
Last status value set by status().

getErrorValue
```
public int getErrorValue()
```
Last error value set by any method. Exit code values are following the Linux Standard Base Core Specification 4.1.

createLauncher

public static NuxeoLauncher createLauncher(String[] args)
                                    throws ConfigurationException,
                                           org.apache.commons.cli.ParseException,
                                           IOException,
                                           org.nuxeo.connect.update.PackageException

Returns:: a NuxeoLauncher instance specific to current server ( Tomcat or Jetty).
Throws:: ConfigurationException - If server cannot be identified; org.apache.commons.cli.ParseException; IOException; org.nuxeo.connect.update.PackageException
Since:: 5.5

setQuiet
```
protected static void setQuiet()
```
Set launcher in quiet mode

Since:

5.5

setDebug

protected static void setDebug(String[] categories,
                               String defaultCategory)

Parameters:: categories - Root categories to switch DEBUG on.
Since:: 7.4

setDebug
```
protected static void setDebug(String categories)
```
Parameters:

categories - Root categories to switch DEBUG on.

Since:

5.6

setDebug
```
protected static void setDebug(String categories,
                               boolean activateDebug)
```
Parameters:

categories - Root categories to switch DEBUG on or off

activateDebug - Set DEBUG on or off.

Since:

5.6

setDebug
```
protected static void setDebug(boolean activateDebug)
```
Parameters:

activateDebug - if true, will activate the DEBUG logs

Since:

5.5

setStrict
```
protected static void setStrict(boolean isStrict)
```
Parameters:

isStrict - if true, set the launcher strict option

Since:

7.4

See Also:

OPTION_STRICT_DESC

setXMLOutput
```
protected void setXMLOutput()
```

setJSONOutput
```
protected void setJSONOutput()
```

printShortHelp
```
public static void printShortHelp()
```

printLongHelp
```
public static void printLongHelp()
```

isRunning
```
public boolean isRunning()
```
Work best with current nuxeoProcess. If nuxeoProcess is null or has exited, then will try to get process ID (so, result in that case depends on OS capabilities).

Returns:

true if current process is running or if a running PID is found

getInfo
```
public InstanceInfo getInfo()
```
Provides this instance info

Since:

8.3

isStarted
```
public boolean isStarted()
```
Returns:

true if Nuxeo finished starting

Since:

5.5

getLogFile
```
public File getLogFile()
```
Returns:

Server log file

getURL
```
public String getURL()
```
Returns:

Server URL

initConnectBroker

protected void initConnectBroker()
                          throws IOException,
                                 org.nuxeo.connect.update.PackageException

Throws:: IOException; org.nuxeo.connect.update.PackageException

getConnectBroker

protected ConnectBroker getConnectBroker()
                                  throws IOException,
                                         org.nuxeo.connect.update.PackageException

Throws:: IOException; org.nuxeo.connect.update.PackageException

getConnectRegistrationBroker

protected ConnectRegistrationBroker getConnectRegistrationBroker()
                                                          throws IOException,
                                                                 org.nuxeo.connect.update.PackageException

Throws:: IOException; org.nuxeo.connect.update.PackageException

pkgList

protected void pkgList()
                throws IOException,
                       org.nuxeo.connect.update.PackageException

List all local packages.

Throws:: IOException; org.nuxeo.connect.update.PackageException

pkgListAll

protected void pkgListAll()
                   throws IOException,
                          org.nuxeo.connect.update.PackageException

List all packages including remote ones.

Throws:: IOException; org.nuxeo.connect.update.PackageException
Since:: 5.6

pkgAdd

protected boolean pkgAdd(String[] pkgNames)
                  throws IOException,
                         org.nuxeo.connect.update.PackageException

Throws:: IOException; org.nuxeo.connect.update.PackageException

pkgInstall

protected boolean pkgInstall(String[] pkgIDs)
                      throws IOException,
                             org.nuxeo.connect.update.PackageException

Throws:: IOException; org.nuxeo.connect.update.PackageException

pkgUninstall

protected boolean pkgUninstall(String[] pkgIDs)
                        throws IOException,
                               org.nuxeo.connect.update.PackageException

Throws:: IOException; org.nuxeo.connect.update.PackageException

pkgRemove

protected boolean pkgRemove(String[] pkgIDs)
                     throws IOException,
                            org.nuxeo.connect.update.PackageException

Throws:: IOException; org.nuxeo.connect.update.PackageException

pkgReset

protected boolean pkgReset()
                    throws IOException,
                           org.nuxeo.connect.update.PackageException

Throws:: IOException; org.nuxeo.connect.update.PackageException

printInstanceXMLOutput

protected void printInstanceXMLOutput(InstanceInfo instance)

Since:: 5.6

printInstanceXMLOutput

protected void printInstanceXMLOutput(InstanceInfo instance,
                                      OutputStream out)
                               throws JAXBException,
                                      XMLStreamException,
                                      FactoryConfigurationError

Throws:: JAXBException; XMLStreamException; FactoryConfigurationError

showConfig

protected void showConfig()
                   throws IOException,
                          org.nuxeo.connect.update.PackageException,
                          ConfigurationException

Throws:: IOException; org.nuxeo.connect.update.PackageException; ConfigurationException
Since:: 5.6

pkgRequest

protected boolean pkgRequest(List<String> pkgsToAdd,
                             List<String> pkgsToInstall,
                             List<String> pkgsToUninstall,
                             List<String> pkgsToRemove)
                      throws IOException,
                             org.nuxeo.connect.update.PackageException

Returns:: true if request execution was fine
Throws:: IOException; org.nuxeo.connect.update.PackageException
Since:: 5.6

pkgRefreshCache

protected boolean pkgRefreshCache()
                           throws IOException,
                                  org.nuxeo.connect.update.PackageException

Update the cached list of remote packages

Returns:: true
Throws:: IOException; org.nuxeo.connect.update.PackageException
Since:: 5.6

pkgInit

protected boolean pkgInit()
                   throws IOException,
                          org.nuxeo.connect.update.PackageException

Add packages from the distribution to the local cache

Throws:: IOException; org.nuxeo.connect.update.PackageException
Since:: 5.6

pkgPurge

protected boolean pkgPurge()
                    throws org.nuxeo.connect.update.PackageException,
                           IOException

Uninstall and remove all packages from the local cache

Returns:: true if command succeed
Throws:: org.nuxeo.connect.update.PackageException; IOException
Since:: 5.6

pkgHotfix
```
protected boolean pkgHotfix()
                     throws IOException,
                            org.nuxeo.connect.update.PackageException
```
Install the hotfixes available for the instance

Returns:

true if command succeed

Throws:

IOException

org.nuxeo.connect.update.PackageException

Since:

5.6

pkgUpgrade
```
protected boolean pkgUpgrade()
                      throws IOException,
                             org.nuxeo.connect.update.PackageException
```
Upgrade the Nuxeo Packages (addons) available for the instance

Returns:

true if command succeed

Throws:

IOException

org.nuxeo.connect.update.PackageException

Since:

5.6

pkgCompoundRequest
```
protected boolean pkgCompoundRequest(List<String> request)
                              throws IOException,
                                     org.nuxeo.connect.update.PackageException
```
Combined install/uninstall request

Parameters:

request - Space separated list of package names or IDs prefixed with + (install) or - (uninstall)

Throws:

IOException

org.nuxeo.connect.update.PackageException

Since:

5.6

pkgSetRequest

protected boolean pkgSetRequest(List<String> request,
                                boolean nodeps)
                         throws IOException,
                                org.nuxeo.connect.update.PackageException

Throws:: IOException; org.nuxeo.connect.update.PackageException

pkgShow
```
protected boolean pkgShow(String[] packages)
                   throws IOException,
                          org.nuxeo.connect.update.PackageException
```
dpkg-like command which returns package location, version, dependencies, conflicts, ...

Parameters:

packages - List of packages identified by their ID, name or local filename.

Returns:

false if unable to show package information.

Throws:

IOException

org.nuxeo.connect.update.PackageException

Since:

5.7

dumpConnectReport

protected boolean dumpConnectReport(OutputStream out,
                                    boolean prettyprint)

Class NuxeoLauncher

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OUTPUT_UNSET_VALUE

OPTION_NODEPS

OPTION_GUI

OPTION_JSON

OPTION_XML

OPTION_DEBUG

OPTION_DEBUG_CATEGORY

OPTION_QUIET

OPTION_HELP

OPTION_RELAX

OPTION_ACCEPT

OPTION_SNAPSHOT

OPTION_FORCE

OPTION_STRICT

OPTION_HIDE_DEPRECATION

OPTION_HIDE_DEPRECATION_DESC

OPTION_IGNORE_MISSING

OPTION_IGNORE_MISSING_DESC

OPTION_CLID

OPTION_RENEW

OPTION_ENCRYPT

OPTION_SET

OPTION_GET

OPTION_GET_REGEXP

OPTION_GZIP_OUTPUT

OPTION_OUTPUT

OPTION_PRETTY_PRINT

overrideJavaTmpDir

STATUS_CODE_ON

STATUS_CODE_OFF

STATUS_CODE_UNKNOWN

EXIT_CODE_OK

EXIT_CODE_ERROR

EXIT_CODE_INVALID

EXIT_CODE_UNIMPLEMENTED

EXIT_CODE_UNAUTHORIZED

EXIT_CODE_NOT_INSTALLED

EXIT_CODE_NOT_CONFIGURED

EXIT_CODE_NOT_RUNNING

CONNECT_TC_URL

configurationGenerator

processManager

nuxeoProcess

pid

params

command

cset

Constructor Detail

NuxeoLauncher

Method Detail

commandRequiresNoRunningServer

commandRequiresNoGUI

getConfigurationGenerator

getCommand

commandIs

isUsingGui

isQuiet

getGUI

setGUI

init

start

getJavaOptsProperty

checkNoRunningServer

logProcessStreams

getServerPrint

getServerProperties

setServerStartCommand

getClassPath

getShutdownClassPath

getNuxeoProperties

addToClassPath

initParserOptions

parseOptions