SshEffectorTasks.SshEffectorTaskFactory (Apache Brooklyn)

java.lang.Object
- brooklyn.util.task.system.ProcessTaskStub
- - brooklyn.util.task.system.internal.AbstractProcessTaskFactory<T,RET>
  - - brooklyn.util.task.ssh.internal.AbstractSshExecTaskFactory<SshEffectorTasks.SshEffectorTaskFactory<RET>,RET>
    - - brooklyn.entity.software.SshEffectorTasks.SshEffectorTaskFactory<RET>

All Implemented Interfaces:

EffectorTasks.EffectorTaskFactory<RET>, TaskFactory<ProcessTaskWrapper<RET>>, ProcessTaskFactory<RET>

Enclosing class:

SshEffectorTasks
```
public static class SshEffectorTasks.SshEffectorTaskFactory<RET>
extends AbstractSshExecTaskFactory<SshEffectorTasks.SshEffectorTaskFactory<RET>,RET>
implements EffectorTasks.EffectorTaskFactory<RET>
```
variant of PlainSshExecTaskFactory which fulfills the EffectorTasks.EffectorTaskFactory signature so can be used directly as an impl for an effector, also injects the machine automatically; can also be used outwith effector contexts, and machine is still injected if it is run from inside a task at an entity with a single SshMachineLocation

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

Constructor Summary

Constructors
Constructor and Description
`SshEffectorTasks.SshEffectorTaskFactory(SshMachineLocation machine, java.lang.String... commands)`
`SshEffectorTasks.SshEffectorTaskFactory(java.lang.String... commands)`

Method Summary

Methods
Modifier and Type	Method and Description
`ProcessTaskWrapper<RET>`	`newTask()`
`ProcessTaskWrapper<RET>`	`newTask(Entity entity, Effector<RET> effector, ConfigBag parameters)`
`SshEffectorTasks.SshEffectorTaskFactory<java.lang.String>`	`requiringZeroAndReturningStdout()`
`<RET2> SshEffectorTasks.SshEffectorTaskFactory<RET2>`	`returning(com.google.common.base.Function<ProcessTaskWrapper<?>,RET2> resultTransformation)`
`<T2> SshEffectorTasks.SshEffectorTaskFactory<T2>`	`returning(ProcessTaskStub.ScriptReturnType type)`
`SshEffectorTasks.SshEffectorTaskFactory<java.lang.Boolean>`	`returningIsExitCodeZero()`

Methods inherited from class brooklyn.util.task.system.internal.AbstractProcessTaskFactory
add, add, addCompletionListener, allowingNonZeroExitCode, configure, configure, constructCustomizedTaskBuilder, environmentVariable, environmentVariables, machine, requiringExitCodeZero, requiringExitCodeZero, runAsCommand, runAsRoot, runAsScript, 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.util.task.system.ProcessTaskFactory
add, add, addCompletionListener, allowingNonZeroExitCode, configure, configure, environmentVariable, environmentVariables, machine, requiringExitCodeZero, requiringExitCodeZero, runAsCommand, runAsRoot, runAsScript, summary

- Constructor Detail
  - SshEffectorTasks.SshEffectorTaskFactory
```
public SshEffectorTasks.SshEffectorTaskFactory(java.lang.String... commands)
```
  - SshEffectorTasks.SshEffectorTaskFactory
```
public SshEffectorTasks.SshEffectorTaskFactory(SshMachineLocation machine,
                                       java.lang.String... commands)
```
- Method Detail
  - newTask
```
public ProcessTaskWrapper<RET> newTask(Entity entity,
                              Effector<RET> effector,
                              ConfigBag parameters)
```
    Specified by:
    
    newTask in interface EffectorTasks.EffectorTaskFactory<RET>
  - newTask
```
public ProcessTaskWrapper<RET> newTask()
```
    Specified by:
    
    newTask in interface TaskFactory<ProcessTaskWrapper<RET>>
    
    Overrides:
    
    newTask in class AbstractSshExecTaskFactory<SshEffectorTasks.SshEffectorTaskFactory<RET>,RET>
  - returning
```
public <T2> SshEffectorTasks.SshEffectorTaskFactory<T2> returning(ProcessTaskStub.ScriptReturnType type)
```
    Specified by:
    
    returning in interface ProcessTaskFactory<RET>
    
    Overrides:
    
    returning in class AbstractProcessTaskFactory<SshEffectorTasks.SshEffectorTaskFactory<RET>,RET>
  - returningIsExitCodeZero
```
public SshEffectorTasks.SshEffectorTaskFactory<java.lang.Boolean> returningIsExitCodeZero()
```
    Specified by:
    
    returningIsExitCodeZero in interface ProcessTaskFactory<RET>
    
    Overrides:
    
    returningIsExitCodeZero in class AbstractProcessTaskFactory<SshEffectorTasks.SshEffectorTaskFactory<RET>,RET>
  - requiringZeroAndReturningStdout
```
public SshEffectorTasks.SshEffectorTaskFactory<java.lang.String> requiringZeroAndReturningStdout()
```
    Specified by:
    
    requiringZeroAndReturningStdout in interface ProcessTaskFactory<RET>
    
    Overrides:
    
    requiringZeroAndReturningStdout in class AbstractProcessTaskFactory<SshEffectorTasks.SshEffectorTaskFactory<RET>,RET>
  - returning
```
public <RET2> SshEffectorTasks.SshEffectorTaskFactory<RET2> returning(com.google.common.base.Function<ProcessTaskWrapper<?>,RET2> resultTransformation)
```
    Specified by:
    
    returning in interface ProcessTaskFactory<RET>
    
    Overrides:
    
    returning in class AbstractProcessTaskFactory<SshEffectorTasks.SshEffectorTaskFactory<RET>,RET>

Class SshEffectorTasks.SshEffectorTaskFactory<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.internal.AbstractProcessTaskFactory

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

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.util.task.system.ProcessTaskFactory

Constructor Detail

SshEffectorTasks.SshEffectorTaskFactory

SshEffectorTasks.SshEffectorTaskFactory

Method Detail

newTask

newTask

returning

returningIsExitCodeZero

requiringZeroAndReturningStdout

returning