Overview  Package   Class  Deprecated  Index  Help 
Brooklyn
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

brooklyn.entity.software
[Java] Class SshEffectorTasks.SshEffectorTaskFactory

java.lang.Object
  brooklyn.util.task.system.ProcessTaskStub
      brooklyn.util.task.system.internal.AbstractProcessTaskFactory
          brooklyn.util.task.ssh.internal.AbstractSshExecTaskFactory
              brooklyn.entity.software.SshEffectorTasks.SshEffectorTaskFactory
All Implemented Interfaces:
EffectorTaskFactory
public static class SshEffectorTasks.SshEffectorTaskFactory
extends AbstractSshExecTaskFactory

variant of PlainSshExecTaskFactory which fulfills the 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

Field Summary
 
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
SshEffectorTasks.SshEffectorTaskFactory(java.lang.String... commands)

 
Method Summary
ProcessTaskWrapper newTask(Entity entity, Effector effector, ConfigBag parameters)

ProcessTaskWrapper newTask()

SshEffectorTaskFactory requiringZeroAndReturningStdout()

SshEffectorTaskFactory returning(ScriptReturnType type)

SshEffectorTaskFactory returning(Function resultTransformation)

SshEffectorTaskFactory returningIsExitCodeZero()

 
Methods inherited from class AbstractSshExecTaskFactory
newTask
 
Methods inherited from class AbstractProcessTaskFactory
add, add, addCompletionListener, allowingNonZeroExitCode, configure, constructCustomizedTaskBuilder, environmentVariable, environmentVariables, finalize, machine, markDirty, requiringExitCodeZero, requiringExitCodeZero, requiringZeroAndReturningStdout, returning, returning, returningIsExitCodeZero, runAsCommand, runAsRoot, runAsScript, self, summary
 
Methods inherited from class ProcessTaskStub
getCommands, getCompletionListeners, getConfig, getMachine, getShellEnvironment, getSummary, toString
 

Constructor Detail

SshEffectorTasks.SshEffectorTaskFactory

public SshEffectorTasks.SshEffectorTaskFactory(java.lang.String... commands)

 
Method Detail

newTask

@Override
public ProcessTaskWrapper newTask(Entity entity, Effector effector, ConfigBag parameters)

newTask

@Override
public ProcessTaskWrapper newTask()

requiringZeroAndReturningStdout

public SshEffectorTaskFactory requiringZeroAndReturningStdout()

returning

@Override
public SshEffectorTaskFactory returning(ScriptReturnType type)

returning

public SshEffectorTaskFactory returning(Function resultTransformation)

returningIsExitCodeZero

@Override
public SshEffectorTaskFactory returningIsExitCodeZero()

 

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.