org.apache.brooklyn.feed

Class CommandPollConfig<T>

java.lang.Object

org.apache.brooklyn.core.feed.FeedConfig<V,T,F>

org.apache.brooklyn.core.feed.PollConfig<SshPollValue,T,CommandPollConfig<T>>

org.apache.brooklyn.feed.CommandPollConfig<T>

Direct Known Subclasses:

SshPollConfig

public class CommandPollConfig<T>
extends PollConfig<SshPollValue,T,CommandPollConfig<T>>

Field Summary

Fields

Modifier and Type	Field and Description
static <any>	DEFAULT_SUCCESS

Fields inherited from class org.apache.brooklyn.core.feed.FeedConfig

NO_SENSOR, REMOVE, UNCHANGED

Constructor Summary

Constructors

Constructor and Description
CommandPollConfig(AttributeSensor<T> sensor)
CommandPollConfig(CommandPollConfig<T> other)

Method Summary

Modifier and Type	Method and Description
CommandPollConfig<T>	command(<any> val)
CommandPollConfig<T>	command(java.lang.String val)
CommandPollConfig<T>	env(<any> val) adds the given dynamic supplier of environment variables.
CommandPollConfig<T>	env(java.util.Map<java.lang.String,java.lang.String> val) add the given env params; sequence is as per #env(Supplier).
CommandPollConfig<T>	env(java.lang.String key, java.lang.String val) add the given env param; sequence is as per #env(Supplier)
static CommandPollConfig<java.lang.Void>	forMultiple()
static <T> CommandPollConfig<T>	forSensor(AttributeSensor<T> sensor)
<any>	getCommandSupplier()
<any>	getEnvSupplier()

Methods inherited from class org.apache.brooklyn.core.feed.PollConfig

description, getDescription, getPeriod, period, period, period

Methods inherited from class org.apache.brooklyn.core.feed.FeedConfig

checkSuccess, checkSuccess, enabled, equals, getCheckSuccess, getLogWarningGraceTime, getLogWarningGraceTimeOnStartup, getOnException, getOnFailure, getOnSuccess, getSensor, getSupressDuplicates, hasCheckSuccessHandler, hasExceptionHandler, hasFailureHandler, hashCode, hasSuccessHandler, isEnabled, logWarningGraceTime, logWarningGraceTimeOnStartup, onException, onFailure, onFailureOrException, onResult, onSuccess, setOnException, setOnFailure, setOnFailureOrException, setOnResult, setOnSuccess, suppressDuplicates, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SUCCESS

public static final <any> DEFAULT_SUCCESS

Constructor Detail

CommandPollConfig

public CommandPollConfig(AttributeSensor<T> sensor)

CommandPollConfig

public CommandPollConfig(CommandPollConfig<T> other)

Method Detail

forSensor

public static <T> CommandPollConfig<T> forSensor(AttributeSensor<T> sensor)

forMultiple

public static CommandPollConfig<java.lang.Void> forMultiple()

getCommandSupplier

public <any> getCommandSupplier()

getEnvSupplier

public <any> getEnvSupplier()

command

public CommandPollConfig<T> command(java.lang.String val)

command

public CommandPollConfig<T> command(<any> val)

env

public CommandPollConfig<T> env(java.lang.String key,
                                java.lang.String val)

add the given env param; sequence is as per #env(Supplier)

env

public CommandPollConfig<T> env(java.util.Map<java.lang.String,java.lang.String> val)

add the given env params; sequence is as per #env(Supplier). behaviour is undefined if the map supplied here is subsequently changed.

if a map's contents might change, use #env(Supplier)

env

public CommandPollConfig<T> env(<any> val)

adds the given dynamic supplier of environment variables.

use of a supplier allows env vars to be computed on each execution, for example to take the most recent sensor values.

in the case of multiple map suppliers, static maps, or static env(String, String) key value pairs, the order in which they are specified here is the order in which they are computed and applied.