Installing, Upgrading, and Uninstalling

Overview

This chapter explains how to install, upgrade, and uninstall IBM webMethods Adapter for EJB 6.5 SP3. The instructions use the IBM webMethods Installer and the IBM webMethods Uninstaller wizards. For complete information about the wizards or other installation methods, or to install other webMethods products, see the Installing IBM webMethods Products On Premises for your release.

Requirements

For a list of the operating systems, third-party products, and webMethods products supported by the adapter, see the IBM webMethods Adapters System Requirements.

Adapter for EJB 6.5 SP3 has no hardware requirements beyond those of the host Integration Server.

The Integration Server Home Directory

Beginning with Integration Server 9.6, you can create and run multiple Integration Server instances under a single installation directory. Each Integration Server instance has a home directory under Integration Server_directory\instances\instance_name that contains the packages, configuration files, log files, and updates for the instance.

For more information about running multiple Integration Server instances, see the IBM webMethods Integration Server Administrator’s Guide for your release.

If you are using Integration Server 9.5 and lower, the Integration Server home directory is Integration Server_directory. For example, on Integration Server 9.5 the adapter package is installed in the Integration Server_directory\packages directory.

This guide uses the packages_directory as the home directory in Integration Server classpaths. For Integration Server 9.6 and above, the packages_directory is Integration Server_directory\instances\instance_name\packages directory. For Integration Server 9.5 and lower, the packages_directory is Integration Server_directory\packages directory.

Installing the Adapter

About this task

If you are installing the adapter in a clustered environment, you must install it on each Integration Server in the cluster, and each installation must be identical. For more information about working with the adapter in a clustered environment, see Using Adapter for EJB in a Clustered Environment.

To install Adapter for EJB 6.5 SP3

Procedure

  1. Download IBM webMethods Installer .
  2. If you are installing the adapter on an existing Integration Server, shut down the Integration Server.
  3. Start the Installer wizard.
  4. Choose the webMethods release that includes the Integration Server on which to install the adapter.
  5. Specify the installation directory as follows:
    • If you are installing on an existing Integration Server, specify the webMethods installation directory that contains the host Integration Server.
    • If you are installing both the host Integration Server and the adapter, specify the installation directory to use.
  6. In the product selection list, select Adapters > webMethods Adapter for Enterprise JavaBeans 6.5 SP3.

    If you are using Integration Server 9.6 and above, you can choose to install the package in the default instance. In this case, IBM webMethods Installer installs the adapter in both locations, Integration Server_directory\packages and the default instance packages directory located in Integration Server_directory\instances\default\packages.

  7. After installation is complete, close the Installer.
  8. Go to Configure Integration Server to Work with the Application Server and perform those steps.
  9. Start Integration Server.

Installing a Sample EJB Application

About this task

You can also download sample EJB source code . The code demonstrates the procedure for invoking services running on Integration Server from within an EJB. For more information about the sample EJB application, see Sample EJB Application.

Configure Integration Server to Work with the Application Server

After you finish with Installer, you need to perform several manual steps to set up IBM webMethods Integration Server to work with your application server. This section describes some instances of class loading conflicts you should be aware of, and includes the configuration steps necessary for each application server and Integration Server combination.

Class Loading Conflicts

When possible, Adapter for EJB takes full advantage of Integration Server's per-package class loading scheme. This feature enables you to install application server vendor jar files and deployed EJB jar files under WmEJBAdapter\code\jars. Installing the files to this location limits the visibility of the classes and resources in those jars to Adapter for EJB and its dependents, thus reducing the potential for class loading collisions with other packages installed on Integration Server.

For some application servers, installing the files under WmEJBAdapter\code\jars may not be possible due to their own internal class loading requirements. In these cases, the third-party jars files must be installed on either the system classpath or the server's classpath.

If you put jar files in the lib\system directory on the Integration Server on which Adapter for EJB is installed, that Integration Server cannot be managed by Optimize Infrastructure Data Collector due to class loading conflicts. For more information about Infrastructure Data Collector support in the adapter, see Optimize Infrastructure Data Collector Support for the Adapter.

Configuring WebLogic Application Servers

Before configuring the application server, you may want to see Adapter for EJB Support for Multiple Application Servers.

Note: You must copy all the jar files from the application server directory to the Integration Server directory as mentioned in the configuration steps of each version of the application server. In the absence of these jar files, the Adapter for EJB link is not displayed on the Integration Server Administrator screen. Also, Adapter for EJB may not start properly, may throw a class not found error, or may not enable some features without throwing an explicit error.
Important: Do not delete the WmEJBConfigUtil.jar from the Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars\static directory. If you delete this jar file, Adapter for EJB will not start.

WebLogic Server 10.3

About this task

To set up Integration Server with WebLogic Server 10.3

Procedure
  1. Copy the following jar files from the WebLogic_directory\modules directory to the Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars\static directory on Integration Server:
    • com.bea.core.management.core_2.3.0.0.jar
    • com.bea.core.repackaged.asm_3.0.jar
    • com.bea.core.store_1.4.0.0.jar
    • com.bea.core.timers_1.4.0.0.jar
    • com.bea.core.transaction_2.5.0.0.jar
    • com.bea.core.utils.classloaders_1.4.0.0.jar
    • com.bea.core.utils.full_1.4.0.0.jar
    • com.bea.core.utils.wrapper_1.3.0.0.jar
    • com.bea.core.weblogic.lifecycle_1.1.0.0.jar
    • com.bea.core.weblogic.rmi.client_1.4.0.0.jar
    • com.bea.core.weblogic.security.digest_1.0.0.0.jar
    • com.bea.core.weblogic.security.identity_1.1.0.0.jar
    • com.bea.core.weblogic.security.wls_1.0.0.0_5-0-2-0.jar
    • com.bea.core.weblogic.security_1.0.0.0_5-0-2-0.jar
    • com.bea.core.weblogic.socket.api_1.0.0.0.jar
    • com.bea.core.weblogic.workmanager_1.4.0.0.jar
    • javax.jdo_2.0.1.jar
    • javax.persistence_1.0.0.0_1-0.jar
    • org.apache.openjpa_2.2.0.0_1-1-0.jar
    • com.bea.core.descriptor_1.4.0.0.jar
    • com.bea.core.kodo_1.0.0.0_4-2-0.jar
    • com.bea.core.logging_1.4.0.0.jar
  2. Copy the following jar files from the WebLogic_directory\server\lib directory to the Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars\static directory on Integration Server:
    • weblogic.jar
    • wlclient.jar
    • wls-api.jar

WebLogic Server 12c

About this task

To set up Integration Server with WebLogic Server 12c

Procedure
  1. In a command prompt window, navigate to the directory location, WebLogic_directory\server\lib.
  2. Create a wlfullclient.jar file by typing the command, java -jar wljarbuilder.jar.
  3. Copy the wlfullclient.jar file from the WebLogic_directory\server\lib directory to the Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars\static directory on Integration Server.

Configuring WebSphere Application Servers

Use the set of instructions that correspond to the version of Integration Server and WebSphere Application Server you are using.

Before configuring the application server, you may want to see Adapter for EJB Support for Multiple Application Servers.

Note: You must copy all the jar files from the application server directory to the Integration Server directory as mentioned in the configuration steps of each version of the application server. In the absence of these jar files, the Adapter for EJB link is not displayed on the IS Administrator screen. Also, Adapter for EJB may not start properly, may throw a class not found error, or may not enable some features without throwing an explicit error.
Important: Do not delete the WmEJBConfigUtil.jar from the Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars\static directory. If you delete this jar file, Adapter for EJB will not start.

WebSphere Application Server

About this task

The procedure for setting up Integration Server with WebSphere Server is based on the JVM you are using.

WebSphere Application Server 7.0 with Oracle JVM 1.6
About this task

To set up Integration Server with WebSphere Server 7.0 when using Oracle JVM 1.6

Procedure
  1. Copy the orb.properties file from the WebSphere_directory\jre\lib directory into the Integration Server_directory\jvm\win160\jre\lib directory.
  2. Copy the following jar files from the WebSphere_directory\plugins directory into the Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars\static directory:
    • com.ibm.ws.jdt.core.jar
    • com.ibm.ws.runtime.jar
    • org.eclipse.jdt.core.jar
    • org.eclipse.osgi_.jar
    • com.ibm.ws.ejbportable.jar
    • com.ibm.ws.emf.jar
  3. Copy the following jar files from the WebSphere_directory\java\jre\lib directory into the Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars\static directory:
    • ibmcfw.jar
    • ibmorb.jar
    • ibmorbapi.jar
    • iwsorbutil.jar
  4. Copy the following jar files from the WebSphere_directory\runtimes directory into the Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars\static directory:
    • com.ibm.ws.admin.client_7.0.0.jar
    • com.ibm.ws.ejb.thinclient_7.0.0.jar
WebSphere Application Server 8.5 with Oracle JVM 1.7
About this task

To set up Integration Server with WebSphere Server 8.5 when using Oracle JVM 1.7

Procedure
  1. Copy the orb.properties file from the WebSphere_directory\jre\lib directory into the Integration Server_directory\jvm\win170\jre\lib directory.
  2. Copy the following jar files from the WebSphere_directory\plugins directory into the Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars\static directory:
    • com.ibm.ws.jdt.core.jar
    • com.ibm.ws.runtime.jar
    • org.eclipse.jdt.core.jar
    • org.eclipse.osgi_.jar
    • com.ibm.ws.emf.jar
  3. Copy the following jar files from the WebSphere_directory\java\jre\lib directory into the Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars\static directory:
    • ibmcfw.jar
    • ibmorb.jar
    • ibmorbapi.jar
    • iwsorbutil.jar
  4. Copy the following jar files from the WebSphere_directory\runtimes directory into the Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars\static directory:
    • com.ibm.ws.admin.client_8.5.0.jar
    • com.ibm.ws.ejb.thinclient_8.5.0.jar
WebSphere Application Server 7.0 with IBM JVM 1.6
About this task

To set up Integration Server with WebSphere Server 7.0 when using IBM JVM 1.6

Procedure
  1. Install IBM JVM 1.6 at \installation_directory\jvm directory.
  2. Copy the following jar files from the WebSphere_directory\plugins directory into the Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars\static directory:
    • com.ibm.ws.jdt.core.jar
    • com.ibm.ws.runtime.jar
    • org.eclipse.jdt.core.jar
    • org.eclipse.osgi_.jar
    • com.ibm.ws.ejbportable.jar
    • com.ibm.ws.emf.jar
  3. Copy the following jar files from the WebSphere_directory\runtimes directory into the Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars\static directory:
    • com.ibm.ws.admin.client_7.0.0.jar
    • com.ibm.ws.ejb.thinclient_7.0.0.jar
  4. Copy the EJB deployment jar files for any EJBs that will be used in the adapter to the Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars directory on Integration Server.
  5. To set the JAVA_DIR property to the installed JVM 1.6, open the Integration Server_directory\server.bat file and set the following property to:

    SET JAVA_DIR=installation_directory\jvm\IBM JDK 1.6\jre

Configuring JBoss Application Servers

Before configuring the application server, see Adapter for EJB Support for Multiple Application Servers.

Important: .
  • j2ee.jar must be specified before implfactory.properties in the classpath.
  • Do not delete the WmEJBConfigUtil.jar from the Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars\static directory. If you delete this JAR file, Adapter for EJB will not start.
  • If you are switching to a newer version of JBoss Server, delete all the JARs from the previous versions which otherwise could cause conflict from Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars\static directory
Note: You must copy all the JAR files from the application server directory to the Integration Server directory as mentioned in the configuration steps of each version of the application server. In the absence of these jar files, the Adapter for EJB link is not displayed on the Integration Server Administrator screen. Also, Adapter for EJB may not start properly, may throw a class not found error, or may not enable some features without throwing an explicit error.

JBoss Application Server 5.1.0

About this task

To set up Integration Server with JBoss Server 5.1.0

Procedure
  1. Copy the following jar files from the JBoss Server directory (typically JBoss_directory\client) to the Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars\static directory on Integration Server:
    • jboss-ejb3-common-client.jar
    • jboss-ejb3-core-client.jar
    • jboss-ejb3-ext-api.jar
    • jboss-ejb3-proxy-clustered-client.jar
    • jboss-ejb3-proxy-impl-client.jar
    • jboss-ejb3-proxy-spi-client.jar
    • jboss-ejb3-security-client.jar
    • jboss-integration.jar
    • jboss-javaee.jar
    • jboss-managed.jar
    • jboss-mdr.jar
    • jboss-messaging.jar
    • jboss-remoting.jar
    • jboss-remoting-aspects.jar
    • jboss-security-aspects.jar
    • jboss-security-spi.jar
    • jboss-serialization.jar
    • jbosssx.jar
    • jboss-system-jmx-client.jar
    • jmx-adaptor-plugin.jar
    • jmx-invoker-adaptor-client.jar
    • jnp-client.jar
    • trove.jar
    • applet.jar
    • concurrent.jar
    • ejb3-persistence.jar
    • javassist.jar
    • jboss-aop.jar
    • jboss-aspect-jdk50-client.jar
    • jboss-client.jar
    • jboss-common-core.jar
  2. Copy the EJB deployment jar files for any EJBs that will be used in the adapter to the Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars directory on Integration Server.

Adapter for EJB Support for Multiple Application Servers

The details about Adapter for EJB support for multiple application servers are as follows:

  • Adapter for EJB supports multiple instances of the same version of the application server.
    Note: For multiple instances of the same version of WebLogic application server, you must use JAAS authentication. For more information about using JAAS authentication for WebLogic servers, see JAAS Authentication.
  • Adapter for EJB supports two different versions of the same application server provided the jar files of the latest version are backward compatible and support the connections of the earlier version, but there can always be a risk of conflict.
  • Adapter for EJB does not support two different application servers at a time. This is because Adapter for EJB requires you to copy jar files from the application server directory to the Integration Server directory. If you copy the jar files from different application servers to the Integration Server directory, there can be a conflict of jar files of one application server with those of other application servers.

Upgrading the Adapter

About this task

To upgrade to Adapter for EJB 6.5 SP3

Procedure

  1. Back up the WmEJBAdapter package and any existing custom adapter packages.
  2. Uninstall the older version of the adapter. For information about how to uninstall Adapter for EJB, see the installation guide for the older adapter version.
  3. Delete the WmEJBAdapter package from the Integration Server_directory\instances\instance_name\packages directory.

    You should not delete any other packages, such as packages that contain connections and services, even when the packages have a dependency on the WmEJBAdapter package.

  4. Install Adapter for EJB as described in Installing the Adapter.
  5. Copy the application server client libraries from the old adapter installation to Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars and Integration Server_directory\instances\instance_name\packages\WmEJBAdapter\code\jars\static.
  6. Restart Integration Server.

Uninstalling the Adapter

About this task

To uninstall Adapter for EJB 6.5 SP3 :

Procedure

  1. Shut down the host Integration Server. You do not need to shut down any other webMethods products or applications that are running on your machine.
  2. If you want to keep the Adapter for EJB sample files, copy the Integration Server_directory\packages\WmEJBAdapter\templates directory to another location on your system.
  3. Start IBM webMethods Uninstaller, selecting the webMethods installation directory that contains the host Integration Server. In the product selection list, select Adapters > webMethods Adapter for Enterprise JavaBeans 6.5 SP3. You can also choose to uninstall documentation.
  4. Restart the host Integration Server.
  5. Uninstaller removes all Adapter for EJB 6.5 SP3-related files that were installed. However, Uninstaller does not delete files created after you installed the adapter (for example, user-created or configuration files), nor does it delete the adapter directory structure. You can go to the Integration Server_directory\packages directory and Integration Server_directory\instances\instance_name\packages directory. Delete the WmEJBAdapter directory.