org.apache.brooklyn.entity.chef

Class KnifeConvergeTaskFactory<RET>

java.lang.Object

org.apache.brooklyn.util.core.task.system.ProcessTaskStub

org.apache.brooklyn.util.core.task.system.internal.AbstractProcessTaskFactory<T,RET>

org.apache.brooklyn.util.core.task.system.internal.SystemProcessTaskFactory<KnifeTaskFactory<RET>,RET>

org.apache.brooklyn.entity.chef.KnifeTaskFactory<RET>

org.apache.brooklyn.entity.chef.KnifeConvergeTaskFactory<RET>

All Implemented Interfaces:

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

public class KnifeConvergeTaskFactory<RET>
extends KnifeTaskFactory<RET>

Nested Class Summary

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

SystemProcessTaskFactory.ConcreteSystemProcessTaskFactory<RET>

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

ProcessTaskStub.ScriptReturnType

Field Summary

Fields inherited from class org.apache.brooklyn.entity.chef.KnifeTaskFactory

taskName

Constructor Summary

Constructors

Constructor and Description
KnifeConvergeTaskFactory(java.lang.String taskName)

Method Summary

Modifier and Type	Method and Description
KnifeConvergeTaskFactory<RET>	knifeAddAttributes(java.util.Map<? extends java.lang.Object,? extends java.lang.Object> attributes) includes the given attributes in the attributes to be passed to chef; when combining with other attributes, this uses Jsonya semantics to add (a deep add, combining lists and maps)
KnifeConvergeTaskFactory<RET>	knifeAddExtraBootstrapParameters(java.lang.String extraBootstrapParameter1, java.lang.String... extraBootstrapParameters) parameters to pass to knife after the bootstrap command
KnifeConvergeTaskFactory<RET>	knifeAddParameters(java.lang.String word1, java.lang.String... words)
KnifeConvergeTaskFactory<RET>	knifeNodeName(java.lang.String nodeName) what node name to pass to knife; default = null, meaning chef-client will pick the node name
KnifeConvergeTaskFactory<RET>	knifePort(int port) tell knife to use an explicit port
KnifeConvergeTaskFactory<RET>	knifePortUseKnifeDefault() omit the port parameter altogether (let knife use its default)
KnifeConvergeTaskFactory<RET>	knifePortUseMachineSshPort() use the default port known to brooklyn for the target machine for ssh
KnifeConvergeTaskFactory<RET>	knifeRunList(<any> runList) function supplying the run list to be passed to knife, evaluated at the last moment
KnifeConvergeTaskFactory<RET>	knifeRunTwice(boolean runTwice) whether knife should attempt to run twice; see ChefConfig.CHEF_RUN_CONVERGE_TWICE
KnifeConvergeTaskFactory<RET>	knifeSudo(boolean sudo) whether to pass --sudo to knife; default true
KnifeConvergeTaskFactory<java.lang.String>	requiringZeroAndReturningStdout()
<RET2> KnifeConvergeTaskFactory<RET2>	returning(<any> resultTransformation)
<T2> KnifeConvergeTaskFactory<T2>	returning(ProcessTaskStub.ScriptReturnType type)
KnifeConvergeTaskFactory<java.lang.Boolean>	returningIsExitCodeZero()

Methods inherited from class org.apache.brooklyn.entity.chef.KnifeTaskFactory

addKnifeCommandToScript, getCommands, getCompletionListeners, knifeConfigFile, knifeExecutable, knifeSetupCommands, newTask, notThrowingOnCommonKnifeErrors

Methods inherited from class org.apache.brooklyn.util.core.task.system.internal.SystemProcessTaskFactory

directory, loginShell, machine

Methods inherited from class org.apache.brooklyn.util.core.task.system.internal.AbstractProcessTaskFactory

add, add, addCompletionListener, allowingNonZeroExitCode, configure, configure, constructCustomizedTaskBuilder, environmentVariable, environmentVariables, requiringExitCodeZero, requiringExitCodeZero, runAsCommand, runAsRoot, runAsScript, summary

Methods inherited from class org.apache.brooklyn.util.core.task.system.ProcessTaskStub

getMachine, getShellEnvironment, getSummary, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

KnifeConvergeTaskFactory

public KnifeConvergeTaskFactory(java.lang.String taskName)

Method Detail

knifeRunTwice

public KnifeConvergeTaskFactory<RET> knifeRunTwice(boolean runTwice)

whether knife should attempt to run twice; see ChefConfig.CHEF_RUN_CONVERGE_TWICE

knifeSudo

public KnifeConvergeTaskFactory<RET> knifeSudo(boolean sudo)

whether to pass --sudo to knife; default true

knifeNodeName

public KnifeConvergeTaskFactory<RET> knifeNodeName(java.lang.String nodeName)

what node name to pass to knife; default = null, meaning chef-client will pick the node name

knifePort

public KnifeConvergeTaskFactory<RET> knifePort(int port)

tell knife to use an explicit port

knifePortUseKnifeDefault

public KnifeConvergeTaskFactory<RET> knifePortUseKnifeDefault()

omit the port parameter altogether (let knife use its default)

knifePortUseMachineSshPort

public KnifeConvergeTaskFactory<RET> knifePortUseMachineSshPort()

use the default port known to brooklyn for the target machine for ssh

knifeAddExtraBootstrapParameters

public KnifeConvergeTaskFactory<RET> knifeAddExtraBootstrapParameters(java.lang.String extraBootstrapParameter1,
                                                                      java.lang.String... extraBootstrapParameters)

parameters to pass to knife after the bootstrap command

knifeRunList

public KnifeConvergeTaskFactory<RET> knifeRunList(<any> runList)

function supplying the run list to be passed to knife, evaluated at the last moment

knifeAddAttributes

public KnifeConvergeTaskFactory<RET> knifeAddAttributes(java.util.Map<? extends java.lang.Object,? extends java.lang.Object> attributes)

includes the given attributes in the attributes to be passed to chef; when combining with other attributes, this uses Jsonya semantics to add (a deep add, combining lists and maps)

returning

public <T2> KnifeConvergeTaskFactory<T2> returning(ProcessTaskStub.ScriptReturnType type)

Specified by:

returning in interface ProcessTaskFactory<RET>

Overrides:

returning in class KnifeTaskFactory<RET>

returning

public <RET2> KnifeConvergeTaskFactory<RET2> returning(<any> resultTransformation)

Specified by:

returning in interface ProcessTaskFactory<RET>

Overrides:

returning in class KnifeTaskFactory<RET>

returningIsExitCodeZero

public KnifeConvergeTaskFactory<java.lang.Boolean> returningIsExitCodeZero()

Specified by:

returningIsExitCodeZero in interface ProcessTaskFactory<RET>

Overrides:

returningIsExitCodeZero in class KnifeTaskFactory<RET>

requiringZeroAndReturningStdout

public KnifeConvergeTaskFactory<java.lang.String> requiringZeroAndReturningStdout()

Specified by:

requiringZeroAndReturningStdout in interface ProcessTaskFactory<RET>

Overrides:

requiringZeroAndReturningStdout in class KnifeTaskFactory<RET>

knifeAddParameters

public KnifeConvergeTaskFactory<RET> knifeAddParameters(java.lang.String word1,
                                                        java.lang.String... words)

Overrides:

knifeAddParameters in class KnifeTaskFactory<RET>