HermesJMSHermesJMS is an extensible console that helps you interact with JMS providers making it simple to publish and edit messages, browse or search queues and topics, copy messages around and delete them.
This guide assumes that:
- You have successfully installed HermesJMS on your machine (do not use WebStart HermesJMS)
- You have access to Solace JMS libraries (version 6.2 or above)
- You have access to a Solace Messaging Router
- The necessary configuration on the Solace Message Broker is done. Configuration includes the creation of elements such as the message-VPN and the JMS Connection Factory.
- If SSL connectivity is desired, you will need to ensure that the Solace Message Broker is correctly configured with SSL certificate(s), and that you have obtained a copy of the trust store, and keystore (if necessary) from your administrator.
Get Solace Messaging
This tutorial requires access to Solace PubSub+ message broker and requires that you know several connectivity properties about your message broker. Specifically you need to know the following:
|Host||String||This is the address clients use when connecting to the message broker to send and receive messages. (Format:
|Message VPN||String||The message broker Message VPN that this client should connect to.|
|Client Username||String||The client username. (See Notes below)|
|Client Password||String||The client password. (See Notes below)|
There are several ways you can get access to Solace messaging and find these required properties.
Option 1: Use Solace Cloud
- Follow these instructions to quickly spin up a cloud-based Solace messaging service for your applications.
- The messaging connectivity information is found in the service details in the connectivity tab (shown below). You will need:
- Host:Port (use the JMS URI)
- Message VPN
- Client Username
- Client Password
Option 2: Start a Solace PubSub+ Software Message Broker
- Follow these instructions to start the software message broker in leading Clouds, Container Platforms or Hypervisors. The tutorials outline where to download and how to install the Solace software message broker.
- The messaging connectivity information are the following:
- Host: <public_ip> (IP address assigned to the software message broker in tutorial instructions)
- Message VPN: default
- Client Username: sampleUser (can be any value)
- Client Password: samplePassword (can be any value)
Note: By default, the Solace software message broker “default” message VPN has authentication disabled.
Option 3: Get access to a Solace PubSub+ appliance
- Contact your Solace PubSub+ appliance administrators and obtain the following:
- A Solace Message-VPN where you can produce and consume direct and persistent messages
- The host name or IP address of the appliance hosting your Message-VPN
- A username and password to access the appliance
Modify HermesJMS startup
Windows or Linux
- In the HermesJMS distribution you will find a bin directory with the startup files, hermes.bat and hermes.sh. Edit the file you use to start HermesJMS and add the system property definition
-DSolace_JMS_Browser_Timeout_In_MS=1000to the Java command.
Step 1. Open the Applications directory in Finder. Right-click on the HermesJMS icon and select “Show Package Contents”.
Step 2. Go into the Contents subdirectory.
Step 3. Double-click to edit the Info.plist file with the (optionally installed) Apple Xcode editor. Add the string
-DSolace_JMS_Browser_Timeout_In_MS=1000 to the Java->VMOptions with a space between the existing options and the new String. Save the change.
Start HermesJMS and create a new Hermes JMS session
Step 1. Right-click on jms/sessions tree node in the “Sessions” area and select New…/New session… Call it “SolaceSession”. Make sure to uncheck
Use Consumer and Transacted.
Step 2. You will be presented with a Preferences dialog which contains 4 tabs. Select the Providers tab.
Step 3. Add a new Classpath group, by right clicking on “Classpath Groups” and selecting Add Group from the popup menu. Type “SolaceJMS” in the Classpath group name text field and hit OK.
Step 4. Now, add all of the jars in the lib directory of the Solace JMS distribution package, and hit “OK”. A confirmation dialog will be presented (see below). Hit “Don’t scan” to proceed.
Step 5. Hit “Apply” to save the configuration.
Step 6. Switch to the Sessions tab to start configuring the ConnectionFactory.
Step 7. Select the following settings in the drop-down menu for the Connection Factory.
- For Class, select hermes.JNDIConnectionFactory
- For Loader, select SolaceJMS which was previously configured. Sometimes the drop-down menu has not been updated with the SolaceJMS option. If this happens, close the dialog with “OK” and reopen by right clicking the “SolaceJMS” and selecting “edit”.
Step 8. Add the following properties for the Connection Factory:
|binding||JNDI name of the connection factory you want to use|
Step 9. Hit “OK” to finish creating the new Hermes JMS session.
Create a new Hermes Queue
a) Right-click on jms/sessions/SolaceSession tree node in the “Sessions” area and select New…/Add queue…
b) Input the following properties:
|Name||JNDI name of the queue that you wish to connect to|
|ShortName||Any desired display name. For simplicity, this example will keep it as the same as the JNDI name.|
c) Hit “OK” to finish creating the new Hermes JMS queue.
Test the setup
a) To browse the message in the queue added in the previous setup, simply double click on it in the tree on the left hand side. If the queue contains messages they will be displayed in a queue tab as shown below
Configure Hermes JMS session to connect securely over SSL
a) Using your preferred text editor, create a new file to pass additional user properties to HermesJMS. For this example, the name of the properties file will be “solace.jms.properties”.
b) Insert the following two lines of text into your file. Note that the text should be modified to point to the location of your trust store, and must also contain the password of your trust store.
c) Edit the Hermes JMS session in Start HemesJMS to have the session connect securely over SSL. Right-click on jms/sessions/SolaceSession tree node in the “Sessions” area and select Edit…
d) Edit the providerURL property to connect to
smfs://<message broker IP>:[<SSL port>].
e) Add “userPropertiesFile” property to the connection factory. This value of this property must be the full file name of the solace.jms.properties file that was created earlier in step (a).
Configure Hermes JMS session to connect using client certificate authentication
a) “Configure Hermes JMS session to connect securely over SSL” must be done prior to enabling client certificate authentication.
b) Edit the solace.jms.properties custom user property file to specify additional properties, modifying them to point to your actual files, and passwords as necessary.
Solace_JMS_SSL_TrustStore=C:\\JMS\\HermesJMS\\truststore.jks Solace_JMS_SSL_TrustStorePassword=myTrustStorePassword Solace_JMS_Authentication_Scheme=AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE Solace_JMS_SSL_KeyStore=C:\\JMS\\HermesJMS\\keystore.jks Solace_JMS_SSL_KeyStorePassword=myKeyStorePassword Solace_JMS_SSL_PrivateKeyAlias=myPrivateKeyAlias Solace_JMS_SSL_PrivateKeyPassword=myPrivateKeyPassword
Here is a brief summary of the properties used, but you should refer to the Solace JMS API guide for full details.
|Solace_JMS_SSL_TrustStore||The trust store to use.|
|Solace_JMS_SSL_TrustStorePassword||The trust store password for the trust store provided for the SSL Trust Store property.|
|Solace_JMS_Authentication_Scheme||This property specifies the authentication scheme to be used.|
|Solace_JMS_SSL_KeyStore||This property specifies the keystore to use in the URL or path format. The keystore holds the client’s private key and certificate required to authenticate a client during the TLS/SSL handshake.|
|Solace_JMS_SSL_KeyStorePassword||This property specifies keystore password to use. This password allows JMS to verify the integrity of the keystore.|
|Solace_JMS_SSL_PrivateKeyAlias||This property specifies which private key in the keystore to use for authentication. This property is necessary when a keystore with multiple private key entries is used.|
|Solace_JMS_SSL_PrivateKeyPassword||This property specifies the password for the private key in the keystore.|