Package toolbox.oracle.osb.config

Provides an API for importing and exporting projects, folders and resources to and from Oracle Service Bus.

See:
Description

Class Summary

OSBConfigData	Java Bean style class to store, read and write OSB configuration data.
OSBConfigUtil	OSB Configuration utility capable of importing and exporting projects, folders and resources to and from Oracle Service Bus.

Exception Summary

OSBConfigUtilException

Exception that is generated during OSBConfigUtil interactions.

Package toolbox.oracle.osb.config Description

Provides an API for importing and exporting projects, folders and resources to and from Oracle Service Bus.

Installation and Configuration

This section assumes that Oracle Service Bus 11.1.1.4 or later and Java Toolbox build 32 or later is installed. Download links are provided in the API Overview document.

The configuration utility requires the following environment variables to be set:

• TOOLBOX_HOME
• TOOLBOX_ORA_FMW_UTIL_HOME
• ORACLE_MW_HOME
• OSB_HOME

The following is an example of my current Unix environment:

     TOOLBOX_HOME=/opt/frameworks/toolbox
     TOOLBOX_ORA_FMW_UTIL_HOME=/opt/frameworks/tbmodules/toolbox_oracle_fmw_util
     ORACLE_MW_HOME=/opt/oracle/ofm116
     OSB_HOME=$ORACLE_MW_HOME/oracle_osb01
      

The utility makes use of the wlfullclient.jar file. This file must be built using the WebLogic JarBuilder utility. The process to create the jar file is documented here.

Using the Utility

The configuration utility provides a number of interfaces that include a Java API, command line and Ant tasks. This section will cover the simpler command line and Ant task use cases.

Command Line

The osb_config_util.sh shell script is located in the bin directory of the module distribution. The program displays a usage message when executed without any arguments e.g

         ./osb_config_util.sh
       

The following options are available:

• -command: Command to execute. export|import|execute_xml.
• -host: OSB admin server host.
• -port: OSB admin server port.
• -user: OSB admin user.
• -password: OSB admin password.
• -jar: Jar file that must be exported or imported.
• -xml: Optional option to create or apply an XML customisation file.
• -type: Type of resources that must be exported. Only required when command is export. project|folder|proxy.
• -resources: Comman separated list of resources. Only required when command is export.

Apache Ant

A number of Ant tasks are provided. These tasks are defined and documented in the share/ant/toolbox_osb_macros.xml file in the module distribution. The following build file fragment illustrates how the ant tasks can be included in an ant project:

         ...
         <property environment="env"/>
         <import file="${env.TOOLBOX_ORA_FMW_UTIL_HOME}/share/ant/toolbox_osb_macros.xml"/>
         ...

         <target name="myExport">
           <tbosbexportjarxml ... />
         </target>