org.nuxeo.launcher

Class NuxeoLauncher

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
static class	NuxeoLauncher.SolarisProcessManager

Field Summary

Fields

Modifier and Type	Field and Description
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.
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)

Method Summary

Methods

Modifier and Type	Method and Description
void	checkNoRunningServer() Check if some server is already running (from another thread) and throw a Runtime exception if it finds one.
void	configure() Configure the server after checking installation
static NuxeoLauncher	createLauncher(String[] args)
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
String	getCommand()
ConfigurationGenerator	getConfigurationGenerator()
int	getErrorValue() Last error value set by any method.
NuxeoLauncherGUI	getGUI()
File	getLogFile()
String	getStartupSummary()
int	getStatus() Last status value set by status().
String	getURL()
void	init()
boolean	isQuiet()
boolean	isRunning() Work best with current nuxeoProcess.
boolean	isStarted()
boolean	isUsingGui()
static void	launch(NuxeoLauncher launcher)
ArrayList<ThreadedStreamGobbler>	logProcessStreams(Process process, boolean logProcessOutput)
static void	main(String[] args)
static void	printLongHelp()
static void	printShortHelp()
void	setGUI(NuxeoLauncherGUI gui)
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.
void	waitForProcessStreams(ArrayList<ThreadedStreamGobbler> sgArray) Stop stream gobblers contained in the given ArrayList
boolean	wasStartupFine() Must be called after getStartupSummary()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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

cset

public CommandSetInfo cset

Constructor Detail

NuxeoLauncher

public NuxeoLauncher(ConfigurationGenerator configurationGenerator)

Method Detail

getConfigurationGenerator

public final ConfigurationGenerator getConfigurationGenerator()

getCommand

public String getCommand()

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

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.

main

public static void main(String[] args)

launch

public static void launch(NuxeoLauncher launcher)
                   throws IOException,
                          org.nuxeo.connect.update.PackageException

Parameters:

launcher -

launcherGUI -

command -

Throws:

org.nuxeo.connect.update.PackageException

IOException

Since:

5.5

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

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

Throws:

SocketTimeoutException - if Nuxeo server is not responding

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

waitForProcessStreams

public void waitForProcessStreams(ArrayList<ThreadedStreamGobbler> sgArray)

Stop stream gobblers contained in the given ArrayList

Throws:

InterruptedException

Since:

5.5

See Also:

logProcessStreams(Process, boolean)

stop

public void stop(boolean logProcessOutput)

Stops the server. Will try to call specific class for a clean stop, retry STOP_NB_TRY, waiting STOP_SECONDS_BEFORE_NEXT_TRY between each try, then kill the process if still running.

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:

status

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

Returns:

a NuxeoLauncher instance specific to current server ( Tomcat or Jetty).

Throws:

org.apache.commons.cli.ParseException

ConfigurationException - If server cannot be identified

Since:

5.5

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

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