org.apache.brooklyn.util.core.task.ssh.internal

Class PlainSshExecTaskFactory<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.ssh.internal.AbstractSshExecTaskFactory<PlainSshExecTaskFactory<RET>,RET>

org.apache.brooklyn.util.core.task.ssh.internal.PlainSshExecTaskFactory<RET>

All Implemented Interfaces:

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

public class PlainSshExecTaskFactory<RET>
extends AbstractSshExecTaskFactory<PlainSshExecTaskFactory<RET>,RET>

the "Plain" class exists purely so we can massage return types for callers' convenience

Nested Class Summary

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

ProcessTaskStub.ScriptReturnType

Constructor Summary

Constructors

Constructor and Description
PlainSshExecTaskFactory(java.util.List<java.lang.String> commands) Constructor where machine will be added later
PlainSshExecTaskFactory(SshMachineLocation machine, java.util.List<java.lang.String> commands) Convenience constructor to supply machine immediately
PlainSshExecTaskFactory(SshMachineLocation machine, java.lang.String... commands) convenience constructor to supply machine immediately
PlainSshExecTaskFactory(java.lang.String... commands) constructor where machine will be added later

Method Summary

Modifier and Type	Method and Description
PlainSshExecTaskFactory<java.lang.String>	requiringZeroAndReturningStdout()
<RET2> PlainSshExecTaskFactory<RET2>	returning(<any> resultTransformation)
<T2> PlainSshExecTaskFactory<T2>	returning(ProcessTaskStub.ScriptReturnType type)
PlainSshExecTaskFactory<java.lang.Boolean>	returningIsExitCodeZero()

Methods inherited from class org.apache.brooklyn.util.core.task.ssh.internal.AbstractSshExecTaskFactory

newTask

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

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

Methods inherited from class org.apache.brooklyn.util.core.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 org.apache.brooklyn.util.core.task.system.ProcessTaskFactory

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

Constructor Detail

PlainSshExecTaskFactory

public PlainSshExecTaskFactory(java.lang.String... commands)

constructor where machine will be added later

PlainSshExecTaskFactory

public PlainSshExecTaskFactory(SshMachineLocation machine,
                               java.lang.String... commands)

convenience constructor to supply machine immediately

PlainSshExecTaskFactory

public PlainSshExecTaskFactory(java.util.List<java.lang.String> commands)

Constructor where machine will be added later

PlainSshExecTaskFactory

public PlainSshExecTaskFactory(SshMachineLocation machine,
                               java.util.List<java.lang.String> commands)

Convenience constructor to supply machine immediately

Method Detail

returning

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

Specified by:

returning in interface ProcessTaskFactory<RET>

Overrides:

returning in class AbstractProcessTaskFactory<PlainSshExecTaskFactory<RET>,RET>

returning

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

Specified by:

returning in interface ProcessTaskFactory<RET>

Overrides:

returning in class AbstractProcessTaskFactory<PlainSshExecTaskFactory<RET>,RET>

returningIsExitCodeZero

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

Specified by:

returningIsExitCodeZero in interface ProcessTaskFactory<RET>

Overrides:

returningIsExitCodeZero in class AbstractProcessTaskFactory<PlainSshExecTaskFactory<RET>,RET>

requiringZeroAndReturningStdout

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

Specified by:

requiringZeroAndReturningStdout in interface ProcessTaskFactory<RET>

Overrides:

requiringZeroAndReturningStdout in class AbstractProcessTaskFactory<PlainSshExecTaskFactory<RET>,RET>