KnifeTaskFactory (Apache Brooklyn)

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

All Implemented Interfaces:

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

Direct Known Subclasses:

KnifeConvergeTaskFactory
```
public class KnifeTaskFactory<RET>
extends SystemProcessTaskFactory<KnifeTaskFactory<RET>,RET>
```
A factory which acts like ProcessTaskFactory with special options for knife. Typical usage is to #addKnifeParameters(String)s for the knife command to be run. You can also AbstractProcessTaskFactory.add(String...) commands as needed; these will run *before* knife, unless you addKnifeCommandHere().
This impl will use sensible defaults, including ConfigKeys on the context entity, for general knife config but not specific commands etc. It supports:
ChefConfig.KNIFE_EXECUTABLE
ChefConfig.KNIFE_CONFIG_FILE
(Other fields will typically be used by methods calling to this factory.)

Nested Class Summary
- Nested classes/interfaces inherited from class brooklyn.util.task.system.internal.SystemProcessTaskFactory
  SystemProcessTaskFactory.ConcreteSystemProcessTaskFactory<RET>
- Nested classes/interfaces inherited from class brooklyn.util.task.system.ProcessTaskStub
  ProcessTaskStub.ScriptReturnType

Field Summary

Fields
Modifier and Type Field and Description

java.lang.String taskName

Fields
Modifier and Type	Field and Description
`java.lang.String`	`taskName`

Constructor Summary

Constructors
Constructor and Description

KnifeTaskFactory(java.lang.String taskName)

Constructors
Constructor and Description
`KnifeTaskFactory(java.lang.String taskName)`

Method Summary

Methods
Modifier and Type	Method and Description
`KnifeTaskFactory<RET>`	`addKnifeCommandToScript()` Inserts the knife command at the current place in the list.
`java.util.List<java.lang.String>`	`getCommands()`
`java.util.List<com.google.common.base.Function<ProcessTaskWrapper<?>,java.lang.Void>>`	`getCompletionListeners()`
`KnifeTaskFactory<RET>`	`knifeAddParameters(java.lang.String word1, java.lang.String... words)`
`KnifeTaskFactory<RET>`	`knifeConfigFile(java.lang.String knifeConfigFile)`
`KnifeTaskFactory<RET>`	`knifeExecutable(java.lang.String knifeExecutable)`
`KnifeTaskFactory<RET>`	`knifeSetupCommands(java.lang.String knifeSetupCommands)`
`ProcessTaskWrapper<RET>`	`newTask()`
`KnifeTaskFactory<RET>`	`notThrowingOnCommonKnifeErrors()`
`KnifeTaskFactory<java.lang.String>`	`requiringZeroAndReturningStdout()`
`<RET2> KnifeTaskFactory<RET2>`	`returning(com.google.common.base.Function<ProcessTaskWrapper<?>,RET2> resultTransformation)`
`<T2> KnifeTaskFactory<T2>`	`returning(ProcessTaskStub.ScriptReturnType type)`
`KnifeTaskFactory<java.lang.Boolean>`	`returningIsExitCodeZero()`

Methods inherited from class brooklyn.util.task.system.internal.SystemProcessTaskFactory
directory, loginShell, machine

Methods inherited from class brooklyn.util.task.system.internal.AbstractProcessTaskFactory
add, add, addCompletionListener, allowingNonZeroExitCode, configure, configure, constructCustomizedTaskBuilder, environmentVariable, environmentVariables, requiringExitCodeZero, requiringExitCodeZero, runAsCommand, runAsRoot, runAsScript, summary

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

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

- Field Detail
  - taskName
```
public final java.lang.String taskName
```
- Constructor Detail
  - KnifeTaskFactory
```
public KnifeTaskFactory(java.lang.String taskName)
```
- Method Detail
  - getCompletionListeners
```
public java.util.List<com.google.common.base.Function<ProcessTaskWrapper<?>,java.lang.Void>> getCompletionListeners()
```
    Overrides:
    
    getCompletionListeners in class ProcessTaskStub
  - notThrowingOnCommonKnifeErrors
```
public KnifeTaskFactory<RET> notThrowingOnCommonKnifeErrors()
```
  - newTask
```
public ProcessTaskWrapper<RET> newTask()
```
    Specified by:
    
    newTask in interface TaskFactory<ProcessTaskWrapper<RET>>
    
    Overrides:
    
    newTask in class SystemProcessTaskFactory<KnifeTaskFactory<RET>,RET>
  - addKnifeCommandToScript
```
public KnifeTaskFactory<RET> addKnifeCommandToScript()
```
    Inserts the knife command at the current place in the list. Can be run multiple times. The knife command added at the end of the list if this is not invoked (and it is the only command if nothing is AbstractProcessTaskFactory.add(String...)ed.
  - getCommands
```
public java.util.List<java.lang.String> getCommands()
```
    Overrides:
    
    getCommands in class ProcessTaskStub
  - knifeExecutable
```
public KnifeTaskFactory<RET> knifeExecutable(java.lang.String knifeExecutable)
```
  - knifeAddParameters
```
public KnifeTaskFactory<RET> knifeAddParameters(java.lang.String word1,
                                       java.lang.String... words)
```
  - knifeConfigFile
```
public KnifeTaskFactory<RET> knifeConfigFile(java.lang.String knifeConfigFile)
```
  - knifeSetupCommands
```
public KnifeTaskFactory<RET> knifeSetupCommands(java.lang.String knifeSetupCommands)
```
  - returning
```
public <T2> KnifeTaskFactory<T2> returning(ProcessTaskStub.ScriptReturnType type)
```
    Specified by:
    
    returning in interface ProcessTaskFactory<RET>
    
    Overrides:
    
    returning in class AbstractProcessTaskFactory<KnifeTaskFactory<RET>,RET>
  - returning
```
public <RET2> KnifeTaskFactory<RET2> returning(com.google.common.base.Function<ProcessTaskWrapper<?>,RET2> resultTransformation)
```
    Specified by:
    
    returning in interface ProcessTaskFactory<RET>
    
    Overrides:
    
    returning in class AbstractProcessTaskFactory<KnifeTaskFactory<RET>,RET>
  - returningIsExitCodeZero
```
public KnifeTaskFactory<java.lang.Boolean> returningIsExitCodeZero()
```
    Specified by:
    
    returningIsExitCodeZero in interface ProcessTaskFactory<RET>
    
    Overrides:
    
    returningIsExitCodeZero in class AbstractProcessTaskFactory<KnifeTaskFactory<RET>,RET>
  - requiringZeroAndReturningStdout
```
public KnifeTaskFactory<java.lang.String> requiringZeroAndReturningStdout()
```
    Specified by:
    
    requiringZeroAndReturningStdout in interface ProcessTaskFactory<RET>
    
    Overrides:
    
    requiringZeroAndReturningStdout in class AbstractProcessTaskFactory<KnifeTaskFactory<RET>,RET>

Class KnifeTaskFactory<RET>

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class brooklyn.util.task.system.internal.SystemProcessTaskFactory

Methods inherited from class brooklyn.util.task.system.internal.AbstractProcessTaskFactory

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

Methods inherited from class java.lang.Object

Field Detail

taskName

Constructor Detail

KnifeTaskFactory

Method Detail

getCompletionListeners

notThrowingOnCommonKnifeErrors

newTask

addKnifeCommandToScript

getCommands

knifeExecutable

knifeAddParameters

knifeConfigFile

knifeSetupCommands

returning

returning

returningIsExitCodeZero

requiringZeroAndReturningStdout