z2-Environment

h1. Smart Props (#1697)

The goal of this concept is to provide facilities to simplify sharing of component configuration, making use of system and environment variables while still being able to query resolved component configuration efficiently and with minimal resource usage.

h2. Latest Design

In order to maximize compatibility and flexibility the following design has been chosen:

Component properties can be marked with a processing style. To do so, the property name is qualified with an appended, colon separated style descriptor. For example,

<pre>

someProp\:JEXL3="This is a JEXL3 string"

</pre>

marks the property "someProp" as being of style <em>JEXL3</em>. 

<b>Note #1:</b> Colons need to be escaped using a backslash to be part of the name.

Running into an expression like this, z2 will hand it off to an IComponentDescriptorProcessor for evaluation. In this particular case it would be the included JEXL3 processor.

<b>Note #2:</b> There is still a uniqueness requirement. The same property name ("someProp" in this case) may not be used with more than one style qualifier.

h3. Smart props and findComponents

Note that findComponents in IComponentsManager is based on the raw properties, before processing. This is so that component resolution is independent of the local 

environment and so that the risk of recursion traps while looking for processors is lowered.

h3. The plain style

There is a defaulting style "plain". That is, declaring a property 

<pre>x=...</pre>

is equivalent to 

<pre>

x\:plain=...

</pre>

h3. The JEXL3 style

A built-in processor is based on the "Apache Commons JEXL library":http://commons.apache.org/proper/commons-jexl.

JEXL offers a simple and versatile expression language. See "here":http://commons.apache.org/proper/commons-jexl/reference/syntax.html for a syntax reference. 

The JEXL3 style offers some implicit variables so that you can easily access system properties, environment variables, and other components. 

Example expressions:

Set path based on user's home folder:

<pre>

importPath\:JEXL3=system['user.home']+"/import"

</pre>

Copy a database configuration:

<pre>

ds.prop.user\:JEXL3=components.getComponent("environment/mainDB").getProperty("ds.prop.password")

ds.prop.password\:JEXL3=components.getComponent("environment/mainDB").getProperty("ds.prop.user")

ds.prop.url\:JEXL3=components.getComponent("environment/mainDB").getProperty("ds.prop.url")

</pre>

Copy a database configuration:

<pre>

ds.prop.user\:JEXL3=components.getComponent("environment/mainDB").getProperty("ds.prop.password")

ds.prop.password\:JEXL3=components.getComponent("environment/mainDB").getProperty("ds.prop.user")

ds.prop.url\:JEXL3=components.getComponent("environment/mainDB").getProperty("ds.prop.url")

</pre>

String with expressions:

<pre>

message\:JEXL3=`Sorry. We do not serve users called "${system['user.name']}" at ${env.JAVA_HOME}`

</pre>

Conditional expressions:

<pre>

osChoice\:JEXL3=system["os.name"].startsWith("Linux")? "We are running on a Linux OS" : "We are running on something else"

</pre>

h2. Previous work:

{{child_pages}}