Using Application Variables

Application variables allow you to define a list of variable names and values along with their type. The application variable name can then be used as a token in a WSDL extensibility element attribute for the eMail Binding Component. For example, you could define a string variable named ServerName with a value of MyHost.com. To reference this in the WSDL document, you would enter ${ServerName}. When you deploy an application that uses application variables, any variable that is referenced in the application's WSDL document is loaded automatically.

You can define the following four variable types:

• String – A string value, such as a path or directory.

• Number – A numeric value.

• Boolean – A Boolean true or false. When you define a Boolean variable, a check box appears in the value field. Select the check box if the variable value should be true; otherwise, deselect the check box.

• Password – A login password. The password is masked and appears as asterisks.

Variables allow greater flexibility in WSDL documents. For example, you can use the same WSDL document for multiple runtime environments by using application variables to specify system-specific information. The variable values can be changed from the binding component runtime properties for each specific environment.

To Create an Application Variable

1. On the NetBeans IDE Services window, expand Servers > GlassFish v2.x > JBI > Binding Components.
2. Right-click sun-email-binding, and then select Properties.

   The Properties window appears.

3. Click the ellipsis next to Application Variables.

   The Application Variables Editor appears.

4. Click Add.

   A list of possible variable types appears.

5. Select String, Number, Boolean, or Password, and then click OK.

   A new row appears in the application list.

6. In the new row, enter a variable name and then do one of the following:
   • For a Boolean variable, select the check box if the variable value should be true; otherwise leave it deselected.
   • For all other variables types, enter the variable value.

     ---

     Note - If you created a password variable, the value you enter appears as asterisks.

     ---

     
     
7. On the Application Variable Editor, click OK; on the Properties window, click Close.
8. Reference the variable from the appropriate extensibility element in the WSDL document, using a dollar sign and curly brackets to indicate the variable; for example, ${MyVariable}.

   You can see an example of this in the userName and password fields in the following image.

   
   

   Here is an example of how the username and password variables in the above images appear in the WSDL source:

   <service name="wsdlEmailService">
      <port name="wsdlEmailPort" binding="tns:wsdlEmailBinding">
         <email:IMAPaddress
            emailServer="email.mycompany.com"
            useSSL="true"
            port="994"
            userName="${username}"
            password="${password}"
            mailFolder="Inbox"
            maxMessageCount="50"
            messageAckMode="automatic"
            messageAckOperation="markAsUnread"
            pollingInterval="1000"/>
       </port>
   </service>

To Change an Application Variable Value When the Application is Running

1. On the NetBeans IDE Services window, expand Servers > GlassFish v2.x > JBI > Binding Components.
2. Right-click sun-email-binding, and then select Properties.

   The Properties window appears.

3. Click the ellipsis next to Application Variables.

   The Application Variables Editor appears.

4. In the variable list, select the value you want to change and then enter the new value.
5. On the Application Variable Editor, click OK; on the Properties window, click Close.
6. On the Services window, expand Servers > GlassFish v2.x > Service Assemblies.
7. Right-click the Service Assembly using the application variables, and click Stop.
8. Right-click the Service Assembly again, and click Start.

   The new settings take effect.

To Use an Application Variable for Password Protection

To protect passwords that would otherwise appear as clear text in your WSDL document, you can define a Password application variable to use in the WSDL file as a token. In the following example, a password application variable is created that uses the name SECRET and the password PROTECT.

1. On the NetBeans IDE Services window, expand Servers > GlassFish v2.x > JBI > Binding Components.
2. Right-click sun-email-binding, and then select Properties.

   The Properties window appears.

3. Click the ellipsis next to Application Variables.

   The Application Variables Editor appears.

4. Click Add, select Password, and then click OK.

   A new row appears in the variable list.

5. Enter SECRET as the name, and enter PROTECT as the value.

   Because this is a password type, the characters appear as asterisks.

6. Use the application variable name ${SECRET} as the WSDL password attribute, using the dollar sign and curly braces.