ScriptHelper (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.entity.software.base.lifecycle.ScriptHelper

public class ScriptHelper
extends java.lang.Object

Field Summary

Fields
Modifier and Type Field and Description

ScriptPart body

ScriptPart footer

ScriptPart header

static org.slf4j.Logger log

java.lang.String summary

Fields
Modifier and Type	Field and Description
`ScriptPart`	`body`
`ScriptPart`	`footer`
`ScriptPart`	`header`
`static org.slf4j.Logger`	`log`
`java.lang.String`	`summary`

Constructor Summary

Constructors
Constructor and Description

ScriptHelper(NaiveScriptRunner runner, java.lang.String summary)

Constructors
Constructor and Description
`ScriptHelper(NaiveScriptRunner runner, java.lang.String summary)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ScriptHelper`	`closeSshConnection()` The connection should be closed and disconnected once the commands have executed.
`ScriptHelper`	`environmentVariablesReset()` ensures the script runs with no environment variables; by default they will be inherited from the entity/driver (eg getShellEnvironment())
`ScriptHelper`	`environmentVariablesReset(java.util.Map<?,?> envVarsToSet)` overrides the default environment variables to use the given set; by default "env" is inherited from the entity/driver (eg getShellEnvironment()); TODO would be nice to have a way to add just a few, but there is no way currently to access that so it's a bit hard to do that
`int`	`execute()`
`ScriptHelper`	`executeIf(<any> c)`
`ScriptHelper`	`executeIf(groovy.lang.Closure c)` Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.
`int`	`executeInternal()`
`ScriptHelper`	`failIfBodyEmpty()`
`ScriptHelper`	`failOnNonZeroResultCode()`
`ScriptHelper`	`failOnNonZeroResultCode(boolean val)`
`ScriptHelper`	`failOnNonZeroResultCodeWithoutUpdatingTask()`
`ScriptHelper`	`gatherOutput()`
`ScriptHelper`	`gatherOutput(boolean gather)`
`java.util.Map`	`getFlags()`
`java.util.List<java.lang.String>`	`getLines()`
`java.lang.String`	`getResultStderr()`
`java.lang.String`	`getResultStdout()`
`ScriptHelper`	`inessential()`
`Task<java.lang.Integer>`	`newTask()` creates a task which will execute this script; note this can only be run once per instance of this class
`ScriptHelper`	`noExtraOutput()` Indicate that no extra output should be appended to stdout.
`Task<java.lang.Integer>`	`peekTask()` returns the task, if it has been constructed, or null; use `newTask()` to build (if it is null and you need a task)
`Task<java.lang.Integer>`	`queue()` queues the task for execution if we are in a `TaskQueueingContext` (e.g.
`ScriptHelper`	`requireResultCode(<any> integerFilter)`
`ScriptHelper`	`requireResultCode(groovy.lang.Closure integerFilter)` Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.
`<T> ScriptHelper`	`setFlag(ConfigKey<T> flag, T value)`
`ScriptHelper`	`setFlag(java.lang.String flag, java.lang.Object value)`
`void`	`setInessential()`
`void`	`setTransient()` indicates explicitly that the task can be safely forgotten about after it runs; useful for things like check_running which run repeatedly
`ScriptHelper`	`skipIfBodyEmpty()`
`ScriptHelper`	`uniqueSshConnection()` Unique ID for the command execution; ensures new SSH connection from the pool.
`ScriptHelper`	`updateTaskAndFailOnNonZeroResultCode()`
`ScriptHelper`	`useMutex(WithMutexes mutexSupport, java.lang.String mutexId, java.lang.String description)` indicates that the script should acquire the given mutexId on the given mutexSupport and maintain it for the duration of script execution; typically used to prevent parallel scripts from conflicting in access to a resource (e.g.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - log
```
public static final org.slf4j.Logger log
```
  - summary
```
public final java.lang.String summary
```
  - header
```
public final ScriptPart header
```
  - body
```
public final ScriptPart body
```
  - footer
```
public final ScriptPart footer
```
- Constructor Detail
  - ScriptHelper
```
public ScriptHelper(NaiveScriptRunner runner,
                    java.lang.String summary)
```
- Method Detail
  - executeIf
```
@Deprecated
public ScriptHelper executeIf(groovy.lang.Closure c)
```
    Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.
    
    Takes a closure which accepts this ScriptHelper and returns true or false as to whether the script needs to run (or can throw error if desired)
  - executeIf
```
public ScriptHelper executeIf(<any> c)
```
  - skipIfBodyEmpty
```
public ScriptHelper skipIfBodyEmpty()
```
  - failIfBodyEmpty
```
public ScriptHelper failIfBodyEmpty()
```
  - failOnNonZeroResultCode
```
public ScriptHelper failOnNonZeroResultCode(boolean val)
```
  - failOnNonZeroResultCode
```
public ScriptHelper failOnNonZeroResultCode()
```
  - failOnNonZeroResultCodeWithoutUpdatingTask
```
public ScriptHelper failOnNonZeroResultCodeWithoutUpdatingTask()
```
  - updateTaskAndFailOnNonZeroResultCode
```
public ScriptHelper updateTaskAndFailOnNonZeroResultCode()
```
  - requireResultCode
```
@Deprecated
public ScriptHelper requireResultCode(groovy.lang.Closure integerFilter)
```
    Deprecated. since 0.11.0; explicit groovy utilities/support will be deleted.
    
    Convenience for error-checking the result.
    Takes closure which accepts bash exit code (integer), and returns false if it is invalid. Default is that this resultCodeCheck closure always returns true (and the exit code is made available to the caller if they care)
  - requireResultCode
```
public ScriptHelper requireResultCode(<any> integerFilter)
```
  - useMutex
```
public ScriptHelper useMutex(WithMutexes mutexSupport,
                             java.lang.String mutexId,
                             java.lang.String description)
```
    indicates that the script should acquire the given mutexId on the given mutexSupport and maintain it for the duration of script execution; typically used to prevent parallel scripts from conflicting in access to a resource (e.g. a folder, or a config file used by a process)
  - gatherOutput
```
public ScriptHelper gatherOutput()
```
  - gatherOutput
```
public ScriptHelper gatherOutput(boolean gather)
```
  - noExtraOutput
```
public ScriptHelper noExtraOutput()
```
    Indicate that no extra output should be appended to stdout.
    By default Brooklyn appends a message like "Executed /tmp/brooklyn-20141010-164855950...sh, result 0" to script output.
  - closeSshConnection
```
public ScriptHelper closeSshConnection()
```
    The connection should be closed and disconnected once the commands have executed.
  - uniqueSshConnection
```
public ScriptHelper uniqueSshConnection()
```
    Unique ID for the command execution; ensures new SSH connection from the pool.
  - setTransient
```
public void setTransient()
```
    indicates explicitly that the task can be safely forgotten about after it runs; useful for things like check_running which run repeatedly
  - setInessential
```
public void setInessential()
```
  - inessential
```
public ScriptHelper inessential()
```
  - newTask
```
public Task<java.lang.Integer> newTask()
```
    creates a task which will execute this script; note this can only be run once per instance of this class
  - peekTask
```
public Task<java.lang.Integer> peekTask()
```
    returns the task, if it has been constructed, or null; use newTask() to build (if it is null and you need a task)
  - queue
```
public Task<java.lang.Integer> queue()
```
    queues the task for execution if we are in a TaskQueueingContext (e.g. EffectorTaskFactory); or if we aren't in a queueing context, it will submit the task (assuming there is an ExecutionContext _and_ block until completion, throwing on error
  - execute
```
public int execute()
```
  - executeInternal
```
public int executeInternal()
```
  - getFlags
```
public java.util.Map getFlags()
```
  - setFlag
```
public ScriptHelper setFlag(java.lang.String flag,
                            java.lang.Object value)
```
  - setFlag
```
public <T> ScriptHelper setFlag(ConfigKey<T> flag,
                                T value)
```
  - environmentVariablesReset
```
public ScriptHelper environmentVariablesReset()
```
    ensures the script runs with no environment variables; by default they will be inherited from the entity/driver (eg getShellEnvironment())
  - environmentVariablesReset
```
public ScriptHelper environmentVariablesReset(java.util.Map<?,?> envVarsToSet)
```
    overrides the default environment variables to use the given set; by default "env" is inherited from the entity/driver (eg getShellEnvironment()); TODO would be nice to have a way to add just a few, but there is no way currently to access that so it's a bit hard to do that
  - getLines
```
public java.util.List<java.lang.String> getLines()
```
  - getResultStdout
```
public java.lang.String getResultStdout()
```
  - getResultStderr
```
public java.lang.String getResultStderr()
```

Class ScriptHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

summary

header

body

footer

Constructor Detail

ScriptHelper

Method Detail

executeIf

executeIf

skipIfBodyEmpty

failIfBodyEmpty

failOnNonZeroResultCode

failOnNonZeroResultCode

failOnNonZeroResultCodeWithoutUpdatingTask

updateTaskAndFailOnNonZeroResultCode

requireResultCode

requireResultCode

useMutex

gatherOutput

gatherOutput

noExtraOutput

closeSshConnection

uniqueSshConnection

setTransient

setInessential

inessential

newTask

peekTask

queue

execute

executeInternal

getFlags

setFlag

setFlag

environmentVariablesReset

environmentVariablesReset

getLines

getResultStdout

getResultStderr