ExecWithLoggingHelpers (Brooklyn)

Overview

Package

Class

Deprecated

Index

Help

Brooklyn

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

brooklyn.util.task.system.internal
[Java] Class ExecWithLoggingHelpers

java.lang.Object
  brooklyn.util.task.system.internal.ExecWithLoggingHelpers

public abstract class ExecWithLoggingHelpers

Nested Class Summary
`interface`	`ExecWithLoggingHelpers.ExecRunner`

Field Summary
`static ConfigKey`	`LOG_PREFIX`
`static ConfigKey`	`NO_STDERR_LOGGING`
`static ConfigKey`	`NO_STDOUT_LOGGING`
`static ConfigKey`	`STDERR`
`static ConfigKey`	`STDOUT`
`protected Logger`	`commandLogger`
`protected java.lang.String`	`shortName`

Constructor Summary
`ExecWithLoggingHelpers(java.lang.String shortName)` takes a very short name for use in blocking details, e.g.

Method Summary
`protected java.lang.String`	`constructDefaultLoggingPrefix(ConfigBag execFlags)`
`int`	`execCommands(java.util.Map props, java.lang.String summaryForLogging, java.util.List commands, java.util.Map env)`
`int`	`execScript(java.util.Map props, java.lang.String summaryForLogging, java.util.List commands, java.util.Map env)`
`int`	`execWithLogging(java.util.Map props, java.lang.String summaryForLogging, java.util.List commands, java.util.Map env, ExecWithLoggingHelpers.ExecRunner execCommand)`
`protected java.lang.Object`	`execWithTool(MutableMap toolCreationAndConnectionProperties, Function runMethodOnTool)`
`protected java.lang.String`	`getTargetName()`
`ExecWithLoggingHelpers`	`logger(Logger commandLogger)`
`protected void`	`preExecChecks()`

Methods inherited from class java.lang.Object
java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()

Field Detail

LOG_PREFIX

public static final ConfigKey LOG_PREFIX

NO_STDERR_LOGGING

public static final ConfigKey NO_STDERR_LOGGING

NO_STDOUT_LOGGING

public static final ConfigKey NO_STDOUT_LOGGING

STDERR

public static final ConfigKey STDERR

STDOUT

public static final ConfigKey STDOUT

commandLogger

protected Logger commandLogger

shortName

protected final java.lang.String shortName

Constructor Detail

ExecWithLoggingHelpers

public ExecWithLoggingHelpers(java.lang.String shortName)

takes a very short name for use in blocking details, e.g. SSH or Process

Method Detail

constructDefaultLoggingPrefix

protected java.lang.String constructDefaultLoggingPrefix(ConfigBag execFlags)

execCommands

public int execCommands(java.util.Map props, java.lang.String summaryForLogging, java.util.List commands, java.util.Map env)

execScript

public int execScript(java.util.Map props, java.lang.String summaryForLogging, java.util.List commands, java.util.Map env)

execWithLogging

@SuppressWarnings("resource")
public int execWithLogging(java.util.Map props, java.lang.String summaryForLogging, java.util.List commands, java.util.Map env, ExecWithLoggingHelpers.ExecRunner execCommand)

execWithTool

protected java.lang.Object execWithTool(MutableMap toolCreationAndConnectionProperties, Function runMethodOnTool)

getTargetName

protected java.lang.String getTargetName()

logger

public ExecWithLoggingHelpers logger(Logger commandLogger)

preExecChecks

protected void preExecChecks()

brooklyn.util.task.system.internal [Java] Class ExecWithLoggingHelpers