brooklyn-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [1/2] brooklyn-docs git commit: Adds doc for urlEncode DSL
Date Mon, 27 Feb 2017 09:40:15 GMT
Repository: brooklyn-docs
Updated Branches:
  refs/heads/master 9ce71a4a0 -> 9ffd04919

Adds doc for urlEncode DSL


Branch: refs/heads/master
Commit: 31382c8d420aee34fa56fc7b8edf034b5f4292bf
Parents: 9ce71a4
Author: Aled Sage <>
Authored: Wed Feb 8 17:14:51 2017 +0000
Committer: Aled Sage <>
Committed: Mon Feb 27 09:31:47 2017 +0000

 guide/yaml/ | 4 ++++
 1 file changed, 4 insertions(+)
diff --git a/guide/yaml/ b/guide/yaml/
index 8b8ca8f..6e7df7a 100644
--- a/guide/yaml/
+++ b/guide/yaml/
@@ -213,6 +213,10 @@ concise DSL defined here:
 * `$brooklyn:formatString("pattern e.g. %s %s", "field 1", "field 2")` returns a future which
creates the formatted string
   with the given parameters, where parameters may be strings *or* other tasks such as `attributeWhenReady`
+* `$brooklyn:urlEncode("val")` returns a future which creates a string with the characters
+  so it is a valid part of a URL. The parameter can be a string *or* another task. For example,
+  `$brooklyn:urlEncode($brooklyn:config(\"mykey\"))`. It uses "www-form-urlencoded" for the
+  which is appropriate for query parameters but not for some other parts of the URL (e.g.
space is encoded as '+').
 * `$brooklyn:literal("string")` returns the given string as a literal (suppressing any `$brooklyn:`
 * `$brooklyn:object(Map)` creates an object, using keys `type` to define the java type,
   and either `object.fields` or `brooklyn.config` to supply bean/constructor/flags to create
an instance

View raw message