org.safs.model.tools

Class Driver

java.lang.Object

org.safs.model.tools.AbstractDriver

org.safs.model.tools.Driver

public class Driver
extends AbstractDriver

A JSAFSDriver wrapper attempting to provide a minimalist (simple) interface--hiding a good bit of JSAFS complexity.

Since:

OCT 15, 2013

Author:

Carl Nagle

See Also:

JSAFSDriver

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	allow_shutdown Set to false to prevent JSAFS from shutting down on a call to shutdownJSAFS().
static boolean	running
java.lang.Thread	SHUTDOWN_HOOK This is an 'AfterAll' JVM ShutdownHook--if it is needed.

Fields inherited from class org.safs.model.tools.AbstractDriver

_instance, APPMAP_FILES_PROPERTY, APPMAP_ORDER_PROPERTY, BASH, COMMA, DEFAULT_APPMAP_ORDER, HASH, SEMI

Constructor Summary

Constructors

Constructor and Description
Driver()

Method Summary

Modifier and Type	Method and Description
void	beforeAll() Must be called at least once to initialize the internal JSAFSDriver.
static DriverInterface	getIDriver()
DriverInterface	iDriver()
protected void	initializeJSAFS() Try to initialize the internal JSAFSDriver if both jsafs and processor are null.
protected JSAFSDriver	jsafs() Return the possible embedded JSAFSDriver.
protected InputProcessor	processor() Return the possible embedded InputProcessor.
void	run() Initiates the embedded drivers and engines to start running if it is not already running.
static void	setIDriver(DriverInterface iDriver)
void	shutdown() Shutdown the driver and all related resources such as hooks, engines, services and logs etc.
static void	shutdownJSAFS() Used to invoke the JSAFSDriver shutdown function.

Methods inherited from class org.safs.model.tools.AbstractDriver

preloadAppMapExpressions, preloadAppMaps, processExpression, processExpressions, runComponentFunction, runComponentFunction, runComponentFunction, runComponentFunctionConverted, runDriverCommand, runDriverCommandConverted

Methods inherited from class java.lang.Object

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

Field Detail

running

public static boolean running

allow_shutdown

public static boolean allow_shutdown

Set to false to prevent JSAFS from shutting down on a call to shutdownJSAFS(). Default is true. JSAFS shutting down will NOT force a System exit on shutdown.

See Also:

shutdownJSAFS()

SHUTDOWN_HOOK

public final java.lang.Thread SHUTDOWN_HOOK

This is an 'AfterAll' JVM ShutdownHook--if it is needed.

Constructor Detail

Driver

public Driver()

Method Detail

jsafs

protected JSAFSDriver jsafs()

Description copied from class: AbstractDriver

Return the possible embedded JSAFSDriver.

Specified by:

jsafs in class AbstractDriver

processor

protected InputProcessor processor()

Description copied from class: AbstractDriver

Return the possible embedded InputProcessor.

Specified by:

processor in class AbstractDriver

setIDriver

public static void setIDriver(DriverInterface iDriver)

getIDriver

public static DriverInterface getIDriver()

iDriver

public DriverInterface iDriver()

Overrides:

iDriver in class AbstractDriver

Returns:

DriverInterface currently being used.
Could be a JSAFSDriver. Could be an InputProcessor.
Subclasses should override to support other DriverInterface instances not tracked in this superclass. Can be null if none are set.

See Also:

#setIDriver(DriverInterface), JSAFSDriver, InputProcessor

initializeJSAFS

protected void initializeJSAFS()

Try to initialize the internal JSAFSDriver if both jsafs and processor are null.

beforeAll

public void beforeAll()

Must be called at least once to initialize the internal JSAFSDriver. This will be called automatically when using AutoConfigureJSAFS and Runner.autorun appropriately.

It can be called automatically by annotations (dependency injection), or be called from an overriding test controller like a JUnit runner, if appropriate.

See Also:

AutoConfigureJSAFS, Runner.autorun(String[])

shutdownJSAFS

public static void shutdownJSAFS()
                          throws java.lang.Exception

Used to invoke the JSAFSDriver shutdown function. The routine will only invoke the function if allow_shutdown = true.

Throws:

java.lang.Exception

See Also:

allow_shutdown, JSAFSDriver.shutdown()

shutdown

public void shutdown()
              throws java.lang.Exception

Description copied from class: AbstractDriver

Shutdown the driver and all related resources such as hooks, engines, services and logs etc.

Specified by:

shutdown in class AbstractDriver

Throws:

java.lang.Exception

run

public void run()
         throws java.lang.Exception

Description copied from class: AbstractDriver

Initiates the embedded drivers and engines to start running if it is not already running. The user should call this method to ensure the drivers/engines are initialized before using them.

Specified by:

run in class AbstractDriver

Throws:

java.lang.Exception