org.apache.brooklyn.entity.software.base.lifecycle

Class WinRmExecuteHelper

java.lang.Object

org.apache.brooklyn.entity.software.base.lifecycle.WinRmExecuteHelper

public class WinRmExecuteHelper
extends java.lang.Object

org.apache.brooklyn.entity.software.base.lifecycle.ScriptHelper analog for WinRM

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG
java.lang.String	summary

Constructor Summary

Constructors

Constructor and Description
WinRmExecuteHelper(NativeWindowsScriptRunner runner, java.lang.String summary)

Method Summary

Modifier and Type	Method and Description
int	execute()
int	executeInternal()
WinRmExecuteHelper	failOnNonZeroResultCode()
WinRmExecuteHelper	gatherOutput()
WinRmExecuteHelper	gatherOutput(boolean gather)
java.util.Map	getFlags()
java.lang.String	getResultStderr()
java.lang.String	getResultStdout()
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
Task<java.lang.Integer>	queue() queues the task for execution if we are in a TaskQueueingContext (e.g.
WinRmExecuteHelper	setCommand(java.lang.String command)
WinRmExecuteHelper	setEnv(java.util.Map<java.lang.String,java.lang.String> env)
WinRmExecuteHelper	setNtDomain(java.lang.String domain)
WinRmExecuteHelper	setPsCommand(java.lang.String psCommand)
WinRmExecuteHelper	updateTaskAndFailOnNonZeroResultCode()
WinRmExecuteHelper	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

Constructor Detail

WinRmExecuteHelper

public WinRmExecuteHelper(NativeWindowsScriptRunner runner,
                          java.lang.String summary)

Method Detail

setNtDomain

public WinRmExecuteHelper setNtDomain(java.lang.String domain)

setCommand

public WinRmExecuteHelper setCommand(java.lang.String command)

setPsCommand

public WinRmExecuteHelper setPsCommand(java.lang.String psCommand)

setEnv

public WinRmExecuteHelper setEnv(java.util.Map<java.lang.String,java.lang.String> env)

useMutex

public WinRmExecuteHelper 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)

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

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

execute

public int execute()

executeInternal

public int executeInternal()

failOnNonZeroResultCode

public WinRmExecuteHelper failOnNonZeroResultCode()

updateTaskAndFailOnNonZeroResultCode

public WinRmExecuteHelper updateTaskAndFailOnNonZeroResultCode()

gatherOutput

public WinRmExecuteHelper gatherOutput()

gatherOutput

public WinRmExecuteHelper gatherOutput(boolean gather)

getFlags

public java.util.Map getFlags()

getResultStdout

public java.lang.String getResultStdout()

getResultStderr

public java.lang.String getResultStderr()