org.nuxeo.launcher

Class NuxeoLauncher

java.lang.Object

org.nuxeo.launcher.NuxeoLauncher

Direct Known Subclasses:

NuxeoJBossLauncher, NuxeoJettyLauncher, NuxeoTomcatLauncher

public abstract class NuxeoLauncher
extends Object

Since:

5.4.2

Author:

jcarsique

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_RETRY_INTERVAL
static long	DEFAULT_RETRY_TIMEOUT

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()
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	printHelp() Print class usage on standard system output.
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

DEFAULT_RETRY_TIMEOUT

public static final long DEFAULT_RETRY_TIMEOUT

See Also:

Constant Field Values

DEFAULT_RETRY_INTERVAL

public static final long DEFAULT_RETRY_INTERVAL

See Also:

Constant Field Values

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

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

Throws:

ConfigurationException

launch

public static void launch(NuxeoLauncher launcher)

Parameters:

launcher -

launcherGUI -

command -

Since:

5.5

doStartAndWait

public boolean doStartAndWait()

See Also:

doStartAndWait(boolean)

stop

public void stop()

See Also:

stop(boolean)

doStart

public boolean doStart()

Call doStart(boolean) with false as parameter.

Returns:

true if the server started successfully

See Also:

doStart(boolean)

doStartAndWait

public 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

Parameters:

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

Returns:

true if the server started successfully

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)

Starts the server in background.

Returns:

true if server successfully started

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.

createLauncher

public static NuxeoLauncher createLauncher(String[] args)
                                    throws ConfigurationException

Parameters:

args - Program arguments

Returns:

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

Throws:

ConfigurationException - If server cannot be identified

Since:

5.5

printHelp

public static void printHelp()

Print class usage on standard system output.

Throws:

URISyntaxException

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