|
Brooklyn | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectbrooklyn.util.task.system.ProcessTaskStub
brooklyn.util.task.system.internal.AbstractProcessTaskFactory
brooklyn.util.task.system.internal.SystemProcessTaskFactory
brooklyn.entity.chef.KnifeTaskFactory
public class KnifeTaskFactory extends SystemProcessTaskFactory
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 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:
(Other fields will typically be used by methods calling to this factory.)
Field Summary | |
---|---|
protected java.lang.String |
knifeConfigFile
|
protected java.lang.String |
knifeExecutable
|
protected java.util.List |
knifeParameters
|
protected java.lang.String |
knifeSetupCommands
|
java.lang.String |
taskName
|
protected java.lang.Boolean |
throwOnCommonKnifeErrors
|
Fields inherited from class AbstractProcessTaskFactory | |
---|---|
dirty |
Fields inherited from class ProcessTaskStub | |
---|---|
commands, completionListeners, config, extraErrorMessage, machine, requireExitCodeZero, returnResultTransformation, returnType, runAsRoot, runAsScript, shellEnvironment, summary |
Constructor Summary | |
KnifeTaskFactory(java.lang.String taskName)
|
Method Summary | |
---|---|
KnifeTaskFactory
|
addKnifeCommandToScript()
Inserts the knife command at the current place in the list. |
protected java.lang.String
|
buildKnifeCommand(int knifeCommandIndex)
creates the command for running knife. |
protected Entity
|
entity()
callers should allow this to be null so task can be used outside of an entity |
protected java.lang.Object
|
entityConfig(ConfigKey key)
|
java.util.List
|
getCommands()
|
java.util.List
|
getCompletionListeners()
|
protected java.util.List
|
initialKnifeParameters()
allows a way for subclasses to build up parameters at the start |
protected void
|
insertKnifeCompletionListenerIntoCompletionListenersList(java.util.List listeners)
|
KnifeTaskFactory
|
knifeAddParameters(java.lang.String word1, java.lang.String... words)
|
KnifeTaskFactory
|
knifeConfigFile(java.lang.String knifeConfigFile)
|
protected java.lang.String
|
knifeConfigFileOption()
|
KnifeTaskFactory
|
knifeExecutable(java.lang.String knifeExecutable)
|
protected java.lang.String
|
knifeExecutable()
|
protected java.util.List
|
knifeParameters()
|
KnifeTaskFactory
|
knifeSetupCommands(java.lang.String knifeSetupCommands)
|
protected java.lang.String
|
knifeSetupCommands()
|
ProcessTaskWrapper
|
newTask()
|
KnifeTaskFactory
|
notThrowingOnCommonKnifeErrors()
|
KnifeTaskFactory
|
requiringZeroAndReturningStdout()
|
KnifeTaskFactory
|
returning(ScriptReturnType type)
|
KnifeTaskFactory
|
returning(Function resultTransformation)
|
KnifeTaskFactory
|
returningIsExitCodeZero()
|
Methods inherited from class SystemProcessTaskFactory | |
---|---|
machine, newExecWithLoggingHelpers, newTask |
Methods inherited from class ProcessTaskStub | |
---|---|
getCommands, getCompletionListeners, getConfig, getMachine, getShellEnvironment, getSummary, toString |
Field Detail |
---|
protected java.lang.String knifeConfigFile
protected java.lang.String knifeExecutable
protected java.util.List knifeParameters
protected java.lang.String knifeSetupCommands
public final java.lang.String taskName
protected java.lang.Boolean throwOnCommonKnifeErrors
Constructor Detail |
---|
public KnifeTaskFactory(java.lang.String taskName)
Method Detail |
---|
public KnifeTaskFactory addKnifeCommandToScript()
protected java.lang.String buildKnifeCommand(int knifeCommandIndex)
} protected Entity entity()
protected java.lang.Object entityConfig(ConfigKey key)
String setupCommands = knifeSetupCommands(); public java.util.List getCommands()
MutableList, Void>> result = MutableList.copyOf(super.getCompletionListeners()); public java.util.List getCompletionListeners()
protected java.util.List initialKnifeParameters()
protected void insertKnifeCompletionListenerIntoCompletionListenersList(java.util.List listeners)
public KnifeTaskFactory knifeAddParameters(java.lang.String word1, java.lang.String... words)
public KnifeTaskFactory knifeConfigFile(java.lang.String knifeConfigFile)
String knifeConfigFileFromConfig = entityConfig(ChefConfig.KNIFE_CONFIG_FILE); protected java.lang.String knifeConfigFileOption()
public KnifeTaskFactory knifeExecutable(java.lang.String knifeExecutable)
protected java.lang.String knifeExecutable()
protected java.util.List knifeParameters()
public KnifeTaskFactory knifeSetupCommands(java.lang.String knifeSetupCommands)
if (knifeSetupCommandsFromConfig!=null) return knifeSetupCommandsFromConfig; protected java.lang.String knifeSetupCommands()
} public ProcessTaskWrapper newTask()
public KnifeTaskFactory notThrowingOnCommonKnifeErrors()
} public KnifeTaskFactory requiringZeroAndReturningStdout()
publicKnifeTaskFactory returning(Function , RET2> resultTransformation) { public KnifeTaskFactory returning(ScriptReturnType type)
public KnifeTaskFactoryreturningIsExitCodeZero() { public KnifeTaskFactory returning(Function resultTransformation)
public KnifeTaskFactoryrequiringZeroAndReturningStdout() { public KnifeTaskFactory returningIsExitCodeZero()
Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.