AbstractNExec (Nuts Community Core Runtime 0.8.9.0 API)

java.lang.Object
- net.thevpc.nuts.runtime.standalone.workspace.cmd.NWorkspaceCmdBase<NExec>
- - net.thevpc.nuts.runtime.standalone.workspace.cmd.exec.AbstractNExec

All Implemented Interfaces:

NCmdLineConfigurable, NExec, NWorkspaceCmd, NConnectionStringAware, NComponent

Direct Known Subclasses:

DefaultNExec, RemoteNExec
```
public abstract class AbstractNExec
extends NWorkspaceCmdBase<NExec>
implements NExec
```
type: Command Class

Author:

thevpc

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`bot`
`protected List<String>`	`command`
`protected NDefinition`	`commandDefinition`
`protected NPath`	`directory`
`protected Boolean`	`dry`
`protected Map<String,String>`	`env`
`protected NExecOutput`	`err`
`protected boolean`	`executed`
`protected NDuration`	`executionTime`
`protected NExecutionType`	`executionType`
`protected List<String>`	`executorOptions`
`protected boolean`	`failFast`
`protected NExecInput`	`in`
`protected boolean`	`multipleRuns`
`protected String`	`multipleRunsCron`
`protected int`	`multipleRunsMaxCount`
`protected long`	`multipleRunsMinTimeMs`
`protected long`	`multipleRunsSafeTimeMs`
`protected NExecOutput`	`out`
`protected NExecutionException`	`resultException`
`protected NRunAs`	`runAs`
`protected List<String>`	`workspaceOptions`

Constructor Summary

Constructors
Constructor and Description

AbstractNExec()

Constructors
Constructor and Description
`AbstractNExec()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NExec`	`addCommand(Collection<String> command)`
`NExec`	`addCommand(NPath path)`
`NExec`	`addCommand(String... command)`
`NExec`	`addEnv(Map<String,String> env)`
`NExec`	`addExecutorOption(String executorOption)`
`NExec`	`addExecutorOptions(Collection<String> executorOptions)`
`NExec`	`addExecutorOptions(String... executorOptions)`
`NExec`	`addWorkspaceOptions(NWorkspaceOptions workspaceOptions)`
`NExec`	`addWorkspaceOptions(String workspaceOptions)`
`NExec`	`at(NConnectionString connectionString)`
`NExec`	`at(String connectionString)`
`NExec`	`clearCommand()`
`NExec`	`clearEnv()`
`NExec`	`clearExecutorOptions()`
`NExec`	`clearWorkspaceOptions(String workspaceOptions)`
`boolean`	`configureFirst(NCmdLine cmdLine)`
`NExec`	`copy()`
`NExec`	`copyFrom(NExec other)`
`NExec`	`currentUser()`
`NExec`	`embedded()`
`NExec`	`failFast()`
`Boolean`	`getBot()`
`List<String>`	`getCommand()`
`NDefinition`	`getCommandDefinition()`
`String`	`getCommandString()`
`String`	`getCommandString(ProcessBuilder2.CommandStringFormat f)`
`NConnectionString`	`getConnectionString()`
`NPath`	`getDirectory()`
`Boolean`	`getDry()`
`Map<String,String>`	`getEnv()`
`NExecOutput`	`getErr()`
`NExecutionType`	`getExecutionType()`
`List<String>`	`getExecutorOptions()`
`protected String`	`getExtraErrorMessage()`
`String`	`getGrabbedAllString()`
`byte[]`	`getGrabbedErrBytes()`
`String`	`getGrabbedErrString()`
`byte[]`	`getGrabbedOutBytes()`
`String`	`getGrabbedOutOnlyString()`
`String`	`getGrabbedOutString()`
`NExecInput`	`getIn()`
`NExecOutput`	`getOut()`
`int`	`getResultCode()`
`NOptional<NExecutionException>`	`getResultException()`
`NRunAs`	`getRunAs()`
`long`	`getSleepMillis()`
`List<String>`	`getWorkspaceOptions()`
`NExec`	`grabAll()`
`NExec`	`grabErr()`
`NExec`	`grabOut()`
`NExec`	`grabOutOnly()`
`boolean`	`isFailFast()`
`boolean`	`isRawCommand()`
`NExec`	`open()`
`NExec`	`redirectErr()`
`NExec`	`root()`
`NExec`	`setBot(Boolean bot)`
`NExec`	`setCommand(Collection<String> command)`
`NExec`	`setCommand(String... command)`
`NExec`	`setCommandDefinition(NDefinition definition)`
`NExec`	`setConnectionString(NConnectionString connectionString)`
`NExec`	`setConnectionString(String connectionString)`
`NExec`	`setDirectory(NPath directory)`
`NExec`	`setDry(Boolean dry)`
`NExec`	`setEnv(Map<String,String> env)`
`NExec`	`setEnv(String key, String value)`
`NExec`	`setErr(NExecOutput err)`
`NExec`	`setExecutionType(NExecutionType executionType)`
`NExec`	`setExecutorOptions(Collection<String> executorOptions)`
`NExec`	`setFailFast(boolean failFast)`
`NExec`	`setIn(NExecInput in)`
`NExec`	`setOut(NExecOutput out)`
`NExec`	`setRawCommand(boolean rawCommand)`
`NExec`	`setRunAs(NRunAs runAs)`
`NExec`	`setSleepMillis(long sleepMillis)`
`NExec`	`spawn()`
`NExec`	`sudo()`
`NExec`	`system()`
`String`	`toString()`

Methods inherited from class net.thevpc.nuts.runtime.standalone.workspace.cmd.NWorkspaceCmdBase
_LOG, configure, copyFromWorkspaceCommandBase, getCommandName, invalidateResult

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.thevpc.nuts.command.NExec
configure, of, of, ofOpenFile, ofSystem, run, which

Methods inherited from interface net.thevpc.nuts.cmdline.NCmdLineConfigurable
configure, configure, configureLast

- Field Detail
  - commandDefinition
```
protected NDefinition commandDefinition
```
  - command
```
protected List<String> command
```
  - executorOptions
```
protected List<String> executorOptions
```
  - workspaceOptions
```
protected List<String> workspaceOptions
```
  - env
```
protected Map<String,String> env
```
  - resultException
```
protected NExecutionException resultException
```
  - executed
```
protected boolean executed
```
  - executionTime
```
protected NDuration executionTime
```
  - multipleRuns
```
protected boolean multipleRuns
```
  - multipleRunsMinTimeMs
```
protected long multipleRunsMinTimeMs
```
  - multipleRunsSafeTimeMs
```
protected long multipleRunsSafeTimeMs
```
  - multipleRunsMaxCount
```
protected int multipleRunsMaxCount
```
  - multipleRunsCron
```
protected String multipleRunsCron
```
  - directory
```
protected NPath directory
```
  - out
```
protected NExecOutput out
```
  - err
```
protected NExecOutput err
```
  - in
```
protected NExecInput in
```
  - executionType
```
protected NExecutionType executionType
```
  - runAs
```
protected NRunAs runAs
```
  - dry
```
protected Boolean dry
```
  - failFast
```
protected boolean failFast
```
  - bot
```
protected Boolean bot
```
- Constructor Detail
  - AbstractNExec
```
public AbstractNExec()
```
- Method Detail
  - isFailFast
```
public boolean isFailFast()
```
    Specified by:
    
    isFailFast in interface NExec
  - setBot
```
public NExec setBot(Boolean bot)
```
    Specified by:
    
    setBot in interface NExec
  - getBot
```
public Boolean getBot()
```
    Specified by:
    
    getBot in interface NExec
  - setFailFast
```
public NExec setFailFast(boolean failFast)
```
    Specified by:
    
    setFailFast in interface NExec
  - failFast
```
public NExec failFast()
```
    Specified by:
    
    failFast in interface NExec
  - getCommand
```
public List<String> getCommand()
```
    Specified by:
    
    getCommand in interface NExec
  - setCommand
```
public NExec setCommand(String... command)
```
    Specified by:
    
    setCommand in interface NExec
  - setCommand
```
public NExec setCommand(Collection<String> command)
```
    Specified by:
    
    setCommand in interface NExec
  - setCommandDefinition
```
public NExec setCommandDefinition(NDefinition definition)
```
    Specified by:
    
    setCommandDefinition in interface NExec
  - getCommandDefinition
```
public NDefinition getCommandDefinition()
```
    Specified by:
    
    getCommandDefinition in interface NExec
  - addCommand
```
public NExec addCommand(NPath path)
```
    Specified by:
    
    addCommand in interface NExec
  - addCommand
```
public NExec addCommand(String... command)
```
    Specified by:
    
    addCommand in interface NExec
  - addCommand
```
public NExec addCommand(Collection<String> command)
```
    Specified by:
    
    addCommand in interface NExec
  - clearCommand
```
public NExec clearCommand()
```
    Specified by:
    
    clearCommand in interface NExec
  - addExecutorOption
```
public NExec addExecutorOption(String executorOption)
```
    Specified by:
    
    addExecutorOption in interface NExec
  - addExecutorOptions
```
public NExec addExecutorOptions(String... executorOptions)
```
    Specified by:
    
    addExecutorOptions in interface NExec
  - setExecutorOptions
```
public NExec setExecutorOptions(Collection<String> executorOptions)
```
    Specified by:
    
    setExecutorOptions in interface NExec
  - addExecutorOptions
```
public NExec addExecutorOptions(Collection<String> executorOptions)
```
    Specified by:
    
    addExecutorOptions in interface NExec
  - clearExecutorOptions
```
public NExec clearExecutorOptions()
```
    Specified by:
    
    clearExecutorOptions in interface NExec
  - getWorkspaceOptions
```
public List<String> getWorkspaceOptions()
```
    Specified by:
    
    getWorkspaceOptions in interface NExec
  - clearWorkspaceOptions
```
public NExec clearWorkspaceOptions(String workspaceOptions)
```
    Specified by:
    
    clearWorkspaceOptions in interface NExec
  - addWorkspaceOptions
```
public NExec addWorkspaceOptions(NWorkspaceOptions workspaceOptions)
```
    Specified by:
    
    addWorkspaceOptions in interface NExec
  - addWorkspaceOptions
```
public NExec addWorkspaceOptions(String workspaceOptions)
```
    Specified by:
    
    addWorkspaceOptions in interface NExec
  - getEnv
```
public Map<String,String> getEnv()
```
    Specified by:
    
    getEnv in interface NExec
  - setEnv
```
public NExec setEnv(Map<String,String> env)
```
    Specified by:
    
    setEnv in interface NExec
  - addEnv
```
public NExec addEnv(Map<String,String> env)
```
    Specified by:
    
    addEnv in interface NExec
  - setEnv
```
public NExec setEnv(String key,
                    String value)
```
    Specified by:
    
    setEnv in interface NExec
  - clearEnv
```
public NExec clearEnv()
```
    Specified by:
    
    clearEnv in interface NExec
  - getDirectory
```
public NPath getDirectory()
```
    Specified by:
    
    getDirectory in interface NExec
  - setDirectory
```
public NExec setDirectory(NPath directory)
```
    Specified by:
    
    setDirectory in interface NExec
  - getIn
```
public NExecInput getIn()
```
    Specified by:
    
    getIn in interface NExec
  - setIn
```
public NExec setIn(NExecInput in)
```
    Specified by:
    
    setIn in interface NExec
  - getOut
```
public NExecOutput getOut()
```
    Specified by:
    
    getOut in interface NExec
  - setOut
```
public NExec setOut(NExecOutput out)
```
    Specified by:
    
    setOut in interface NExec
  - grabOut
```
public NExec grabOut()
```
    Specified by:
    
    grabOut in interface NExec
  - grabAll
```
public NExec grabAll()
```
    Specified by:
    
    grabAll in interface NExec
  - grabOutOnly
```
public NExec grabOutOnly()
```
    Specified by:
    
    grabOutOnly in interface NExec
  - grabErr
```
public NExec grabErr()
```
    Specified by:
    
    grabErr in interface NExec
  - getGrabbedAllString
```
public String getGrabbedAllString()
```
    Specified by:
    
    getGrabbedAllString in interface NExec
  - getGrabbedOutOnlyString
```
public String getGrabbedOutOnlyString()
```
    Specified by:
    
    getGrabbedOutOnlyString in interface NExec
  - getGrabbedOutString
```
public String getGrabbedOutString()
```
    Specified by:
    
    getGrabbedOutString in interface NExec
  - getGrabbedOutBytes
```
public byte[] getGrabbedOutBytes()
```
    Specified by:
    
    getGrabbedOutBytes in interface NExec
  - getGrabbedErrBytes
```
public byte[] getGrabbedErrBytes()
```
    Specified by:
    
    getGrabbedErrBytes in interface NExec
  - getGrabbedErrString
```
public String getGrabbedErrString()
```
    Specified by:
    
    getGrabbedErrString in interface NExec
  - getErr
```
public NExecOutput getErr()
```
    Specified by:
    
    getErr in interface NExec
  - setErr
```
public NExec setErr(NExecOutput err)
```
    Specified by:
    
    setErr in interface NExec
  - getExecutionType
```
public NExecutionType getExecutionType()
```
    Specified by:
    
    getExecutionType in interface NExec
  - setExecutionType
```
public NExec setExecutionType(NExecutionType executionType)
```
    Specified by:
    
    setExecutionType in interface NExec
  - system
```
public NExec system()
```
    Specified by:
    
    system in interface NExec
  - embedded
```
public NExec embedded()
```
    Specified by:
    
    embedded in interface NExec
  - spawn
```
public NExec spawn()
```
    Specified by:
    
    spawn in interface NExec
  - open
```
public NExec open()
```
    Specified by:
    
    open in interface NExec
  - getRunAs
```
public NRunAs getRunAs()
```
    Specified by:
    
    getRunAs in interface NExec
  - sudo
```
public NExec sudo()
```
    Specified by:
    
    sudo in interface NExec
  - root
```
public NExec root()
```
    Specified by:
    
    root in interface NExec
  - currentUser
```
public NExec currentUser()
```
    Specified by:
    
    currentUser in interface NExec
  - setRunAs
```
public NExec setRunAs(NRunAs runAs)
```
    Specified by:
    
    setRunAs in interface NExec
  - getDry
```
public Boolean getDry()
```
    Specified by:
    
    getDry in interface NExec
  - setDry
```
public NExec setDry(Boolean dry)
```
    Specified by:
    
    setDry in interface NExec
  - copyFrom
```
public NExec copyFrom(NExec other)
```
    Specified by:
    
    copyFrom in interface NExec
  - copy
```
public NExec copy()
```
    Specified by:
    
    copy in interface NExec
  - getResultCode
```
public int getResultCode()
```
    Specified by:
    
    getResultCode in interface NExec
  - getExecutorOptions
```
public List<String> getExecutorOptions()
```
    Specified by:
    
    getExecutorOptions in interface NExec
  - getResultException
```
public NOptional<NExecutionException> getResultException()
```
    Specified by:
    
    getResultException in interface NExec
  - getSleepMillis
```
public long getSleepMillis()
```
    Specified by:
    
    getSleepMillis in interface NExec
  - setSleepMillis
```
public NExec setSleepMillis(long sleepMillis)
```
    Specified by:
    
    setSleepMillis in interface NExec
  - getExtraErrorMessage
```
protected String getExtraErrorMessage()
```
  - configureFirst
```
public boolean configureFirst(NCmdLine cmdLine)
```
    Specified by:
    
    configureFirst in interface NCmdLineConfigurable
    
    Overrides:
    
    configureFirst in class NWorkspaceCmdBase<NExec>
  - getCommandString
```
public String getCommandString()
```
  - getCommandString
```
public String getCommandString(ProcessBuilder2.CommandStringFormat f)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getConnectionString
```
public NConnectionString getConnectionString()
```
    Specified by:
    
    getConnectionString in interface NExec
    
    Specified by:
    
    getConnectionString in interface NConnectionStringAware
  - setConnectionString
```
public NExec setConnectionString(String connectionString)
```
    Specified by:
    
    setConnectionString in interface NExec
    
    Specified by:
    
    setConnectionString in interface NConnectionStringAware
  - at
```
public NExec at(String connectionString)
```
    Specified by:
    
    at in interface NExec
    
    Specified by:
    
    at in interface NConnectionStringAware
  - at
```
public NExec at(NConnectionString connectionString)
```
    Specified by:
    
    at in interface NExec
    
    Specified by:
    
    at in interface NConnectionStringAware
  - setConnectionString
```
public NExec setConnectionString(NConnectionString connectionString)
```
    Specified by:
    
    setConnectionString in interface NExec
    
    Specified by:
    
    setConnectionString in interface NConnectionStringAware
  - redirectErr
```
public NExec redirectErr()
```
    Specified by:
    
    redirectErr in interface NExec
  - isRawCommand
```
public boolean isRawCommand()
```
    Specified by:
    
    isRawCommand in interface NExec
  - setRawCommand
```
public NExec setRawCommand(boolean rawCommand)
```
    Specified by:
    
    setRawCommand in interface NExec

Class AbstractNExec

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.thevpc.nuts.runtime.standalone.workspace.cmd.NWorkspaceCmdBase

Methods inherited from class java.lang.Object

Methods inherited from interface net.thevpc.nuts.command.NExec

Methods inherited from interface net.thevpc.nuts.cmdline.NCmdLineConfigurable

Field Detail

commandDefinition

command

executorOptions

workspaceOptions

env

resultException

executed

executionTime

multipleRuns

multipleRunsMinTimeMs

multipleRunsSafeTimeMs

multipleRunsMaxCount

multipleRunsCron

directory

out

err

in

executionType

runAs

dry

failFast

bot

Constructor Detail

AbstractNExec

Method Detail

isFailFast

setBot

getBot

setFailFast

failFast

getCommand

setCommand

setCommand

setCommandDefinition

getCommandDefinition

addCommand

addCommand

addCommand

clearCommand

addExecutorOption

addExecutorOptions

setExecutorOptions

addExecutorOptions

clearExecutorOptions

getWorkspaceOptions

clearWorkspaceOptions

addWorkspaceOptions

addWorkspaceOptions

getEnv

setEnv

addEnv

setEnv

clearEnv

getDirectory

setDirectory

getIn

setIn

getOut

setOut

grabOut

grabAll

grabOutOnly

grabErr

getGrabbedAllString

getGrabbedOutOnlyString

getGrabbedOutString

getGrabbedOutBytes

getGrabbedErrBytes

getGrabbedErrString

getErr

setErr