Integration Server 10.15 | Integration Server Administrator's Guide | Configuring Integration Server for JMS Messaging | Working with JNDI Providers | Creating a JNDI Provider Alias
 
Creating a JNDI Provider Alias
A JNDI provider alias contains the information needed to look up an administered object. Most JMS connection aliases require a JNDI provider alias to create connections and look up destinations.
Keep the following information in mind when you create a JNDI provider alias:
*If the JMS provider requires the use of SSL for sending and receiving messages, you might be able to include SSL certificate information in the JNDI provider alias.
For more information about including SSL certificate information in the JNDI provider alias, see Including SSL Configuration Information in the JNDI Provider Alias. For information about configuring SSL communication with the JMS provider, see Using SSL with JMS.
*If you connect directly to webMethods Broker using the native webMethods API, you do not need to use a JNDI provider and, therefore, do not need to create a JNDI provider alias.
*If you choose to use webMethods Broker but do not want to connect natively (using the native webMethods API), you still need to use a JNDI provider. For more information about using the native webMethods API to connect to webMethods Broker, see Connecting to webMethods Broker with the Native webMethods API.
Use the following procedure to create an alias to a JNDI provider.
*To create a JNDI provider alias
1. Open Integration Server Administrator if it is not already open.
2. Go to Messaging > JNDI settings.
3. Click Create JNDI Provider Alias.
4. Specify the following information for the JNDI provider alias:
Field
Description
JNDI Alias Name
The alias name that you want to assign to this JNDI provider.
Description
A description for this JNDI alias.
Predefined JNDI Templates
The JNDI template that you want to use.
The JNDI templates provide information that you can use to complete alias configuration for a specific provider.
Note:
After you create a JNDI provider, Integration Server Administrator displays Current Settings as the value of the Predefined JNDI Templates field. This indicates that Integration Server uses the currently specified settings for the JNDI provider alias.
Initial Context Factory
The class name of the JNDI provider. The JNDI provider uses the initial context as the starting point for resolving names for naming and directory operations.
If you selected a predefined JNDI template, Integration Server displays the initial context factory for the provider.
Provider URL
The primary URL of the initial context for sessions with the JNDI provider. The URL specifies the JNDI directory in which the JNDI provider stores JMS administered objects.
If you selected a predefined JNDI template, replace the placeholder information in brackets << >> with information specific to your configuration.
If you are using Software AG Universal Messaging, this is the Universal Messaging realm server in the format nsp://UM_host:UM_port (for example, nsp://127.0.0.1:9000).
If you are using a cluster of Universal Messaging realm servers, supply a list of the URLs to each realm server in the cluster. Use a colon or semi-colon to separate each URL:
*Separate the URLs using a comma if Integration Server always attempts to connect to the first Universal Messaging server in the list, only trying the second Universal Messaging server in the list if the first server becomes unavailable
*Separate the URLs using a semicolon if Integration Server connects to a randomly chosen URL from the list. This may result in better distribution of clients across the servers in the cluster.
Note:
You must specify a URL for every Universal Messaging server in the cluster. Integration Server connects only to the Universal Messaging servers for which you specify a URL. Consequently, Integration Server creates resources such as destinations or durable subscribers on the specified Universal Messaging servers. If you specify only one Universal Messaging server in a cluster, the resources will be local to that server only.
Note:
If the JMS connection alias uses this JNDI provider alias to connect to Universal Messaging cluster and the JMS connection alias is configured to follow the master, Integration Server always connects to the master realm server in the cluster. By default, Integration Server is configured to follow the master realm server in a cluster. Software AG recommends using a comma-separated list of URLs if the JMS connection alias follows the master. For more information about the Enable Follow the Master option for a JMS connection alias, see Creating a JMS Connection Alias
Provider URL Failover List
A list of the failover URLs of the initial context for sessions with the JNDI provider. Specify one URL per line. If the connection to the primary JNDI provider becomes unavailable, Integration Server automatically attempts a connection to a JNDI provider specified in this list.
For more information about setting up a JNDI provider failover list, see Creating a JNDI Provider Failover List.
Security Principal
The principal name, or user name supplied by Integration Server to the JNDI provider, if the provider requires one for accessing the JNDI directory.
For information about whether or not the JNDI provider requires security principal information, consult the product documentation for the JNDI provider.
Security Credentials
The credentials, or password, that Integration Server provides to the JNDI provider, if the provider requires security credentials to access the JNDI directory.
For information about whether or not the JNDI provider requires security credentials, consult the product documentation for the JNDI provider.
Other Properties
Any additional properties the JNDI provider requires for configuration. For example, you might need to specify the classpath for any additional .jar or class files that the JNDI provider needs to connect to the JNDI.
When you select a predefined JNDI template, Integration Server populates this field with any additional properties and placeholder information required by the JNDI provider.
For more information about additional properties or classes required by a JNDI provider and the location of those files, see the product documentation for the JNDI provider.
5. For Use SSL, select one of the following:
*Select Yes if you want to use SSL to connect to the JNDI provider and specify SSL certificate information in the JNDI provider alias. When it creates the JNDI context, Integration Server passes the certificate information into the JNDI context.
For more information, see Including SSL Configuration Information in the JNDI Provider Alias.
Note:
This approach is only useful when the JNDI provider and JMS provider use the same set of certificates such as when using Universal Messaging as the JMS and JNDI providers.
*Select No if you do not want to include SSL configuration information in the JNDI provider alias. This is the default value.
If you select No and the JMS provider requires that communications be secured via SSL, you must configure Integration Server to provide certificate information a different way such as via the javax.net.ssl properties. For information about configuring SSL communication with the JMS provider, see Using SSL with JMS.
6. If you selected Yes for Use SSL, under SSL Settings, identify the truststore and/or keystore that contains the certificates used to establish a SSL connection to the JNDI and JMS providers.
Field
Description
Truststore Alias
The alias for the truststore that contains the certificates of the Certificate Authority (CA) for the JNDI and JMS providers.
You must select a truststore alias if you want to set up SSL communication.
Keystore Alias
The alias for the keystore that contains the client certificates for Integration Server to use when connecting to the JNDI and JMS providers.
You must select a keystore alias if you want to set up two-way SSL communication.
Key Alias
The alias to the key that contains the private key for connecting to the JNDI and JMS providers. The key alias must be in the keystore specified in Keystore Alias.
Note:
If the JMS provider requires that the SSL settings of the JMS client JVM must be used to establish the SSL connection, the certificates in the truststore and keystores specified under Secure Settings are ignored.
7. If you selected Yes for Use SSL, under JNDI Property Names (JNDI Provider Specific), specify the JNDI property names that the JNDI provider uses to establish a secure connection. JNDI property names vary per JNDI provider.
Field
Description
Truststore Property Name
The name of the JNDI property for storing the truststore location.
This property name is required if you selected a Truststore Alias in SSL Settings.
Truststore Password Property Name
The name of the JNDI property for storing the truststore password.
This property name is required if you selected a Truststore Alias in SSL Settings.
Keystore Property Name
The name of the JNDI property for storing the keystore location.
This property name is required if you selected a Keystore Alias in SSL Settings.
Keystore Password Property Name
The name of the JNDI property for storing the keystore password.
This property name is required if you selected a Keystore Alias in SSL Settings.
Keystore Format Property Name
The name of the JNDI property for storing the keystore format. This property name is optional.
Private Key Property Name
The name of the JNDI property for storing the private key name. This property name is optional.
8. Click Save Changes.