2 Installing and Copying the WebLogic JMS .NET Client Libraries

This chapter describes the JMS .NET client components installed on a WebLogic Server platform, the location to which they are installed, and how to copy them to a .NET Framework machine.

This chapter includes the following sections:

Installing the WebLogic JMS .NET Client

The WebLogic JMS .NET Client is bundled with WebLogic Server 10g Release 3 and later. When you perform a Complete installation of WebLogic Server on a supported platform, including non-Windows platforms, the WebLogic JMS .NET Client is installed by default. If you choose the Custom installation option, ensure that the WebLogic Server Clients component of WebLogic Server is selected. If you deselect this component, the WebLogic JMS .NET Client is not installed.

For a list of supported platforms for WebLogic Server, see Oracle Fusion Middleware Supported System Configurations.

For details about installing WebLogic Server, see Installing and Configuring Oracle WebLogic Server and Coherence.

Location of Installed Components

The WebLogic JMS .NET client is included in a Oracle WebLogic Server installation in the following two directories, which contain the Version 1 and Version 2 of the libraries, respectively:
ORACLE_HOME/wlserver/modules/com.bea.weblogic.jms.dotnetclient
ORACLE_HOME/wlserver/modules/com.bea.weblogic.jms.dotnetclient_v2 

Here, ORACLE_HOME is the top-level installation directory that you selected during the installation process. For information about the difference between the Version 1 and Version 2 directory, see Choosing an Installation Version.

A DLL and a PDB file are included in each of the two directories:

  • WebLogic.Messaging.dll - The fully-managed JMS .NET client library used by the client for the JMS client application.

  • WebLogic.Messaging.pdb - The debug version of the JMS .NET client library that can be used by the client, together with the WebLogic.Messaging.dll, to debug the JMS .NET client application.

In addition, the Version 1 directory also contains a jms.dotnet.api.zip file. This file contains HTML and Windows help-style documentation for the WebLogic JMS .NET API that is applicable to both Version 1 and Version 2. See Microsoft .NET Messaging API for Oracle WebLogic Server.

Choosing an Installation Version

The following table illustrates the applications, .Net environments, and OS platforms that are supported for each .Net JMS Client version.

Library Version Libraries Location Applications .Net Versions OS Platforms

Version 1

ORACLE_HOME/wlserver/modules/com.bea.weblogic.jms.dotnetclient

.Net Framework

.Net Framework 2.0 to .Net Framework 3.5

.Net framework 4.8

Windows

Version 1*

ORACLE_HOME/wlserver/modules/com.bea.weblogic.jms.dotnetclient

.Net Core

.Net Core 3.1 and .Net 5.0

Windows and Linux

Version 2**

ORACLE_HOME/wlserver/modules/com.bea.weblogic.jms.dotnetclient_v2

.Net Core

.Net Core 3.1 and .Net 5.0

Windows and Linux

Note:

  • A WebLogic JMS .Net Client DLL's version number is embedded in the DLL as a file property and has a value format of 'N.N.N.N'. '1.N.N.N' corresponds with Version 1 and '2.N.N.N' corresponds with Version 2 in the above table. One way to obtain a DLL's file properties is to right-click on the file from within the Windows File Explorer.
  • (*) Although you can use the Version 1 libraries in a .Net Core application, Oracle recommends that .Net Core applications use the Version 2 libraries. But, if for any reason you need to use Version 1 for a .Net Core application, you should note the following:
    • The client side logging and debugging settings in app.config are not honored because the <system.diagnostics> part of the application config file is not supported in .Net Core. See Configuring Logging and Debugging.
    • You may encounter runtime errors about System.Configuration.ConfigurationManager. For example:
      WebLogic.Messaging.MessageException: Problem creating context
      System.IO.FileNotFoundException: Could not load file or assembly 'System.Configuration.ConfigurationManager, Version=4.0.3.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51'. The system cannot find the file specified.
      Such errors can be resolved by installing the System.Configuration.ConfigurationManager package in the project using Visual Studio Manage NuGet packages or by directly adding the package to the .csproj file, as shown in the following example:
      <ItemGroup>
      
                  <PackageReference Include="System.Configuration.ConfigurationManager" Version="6.0.0-preview.5.21301.5" />
      
             </ItemGroup>
  • (**) When using the Version 2 libraries, your applications may need to install additional packages such as:
    • System.Configuration.ConfigurationManager
    • Microsoft.Extensions.Configuration
    • Microsoft.Extensions.Configuration.Binder
    • Microsoft.Extensions.Configuration.Json

Copying the Library to the Client Machine

After installing WebLogic Server on a supported platform, you need to copy the WebLogic.Messaging.dll library from the installation directory specified in Location of Installed Components to your development directory on a supported .NET client machine, and you need to ensure that your .NET application references the library. The JMS .NET client is a fully-managed runtime library that is supported on Windows platforms running the Microsoft .NET Framework:

If you are using Visual Studio, you can add the WebLogic.Messaging.dll as a reference assembly in your project as follows:

  1. Select Project , then select References.

  2. Select Add Reference and specify the WebLogic.Messaging.dll from the directory into which you copied it on the .NET machine.

Optionally, you can also copy the debug version of the JMS .NET client library, WebLogic.Messaging.pdb, and the API documentation to your client machine, but it is not required.