org.apache.brooklyn.core.sensor.ssh

Class SshCommandSensor<T>

java.lang.Object

org.apache.brooklyn.core.effector.AddSensor<T>

org.apache.brooklyn.core.sensor.AbstractAddSensorFeed<T>

org.apache.brooklyn.core.sensor.ssh.SshCommandSensor<T>

All Implemented Interfaces:

EntityInitializer

public final class SshCommandSensor<T>
extends AbstractAddSensorFeed<T>

Configurable EntityInitializer which adds an SSH sensor feed running the command supplied in order to populate the sensor with the indicated name. Note that the targetType is ignored, and always set to String.

See Also:

HttpRequestSensor

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigKey<java.lang.String>	SENSOR_COMMAND
static ConfigKey<java.lang.String>	SENSOR_EXECUTION_DIR
static MapConfigKey<java.lang.Object>	SENSOR_SHELL_ENVIRONMENT
static ConfigKey<java.lang.Object>	VALUE_ON_ERROR

Fields inherited from class org.apache.brooklyn.core.sensor.AbstractAddSensorFeed

LOG_WARNING_GRACE_TIME, LOG_WARNING_GRACE_TIME_ON_STARTUP, SUPPRESS_DUPLICATES

Fields inherited from class org.apache.brooklyn.core.effector.AddSensor

SENSOR_NAME, SENSOR_PERIOD, SENSOR_TYPE

Constructor Summary

Constructors

Constructor and Description
SshCommandSensor(ConfigBag params)

Method Summary

Modifier and Type	Method and Description
void	apply(EntityLocal entity) Applies initialization logic to a just-built entity.
static java.lang.String	makeCommandExecutingInDirectory(java.lang.String command, java.lang.String executionDir, Entity entity)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SENSOR_COMMAND

public static final ConfigKey<java.lang.String> SENSOR_COMMAND

SENSOR_EXECUTION_DIR

public static final ConfigKey<java.lang.String> SENSOR_EXECUTION_DIR

VALUE_ON_ERROR

public static final ConfigKey<java.lang.Object> VALUE_ON_ERROR

SENSOR_SHELL_ENVIRONMENT

public static final MapConfigKey<java.lang.Object> SENSOR_SHELL_ENVIRONMENT

Constructor Detail

SshCommandSensor

public SshCommandSensor(ConfigBag params)

Method Detail

apply

public void apply(EntityLocal entity)

Description copied from interface: EntityInitializer

Applies initialization logic to a just-built entity. Invoked immediately after the "init" call on the AbstractEntity constructed.

Specified by:

apply in interface EntityInitializer

Overrides:

apply in class AddSensor<T>

Parameters:

entity - guaranteed to be the actual implementation instance, thus guaranteed to be castable to EntityInternal which is often desired, or to the type at hand (it is not even a proxy)

makeCommandExecutingInDirectory

public static java.lang.String makeCommandExecutingInDirectory(java.lang.String command,
                                                               java.lang.String executionDir,
                                                               Entity entity)