Java config docs: default-value should be immutable (cherry picked from commit 683a3ee1a792e9e80eb8359328cb388056cd85a0)
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/2735b5b9 Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/2735b5b9 Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/2735b5b9 Branch: refs/heads/0.11.x Commit: 2735b5b99865e4c38fee9477ca8c27ba6ebcdce4 Parents: 420433f Author: Aled Sage <[email protected]> Authored: Wed Apr 19 13:40:37 2017 +0100 Committer: Richard Downer <[email protected]> Committed: Wed May 31 15:26:04 2017 +0100 ---------------------------------------------------------------------- guide/blueprints/java/common-usage.md | 4 ++++ 1 file changed, 4 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/2735b5b9/guide/blueprints/java/common-usage.md ---------------------------------------------------------------------- diff --git a/guide/blueprints/java/common-usage.md b/guide/blueprints/java/common-usage.md index ccafd9b..2c9d91b 100644 --- a/guide/blueprints/java/common-usage.md +++ b/guide/blueprints/java/common-usage.md @@ -39,6 +39,10 @@ public static final ConfigKey<String> ROOT_WAR = new ConfigKeys.newStringConfigK "WAR file to deploy as the ROOT, as URL (supporting file: and classpath: prefixes)"); {% endhighlight %} +If supplying a default value, it is important that this be immutable. Otherwise, it risks users +of the blueprint modifying the default value, which would affect blueprints that are subsequently +deployed. + One can optionally define a `@SetFromFlag("war")`. This defines a short-hand for configuring the entity. However, it should be used with caution - when using configuration set on a parent entity (and thus inherited), the `@SetFromFlag` short-form names are not checked. The long form defined
