Properties Configuration Documents

There are several ways to test for the existence of connection string variables in properties files. For all condition types, the value of the key specified in the key attribute is tested against some value. The key is always a constant value (no variables are allowed):

• Test that a constant value exists as the value of a key.

  <KeyCondition key="dal.datamodel.name">
     <Values>
        <Value>ConstantValue1</Value>
        <Value>ConstantValue2</Value>
     </Values>
  </KeyCondition>
  

  The condition returns True only if the key’s value equals (case-insensitive) one of the constant's values.

• Test that a variable value exists as the value of a key.

  <KeyCondition key="dal.datamodel.name">
     <Values>
        <Value>${VARIABLE1}</Value>
        <Value>${VARIABLE2}</Value>
     </Values>
  </KeyCondition>
  

  The condition returns True only if the key’s value equals (case-insensitive) one of the variable’s values. If the variable value is a list of values, then all values are tested, and a match of the key with one of the values in the list is enough to return True.

  Note You can specify both variables and constant values in the same condition.

• Test that the value of a key comply with some regular expression.

  <KeyCondition key="dal.datamodel.name">
     <RegExp>
        ^SomeText${VARIABLE}MoreText$
     </RegExp>
  </KeyCondition>
  

  The regular expression can also contain one or more variables as part of the condition. During runtime, variables are replaced with their actual values when generating the concrete search expression.

  In case the variable contains a list of values, an expression similar to the following will be generated:

  ^SomeText(Value1 | Value2  | Value3)MoreText$

  In this case, either value may return True for the condition.

Example of conditions in a properties configuration document

<PropertiesConfigurationDocument name="MyConfig.properties"> 
   <Condition> 
      <Operator type="and"> 
         <KeyCondition key="TYPE"> 
            <Values>
               <Value>HTTP</Value>
               <Value>HTTPS</Value>
            </Values>
         </KeyCondition>
         <KeyCondition key="IPADDRESS"> 
            <Values>
               <Value>${IP_ADDRESS}</Value> 
               <Value>${HOSTNAME}</Value>
            </Values>
         </KeyCondition>
         <KeyCondition key="SITE"> 
            <RegExp>
               //${SITE_NAME}//.*
            </RegExo>
         </KeyCondition>
      </Operator>
   </Condition>
</PropertiesConfigurationDocument>

This means that the properties configuration document called MyConfig.properties must have all of the following:

• A key named TYPE contains one of the values HTTP or HTTPS.
• A key named IPADDRESS contains either the provider’s IP address (or one of its IP addresses), or its hostname.
• A key named SITE that starts with a “/”, continues with the provider’s SITE_NAME, another “/” and then any string.

There are two ways to extract a key’s value or part of a value into a variable:

• By injecting a key’s value.

  • In a dedicated <Variables> section, use the following syntax:

    <KeyVariable variable=”VARIABLE_NAME” key=”KEY_NAME” />

  • As part of a search condition, use the following syntax:

    <KeyCondition key=”KEY_NAME”>
       <Values>
          <Value>REQUIRED_VALUE</Value>
       </Values>
       <Variables>
          <KeyVariable variable=”VARIABLE_NAME” />
       </Variables>
    </KeyCondition>
    

    The key of the VARIABLE_NAME variable is defined in the <KeyCondition> element.

    This syntax is the same if you use <RegExp> instead of <Values>. In either case, the variable will be injected with the complete value of the key.

• By injecting part of a key’s value.

  • In a dedicated <Variables> section, use the following syntax:

    <KeyRegExpVariable variable=”VARIABLE_NAME” key=”KEY_NAME” expression=”REGULAR_EXPRESSION” group=”GROUP_NUMBER” />

    In this case, GROUP_NUMBER is the index (starting with 0) of the group in the regular expression defined by REGULAR_EXPRESSION. For example, in a properties document containing the line

    myKey = 123Value123

    and the statement

    <KeyRegExpVariable variable=”VAR” key=”myKey” expression=”[0-9]*([a-zA-Z]*)[0-9]*” group=”0” />

    injects the value “Value” into the variable “VAR”.

    You can use variables that were defined in the same file or in other files. For example:

    <KeyRegExpVariable variable=”VAR” key=”myKey” expression=”${PREV_VAR}([a-zA-Z]*)${PREV_VAR}” group=”0” />

    Assuming PREV_VAR contains the value “123”, VAR will get the value “Value”, in the same way as injecting a key's entire value. With either option, the variable will always contain a single value.

  • As part of a search condition, use the following syntax:

    <KeyCondition key=”KEY_NAME”>
       <RegExp>REGULAR_EXPRESSION</RegExp>
       <Variables>
          <KeyRegExpVariable variable=”VARIABLE_NAME” group=”GROUP_NUMBER” />
       </Variables>
    </KeyCondition>

    The key of the VARIABLE_NAME variable is defined in the <KeyCondition> element.

    This is only supported when using <RegExp>, and the regular expression that the variable’s “group” attribute refers to is the same as the one in <RegExp>.