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

brooklyn.util.task.system
[Java] Interface ProcessTaskFactory

brooklyn.util.task.system.ProcessTaskFactory
  brooklyn.management.TaskFactory
All Superinterfaces:
TaskFactory
public interface ProcessTaskFactory
extends TaskFactory
Method Summary
ProcessTaskFactory add(java.lang.String... commandsToAdd)

ProcessTaskFactory add(java.lang.Iterable commandsToAdd)

ProcessTaskFactory addCompletionListener(Function function)

adds a listener which will be notified of (otherwise) successful completion, typically used to invalidate the result (ie throw exception, to promote a string in the output to an exception); invoked even if return code is zero, so a better error can be thrown
ProcessTaskFactory allowingNonZeroExitCode()

ProcessTaskFactory configure(ConfigKey key, java.lang.Object value)

allows setting config-key based properties for specific underlying tools
ProcessTaskFactory environmentVariable(java.lang.String key, java.lang.String val)

ProcessTaskFactory environmentVariables(java.util.Map vars)

ProcessTaskFactory machine(SshMachineLocation machine)

ProcessTaskFactory requiringExitCodeZero()

ProcessTaskFactory requiringExitCodeZero(java.lang.String extraErrorMessage)

ProcessTaskFactory requiringZeroAndReturningStdout()

ProcessTaskFactory returning(ScriptReturnType type)

ProcessTaskFactory returning(Function resultTransformation)

ProcessTaskFactory returningIsExitCodeZero()

ProcessTaskFactory runAsCommand()

ProcessTaskFactory runAsRoot()

ProcessTaskFactory runAsScript()

ProcessTaskFactory summary(java.lang.String summary)

 
Methods inherited from interface TaskFactory
newTask
 

Method Detail

add

public ProcessTaskFactory add(java.lang.String... commandsToAdd)

add

public ProcessTaskFactory add(java.lang.Iterable commandsToAdd)

addCompletionListener

public ProcessTaskFactory addCompletionListener(Function function)
adds a listener which will be notified of (otherwise) successful completion, typically used to invalidate the result (ie throw exception, to promote a string in the output to an exception); invoked even if return code is zero, so a better error can be thrown

allowingNonZeroExitCode

public ProcessTaskFactory allowingNonZeroExitCode()

configure

@Beta
public ProcessTaskFactory configure(ConfigKey key, java.lang.Object value)
allows setting config-key based properties for specific underlying tools

environmentVariable

public ProcessTaskFactory environmentVariable(java.lang.String key, java.lang.String val)

environmentVariables

public ProcessTaskFactory environmentVariables(java.util.Map vars)

machine

public ProcessTaskFactory machine(SshMachineLocation machine)

requiringExitCodeZero

public ProcessTaskFactory requiringExitCodeZero()

requiringExitCodeZero

public ProcessTaskFactory requiringExitCodeZero(java.lang.String extraErrorMessage)

requiringZeroAndReturningStdout

public ProcessTaskFactory requiringZeroAndReturningStdout()

returning

public ProcessTaskFactory returning(ScriptReturnType type)

returning

public ProcessTaskFactory returning(Function resultTransformation)

returningIsExitCodeZero

public ProcessTaskFactory returningIsExitCodeZero()

runAsCommand

public ProcessTaskFactory runAsCommand()

runAsRoot

public ProcessTaskFactory runAsRoot()

runAsScript

public ProcessTaskFactory runAsScript()

summary

public ProcessTaskFactory summary(java.lang.String summary)

 

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