Plug-in Documentation

Oracle Service Bus Configuration Management

Overview

Oracle Service Bus connects, mediates, and manages interactions between services and applications.

The Oracle Service Bus Configuration Management plug-in provides self-contained steps to support applying and importing Oracle Service Bus configurations.

Connection information file for accessing the Oracle WebLogic server
All steps in this plug-in require connection information for accessing the Oracle WebLogic server. The connection information is defined in a JavaBeans configuration file. You provide the path to the configuration file in the step properties. The wlsMetadata.xml file that is provided with the plug-in is a working example of a configuration file.

Configuration files for objects
Objects are defined in Java Management Extensions (JMX) properties files. You provide the path to the JMX properties file in step properties. Example files are provided in the extras directory in the plug-in for roles and for users and groups.

JAR file paths on the server
The steps rely on the following Java archive (JAR) files on the Oracle Service Bus server. Include the path to the JAR files in your class path.

  • OracleServerDirectory/Oracle_OSB1/lib/modules/oracle.servicebus.kernel-api.jar (on versions of Oracle Service Bus later than 11g)
  • OracleServerDirectory/Oracle_OSB1/lib/sb-kernel-api.jar (on Oracle Service Bus versions 10g through 11g)
  • OracleServerDirectory/Oracle_OSB1/modules/com.bea.common.configfwk_1.7.0.0.jar

As well as the following build-time libraries:

  • wlclient.jar
  • wljmxclient.jar
  • wlthint3client.jar

If no errors occur during a step, the plug-in activates the changes made to the Oracle Service Bus session. You do not need to activate the session manually.

Compatibility

This plug-in requires version 6.0.1 of IBM UrbanCode Deploy.

This plug-in supports Oracle Service Bus versions 10g and later.

The steps in this plug-in run on any agents that the IBM UrbanCode Deploy server supports.

Installation

No special steps are required for installation. See Installing plug-ins in IBM UrbanCode Deploy.

History

Version 13

Fixes missing property exception in Import Configuration step.

Version 12

Support property file encryption.

Version 11

This version of the plug-in includes a step that imports configuration files and applies customization in the same step, which is a fix for APAR PI61865.

Version 8

Initial release of the plug-in.

Steps

Process steps in the OSB Management plug-in

Apply Customization

Customize Oracle Service Bus with an XML file.

Input properties for the Apply Customization step
Name Type Description Required
Customization XML File String The full path to the Oracle Service Bus XML customization file. Yes
Hostname String The host name of the computer running Oracle WebLogic Server. Yes
Password Password The password of the Oracle WebLogic Server user. Yes
Port String The port used by Oracle WebLogic Server. Yes
Timeout String Specify a timeout value, in milliseconds, to wait for the customization task to run. No
UserId String User ID Yes
WebLogic Dependencies String The class path to the WebLogic dependencies that are required to run Oracle Service
Bus commands.
Yes

Import Configuration

Import a configuration into Oracle Service Bus with a JAR file.

Input properties for the Import Configuration step
Name Type Description Required
Abort On First Failure Boolean Select to stop the Oracle Service Bus session after the first failure. Clear to try
all specified JAR files.
Yes
Always Activate Session Boolean Select to activate the session even if failures occur. (This matches behavior from
version 1 of the plug-in.)
Yes
Configuration JAR Files String A list, separated by commas, of paths to Oracle Service Bus configuration JAR files. Yes
Hostname String The host name of the computer running Oracle WebLogic Server. Yes
Password Password The password of the Oracle WebLogic Server user. Yes
Port String The port used by Oracle WebLogic Server. Yes
Timeout String Specify a timeout value, in milliseconds, to wait for the configuration task to run. No
UserId String User ID Yes
WebLogic Dependencies String The class path to the WebLogic dependencies that are required to run Oracle Service
Bus commands.
Yes

Import Configuration and Apply Customization

Import a configuration into Oracle Service Bus with a JAR file and customize Oracle
Service Bus with an XML file in the same WebLogic session.

Input properties for the Import Configuration and Apply Customization step
Name Type Description Required
Abort On First Failure Boolean Select to stop the Oracle Service Bus session after the first failure. Clear to try
all specified JAR files.
Yes
Always Activate Session Boolean Select to activate the session even if failures occur. (This matches behavior from
version 1 of the plug-in.)
Yes
Configuration JAR Files String A list, separated by commas, of paths to Oracle Service Bus configuration JAR files. Yes
Customization XML File String The full path to the Oracle Service Bus XML customization file. Yes
Hostname String The host name of the computer running Oracle WebLogic Server. Yes
Password Password The password of the Oracle WebLogic Server user. Yes
Port String The port used by Oracle WebLogic Server. Yes
Timeout String Specify a timeout value, in milliseconds, to wait for the configuration task to run. No
UserId String User ID Yes
WebLogic Dependencies String The class path to the WebLogic dependencies that are required to run Oracle Service
Bus commands.
Yes