com.cerner.ccl.j4ccl.impl

Class BaseCclExecutor

java.lang.Object

com.cerner.ccl.j4ccl.CclExecutor

com.cerner.ccl.j4ccl.impl.BaseCclExecutor

public class BaseCclExecutor
extends com.cerner.ccl.j4ccl.CclExecutor

An implementation of CclExecutor.
In order for this class - and its extensions - to function, there must be a Subject in context. It must have, at a minimum, the following:

• A BackendNodePrincipal in the subject's principals
• A BackendNodePasswordCredential in the subjects private credentials

In addition, if this executor is to log into Millennium, it must have the following:

• A MillenniumDomainPrincipal in the subject's principals
• A MillenniumDomainPasswordCredential in the subjects private credentials

Author:

Joshua Hyde, Fred Eckertson

Constructor Summary

Constructors

Constructor and Description
BaseCclExecutor() Create a CCL command executor.
BaseCclExecutor(com.cerner.ccl.j4ccl.TerminalProperties terminalProperties, CommandQueue commandQueue) Create a CCL command executor that uses the given factories to generate required objects.

Method Summary

Modifier and Type	Method and Description
DynamicCompilerAdderImpl	addDynamicCompiler(File includeFile)
ScriptCompilerAdderImpl	addScriptCompiler(File file)
com.cerner.ccl.j4ccl.adders.ScriptDropAdder	addScriptDropper(String scriptName)
com.cerner.ccl.j4ccl.adders.ScriptExecutionAdder	addScriptExecution(String scriptName)
void	execute()
protected CommandQueue	getCommandQueue() Get the command queue that backs this executor.
protected OutputStreamConfiguration	getOutputStreamConfiguration() Get the output stream configuration, if any.
protected com.cerner.ccl.j4ccl.TerminalProperties	getTerminalProperties() Get the TerminalProperties configuration, if any.
void	setOutputStream(OutputStream stream, com.cerner.ccl.j4ccl.enums.OutputType outputType)
void	setTerminalProperties(com.cerner.ccl.j4ccl.TerminalProperties terminalProperties)

Methods inherited from class com.cerner.ccl.j4ccl.CclExecutor

getExecutor

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseCclExecutor

public BaseCclExecutor()

Create a CCL command executor.

BaseCclExecutor

public BaseCclExecutor(com.cerner.ccl.j4ccl.TerminalProperties terminalProperties,
                       CommandQueue commandQueue)

Create a CCL command executor that uses the given factories to generate required objects.
This constructor exists primarily as a means of rough dependency injection. Typically, BaseCclExecutor() should be used.
This constructor is purposefully left as package-level visibility to prevent it from being part of the published API.

Parameters:

terminalProperties - The TerminalProperties to apply.

commandQueue - A CommandQueue managed by this executor.

Throws:

NullPointerException - If the given command queue is null.

Method Detail

addDynamicCompiler

public DynamicCompilerAdderImpl addDynamicCompiler(File includeFile)

Specified by:

addDynamicCompiler in class com.cerner.ccl.j4ccl.CclExecutor

addScriptCompiler

public ScriptCompilerAdderImpl addScriptCompiler(File file)

Specified by:

addScriptCompiler in class com.cerner.ccl.j4ccl.CclExecutor

addScriptDropper

public com.cerner.ccl.j4ccl.adders.ScriptDropAdder addScriptDropper(String scriptName)

Specified by:

addScriptDropper in class com.cerner.ccl.j4ccl.CclExecutor

addScriptExecution

public com.cerner.ccl.j4ccl.adders.ScriptExecutionAdder addScriptExecution(String scriptName)

Specified by:

addScriptExecution in class com.cerner.ccl.j4ccl.CclExecutor

execute

public void execute()

Specified by:

execute in class com.cerner.ccl.j4ccl.CclExecutor

setOutputStream

public void setOutputStream(OutputStream stream,
                            com.cerner.ccl.j4ccl.enums.OutputType outputType)

Specified by:

setOutputStream in class com.cerner.ccl.j4ccl.CclExecutor

setTerminalProperties

public void setTerminalProperties(com.cerner.ccl.j4ccl.TerminalProperties terminalProperties)

Specified by:

setTerminalProperties in class com.cerner.ccl.j4ccl.CclExecutor

getCommandQueue

protected CommandQueue getCommandQueue()

Get the command queue that backs this executor.

Returns:

A CommandQueue.

getOutputStreamConfiguration

protected OutputStreamConfiguration getOutputStreamConfiguration()

Get the output stream configuration, if any.

Returns:

null if there is no set output stream configuration; otherwise, an OutputStreamConfiguration representing the configured output stream.

getTerminalProperties

protected com.cerner.ccl.j4ccl.TerminalProperties getTerminalProperties()

Get the TerminalProperties configuration, if any.

Returns:

The TerminalProperties configuration fpr this executor.