public final class HttpCommandEffector extends AddEffector
Effector
to invoke REST endpoints.
It allows to specify the URI, the HTTP verb, credentials for authentication and HTTP headers.
It deals with some HttpHeaders.CONTENT_TYPE
namely 'application/json' (as default) and 'application/x-www-form-urlencoded'.
In the latter case, a map payload will be URLEncoded in a single string
With optional JSON_PATH config key, the effector will extract a section of the json response.
Using JSON_PATHS_AND_SENSORS, it is possible to extract one or more values from a json response, and publish them in sensorsModifier and Type | Field and Description |
---|---|
static java.lang.String |
APPLICATION_JSON |
static java.lang.String |
APPLICATION_X_WWW_FORM_URLENCODE |
static ConfigKey<java.util.Map<java.lang.String,java.lang.String>> |
EFFECTOR_HTTP_HEADERS |
static ConfigKey<java.lang.String> |
EFFECTOR_HTTP_PASSWORD |
static ConfigKey<java.lang.Object> |
EFFECTOR_HTTP_PAYLOAD |
static ConfigKey<java.lang.String> |
EFFECTOR_HTTP_USERNAME |
static ConfigKey<java.lang.String> |
EFFECTOR_HTTP_VERB |
static ConfigKey<java.lang.String> |
EFFECTOR_URI |
static ConfigKey<java.lang.String> |
JSON_PATH |
static ConfigKey<java.util.Map<java.lang.String,java.lang.String>> |
JSON_PATHS_AND_SENSORS |
static ConfigKey<java.lang.String> |
PUBLISH_SENSOR
Deprecated.
since 0.12.0
|
EFFECTOR_DESCRIPTION, EFFECTOR_NAME, EFFECTOR_PARAMETER_DEFS
Constructor and Description |
---|
HttpCommandEffector(ConfigBag params) |
Modifier and Type | Method and Description |
---|---|
static Effectors.EffectorBuilder<java.lang.String> |
newEffectorBuilder(ConfigBag params) |
apply, getMergedParams, newEffectorBuilder
public static final ConfigKey<java.lang.String> EFFECTOR_URI
public static final ConfigKey<java.lang.String> EFFECTOR_HTTP_VERB
public static final ConfigKey<java.lang.String> EFFECTOR_HTTP_USERNAME
public static final ConfigKey<java.lang.String> EFFECTOR_HTTP_PASSWORD
public static final ConfigKey<java.util.Map<java.lang.String,java.lang.String>> EFFECTOR_HTTP_HEADERS
public static final ConfigKey<java.lang.Object> EFFECTOR_HTTP_PAYLOAD
public static final ConfigKey<java.lang.String> JSON_PATH
public static final ConfigKey<java.util.Map<java.lang.String,java.lang.String>> JSON_PATHS_AND_SENSORS
@Deprecated public static final ConfigKey<java.lang.String> PUBLISH_SENSOR
public static final java.lang.String APPLICATION_JSON
public static final java.lang.String APPLICATION_X_WWW_FORM_URLENCODE
public HttpCommandEffector(ConfigBag params)
public static Effectors.EffectorBuilder<java.lang.String> newEffectorBuilder(ConfigBag params)