AbstractProcessTaskFactory (Apache Brooklyn)

java.lang.Object
- brooklyn.util.task.system.ProcessTaskStub
- - brooklyn.util.task.system.internal.AbstractProcessTaskFactory<T,RET>

All Implemented Interfaces:

TaskFactory<ProcessTaskWrapper<RET>>, ProcessTaskFactory<RET>

Direct Known Subclasses:

AbstractSshExecTaskFactory, SystemProcessTaskFactory
```
public abstract class AbstractProcessTaskFactory<T extends AbstractProcessTaskFactory<T,RET>,RET>
extends ProcessTaskStub
implements ProcessTaskFactory<RET>
```

Nested Class Summary
- Nested classes/interfaces inherited from class brooklyn.util.task.system.ProcessTaskStub
  ProcessTaskStub.ScriptReturnType

Constructor Summary

Constructors
Constructor and Description

AbstractProcessTaskFactory(java.lang.String... commands)

Constructors
Constructor and Description
`AbstractProcessTaskFactory(java.lang.String... commands)`

Method Summary

Methods
Modifier and Type	Method and Description
`T`	`add(java.lang.Iterable<java.lang.String> commandsToAdd)`
`T`	`add(java.lang.String... commandsToAdd)`
`T`	`addCompletionListener(com.google.common.base.Function<ProcessTaskWrapper<?>,java.lang.Void> listener)` adds a listener which will be notified of (otherwise) successful completion, typically used to invalidate the result (ie throw exception, to promote a string in the output to an exception); invoked even if return code is zero, so a better error can be thrown
`T`	`allowingNonZeroExitCode()`
`<V> T`	`configure(ConfigKey<V> key, V value)` allows setting config-key based properties for specific underlying tools
`T`	`configure(java.util.Map<?,?> flags)` allows setting config-key/flag based properties for specific underlying tools; but note that if any are prefixed with `SshTool.BROOKLYN_CONFIG_KEY_PREFIX` these should normally be filtered out
`TaskBuilder<java.lang.Object>`	`constructCustomizedTaskBuilder()` creates the TaskBuilder which can be further customized; typically invoked by the initial `TaskFactory.newTask()`
`T`	`environmentVariable(java.lang.String key, java.lang.String val)`
`T`	`environmentVariables(java.util.Map<java.lang.String,java.lang.String> vars)`
`T`	`machine(SshMachineLocation machine)`
`T`	`requiringExitCodeZero()`
`T`	`requiringExitCodeZero(java.lang.String extraErrorMessage)`
`ProcessTaskFactory<java.lang.String>`	`requiringZeroAndReturningStdout()`
`<RET2> ProcessTaskFactory<RET2>`	`returning(com.google.common.base.Function<ProcessTaskWrapper<?>,RET2> resultTransformation)`
`<RET2> ProcessTaskFactory<RET2>`	`returning(ProcessTaskStub.ScriptReturnType type)`
`ProcessTaskFactory<java.lang.Boolean>`	`returningIsExitCodeZero()`
`T`	`runAsCommand()`
`T`	`runAsRoot()`
`T`	`runAsScript()`
`T`	`summary(java.lang.String summary)`

Methods inherited from class brooklyn.util.task.system.ProcessTaskStub
getCommands, getCompletionListeners, getMachine, getShellEnvironment, getSummary, toString

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

Methods inherited from interface brooklyn.management.TaskFactory
newTask

- Constructor Detail
  - AbstractProcessTaskFactory
```
public AbstractProcessTaskFactory(java.lang.String... commands)
```
- Method Detail
  - add
```
public T add(java.lang.String... commandsToAdd)
```
    Specified by:
    
    add in interface ProcessTaskFactory<RET>
  - add
```
public T add(java.lang.Iterable<java.lang.String> commandsToAdd)
```
    Specified by:
    
    add in interface ProcessTaskFactory<RET>
  - machine
```
public T machine(SshMachineLocation machine)
```
    Specified by:
    
    machine in interface ProcessTaskFactory<RET>
  - requiringExitCodeZero
```
public T requiringExitCodeZero()
```
    Specified by:
    
    requiringExitCodeZero in interface ProcessTaskFactory<RET>
  - requiringExitCodeZero
```
public T requiringExitCodeZero(java.lang.String extraErrorMessage)
```
    Specified by:
    
    requiringExitCodeZero in interface ProcessTaskFactory<RET>
  - allowingNonZeroExitCode
```
public T allowingNonZeroExitCode()
```
    Specified by:
    
    allowingNonZeroExitCode in interface ProcessTaskFactory<RET>
  - returningIsExitCodeZero
```
public ProcessTaskFactory<java.lang.Boolean> returningIsExitCodeZero()
```
    Specified by:
    
    returningIsExitCodeZero in interface ProcessTaskFactory<RET>
  - requiringZeroAndReturningStdout
```
public ProcessTaskFactory<java.lang.String> requiringZeroAndReturningStdout()
```
    Specified by:
    
    requiringZeroAndReturningStdout in interface ProcessTaskFactory<RET>
  - returning
```
public <RET2> ProcessTaskFactory<RET2> returning(ProcessTaskStub.ScriptReturnType type)
```
    Specified by:
    
    returning in interface ProcessTaskFactory<RET>
  - returning
```
public <RET2> ProcessTaskFactory<RET2> returning(com.google.common.base.Function<ProcessTaskWrapper<?>,RET2> resultTransformation)
```
    Specified by:
    
    returning in interface ProcessTaskFactory<RET>
  - runAsCommand
```
public T runAsCommand()
```
    Specified by:
    
    runAsCommand in interface ProcessTaskFactory<RET>
  - runAsScript
```
public T runAsScript()
```
    Specified by:
    
    runAsScript in interface ProcessTaskFactory<RET>
  - runAsRoot
```
public T runAsRoot()
```
    Specified by:
    
    runAsRoot in interface ProcessTaskFactory<RET>
  - environmentVariable
```
public T environmentVariable(java.lang.String key,
                    java.lang.String val)
```
    Specified by:
    
    environmentVariable in interface ProcessTaskFactory<RET>
  - environmentVariables
```
public T environmentVariables(java.util.Map<java.lang.String,java.lang.String> vars)
```
    Specified by:
    
    environmentVariables in interface ProcessTaskFactory<RET>
  - constructCustomizedTaskBuilder
```
public TaskBuilder<java.lang.Object> constructCustomizedTaskBuilder()
```
    creates the TaskBuilder which can be further customized; typically invoked by the initial TaskFactory.newTask()
  - summary
```
public T summary(java.lang.String summary)
```
    Specified by:
    
    summary in interface ProcessTaskFactory<RET>
  - configure
```
public <V> T configure(ConfigKey<V> key,
              V value)
```
    Description copied from interface: ProcessTaskFactory
    
    allows setting config-key based properties for specific underlying tools
    
    Specified by:
    
    configure in interface ProcessTaskFactory<RET>
  - configure
```
public T configure(java.util.Map<?,?> flags)
```
    Description copied from interface: ProcessTaskFactory
    
    allows setting config-key/flag based properties for specific underlying tools; but note that if any are prefixed with SshTool.BROOKLYN_CONFIG_KEY_PREFIX these should normally be filtered out
    
    Specified by:
    
    configure in interface ProcessTaskFactory<RET>
  - addCompletionListener
```
public T addCompletionListener(com.google.common.base.Function<ProcessTaskWrapper<?>,java.lang.Void> listener)
```
    Description copied from interface: ProcessTaskFactory
    
    adds a listener which will be notified of (otherwise) successful completion, typically used to invalidate the result (ie throw exception, to promote a string in the output to an exception); invoked even if return code is zero, so a better error can be thrown
    
    Specified by:
    
    addCompletionListener in interface ProcessTaskFactory<RET>

Class AbstractProcessTaskFactory<T extends AbstractProcessTaskFactory<T,RET>,RET>

Nested Class Summary

Nested classes/interfaces inherited from class brooklyn.util.task.system.ProcessTaskStub

Constructor Summary

Method Summary

Methods inherited from class brooklyn.util.task.system.ProcessTaskStub

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.management.TaskFactory

Constructor Detail

AbstractProcessTaskFactory

Method Detail

add

add

machine

requiringExitCodeZero

requiringExitCodeZero

allowingNonZeroExitCode

returningIsExitCodeZero

requiringZeroAndReturningStdout

returning

returning

runAsCommand

runAsScript

runAsRoot

environmentVariable

environmentVariables

constructCustomizedTaskBuilder

summary

configure

configure

addCompletionListener