Package com.github.mike10004.xvfbmanager

Class DefaultXvfbController

java.lang.Object

com.github.mike10004.xvfbmanager.DefaultXvfbController

All Implemented Interfaces:

XvfbController, Closeable, AutoCloseable

public class DefaultXvfbController
extends Object
implements XvfbController

Default controller implementation. This implementation relies on a future to listen to the status of the Xvfb process. It checks for a given window by executing xwininfo in pollForWindow(Predicate, long, int). Most other operations are handled by the service classes provided in the constructor.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	DefaultXvfbController.XLockFileChecker

Nested classes/interfaces inherited from interface com.github.mike10004.xvfbmanager.XvfbController

XvfbController.XWindow

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_MAX_NUM_POLLS	Default max number of polls for waitUntilReady()}.
static long	DEFAULT_POLL_INTERVAL_MS	Default poll interval for waitUntilReady()}.
protected static long	LOCK_FILE_CLEANUP_POLL_INTERVAL_MS
protected static long	LOCK_FILE_CLEANUP_TIMEOUT_MS

Fields inherited from interface com.github.mike10004.xvfbmanager.XvfbController

ENV_DISPLAY

Constructor Summary

Constructors

Modifier	Constructor	Description
	DefaultXvfbController(io.github.mike10004.subprocess.ProcessMonitor<?,?> xvfbMonitor, String display, XvfbManager.DisplayReadinessChecker displayReadinessChecker, Screenshooter<?> screenshooter, Sleeper sleeper)
protected	DefaultXvfbController(io.github.mike10004.subprocess.ProcessMonitor<?,?> xvfbMonitor, String display, XvfbManager.DisplayReadinessChecker displayReadinessChecker, Screenshooter<?> screenshooter, Sleeper sleeper, DefaultXvfbController.XLockFileChecker lockFileChecker)

Method Summary

Modifier and Type	Method	Description
void	close()	Invokes stop().
Map<String,String>	configureEnvironment(Map<String,String> environment)	Sets the display environment variable in the given environment.
protected Map<String,String>	createEmptyMutableMap()
String	getDisplay()	Gets the display number in the format :N where N is the display number.
static Iterable<String>	getRequiredPrograms()
Screenshooter<?>	getScreenshooter()	Captures a screenshot of the virtual framebuffer.
Map<String,String>	newEnvironment()	Creates a new, mutable environment variable map with the display variable set.
Optional<TreeNode<XvfbController.XWindow>>	pollForWindow(Predicate<XvfbController.XWindow> windowFinder, long intervalMs, int maxPollAttempts)
void	stop()	Stops the virtual framebuffer process.
protected void	waitForXLockFileCleanup()
void	waitUntilReady()	Waits until the display is ready, using default values for the polling interval and maximum polls.
void	waitUntilReady(long pollIntervalMs, int maxNumPolls)	Waits until the X display is ready, polling at a given interval until the display is ready or the given number of polls has been executed.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_POLL_INTERVAL_MS

public static final long DEFAULT_POLL_INTERVAL_MS

Default poll interval for waitUntilReady()}.

See Also:

Constant Field Values

DEFAULT_MAX_NUM_POLLS

public static final int DEFAULT_MAX_NUM_POLLS

Default max number of polls for waitUntilReady()}.

See Also:

Constant Field Values

LOCK_FILE_CLEANUP_POLL_INTERVAL_MS

protected static final long LOCK_FILE_CLEANUP_POLL_INTERVAL_MS

See Also:

Constant Field Values

LOCK_FILE_CLEANUP_TIMEOUT_MS

protected static final long LOCK_FILE_CLEANUP_TIMEOUT_MS

See Also:

Constant Field Values

Constructor Detail

DefaultXvfbController

public DefaultXvfbController(io.github.mike10004.subprocess.ProcessMonitor<?,?> xvfbMonitor,
                             String display,
                             XvfbManager.DisplayReadinessChecker displayReadinessChecker,
                             Screenshooter<?> screenshooter,
                             Sleeper sleeper)

DefaultXvfbController

protected DefaultXvfbController(io.github.mike10004.subprocess.ProcessMonitor<?,?> xvfbMonitor,
                                String display,
                                XvfbManager.DisplayReadinessChecker displayReadinessChecker,
                                Screenshooter<?> screenshooter,
                                Sleeper sleeper,
                                DefaultXvfbController.XLockFileChecker lockFileChecker)

Method Detail

getRequiredPrograms

public static Iterable<String> getRequiredPrograms()

waitUntilReady

public void waitUntilReady()
                    throws InterruptedException

Description copied from interface: XvfbController

Waits until the display is ready, using default values for the polling interval and maximum polls. Implementations may select the defaults to use.

Specified by:

waitUntilReady in interface XvfbController

Throws:

InterruptedException - if waiting is interrupted

See Also:

XvfbController.waitUntilReady(long, int)

getDisplay

public String getDisplay()

Description copied from interface: XvfbController

Gets the display number in the format :N where N is the display number.

Specified by:

getDisplay in interface XvfbController

Returns:

the display

configureEnvironment

public Map<String,String> configureEnvironment(Map<String,String> environment)

Description copied from interface: XvfbController

Sets the display environment variable in the given environment.

Specified by:

configureEnvironment in interface XvfbController

Parameters:

environment - map of environment variables in which display is to be set

Returns:

the argument environment object

See Also:

XvfbController.ENV_DISPLAY

newEnvironment

public Map<String,String> newEnvironment()

Description copied from interface: XvfbController

Creates a new, mutable environment variable map with the display variable set.

Specified by:

newEnvironment in interface XvfbController

Returns:

the new environment map

See Also:

XvfbController.configureEnvironment(Map)

createEmptyMutableMap

protected Map<String,String> createEmptyMutableMap()

waitUntilReady

public void waitUntilReady(long pollIntervalMs,
                           int maxNumPolls)
                    throws InterruptedException

Description copied from interface: XvfbController

Waits until the X display is ready, polling at a given interval until the display is ready or the given number of polls has been executed.

Specified by:

waitUntilReady in interface XvfbController

Parameters:

pollIntervalMs - interval between polls in milliseconds

maxNumPolls - maximum number of polls to execute

Throws:

InterruptedException - if waiting is interrupted

stop

public void stop()

Description copied from interface: XvfbController

Stops the virtual framebuffer process.

Specified by:

stop in interface XvfbController

waitForXLockFileCleanup

protected void waitForXLockFileCleanup()

getScreenshooter

public Screenshooter<?> getScreenshooter()
                                  throws XvfbException

Description copied from interface: XvfbController

Captures a screenshot of the virtual framebuffer.

Specified by:

getScreenshooter in interface XvfbController

Returns:

the screenshot

Throws:

XvfbException - if screenshooting goes awry

close

public void close()

Invokes stop().

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

pollForWindow

public Optional<TreeNode<XvfbController.XWindow>> pollForWindow(Predicate<XvfbController.XWindow> windowFinder,
                                                                long intervalMs,
                                                                int maxPollAttempts)
                                                         throws InterruptedException

Specified by:

pollForWindow in interface XvfbController

Throws:

InterruptedException