C Oracle Service Bus APIs

Oracle Service Bus exposes APIs to allow customizing resources and to provide external access to monitoring data and deployment.

Javadoc for the Oracle Service Bus APIs is provided in the Oracle Fusion Middleware Java API Reference for Oracle Service Bus.

C.1 Resource Update and Customization

A number of APIs are exposed to allow customization of service definitions, WSDLs, schemas, XQueries, and other design-time resources through programmatic interfaces. The supporting APIs allow loading ZIP files containing resources, in addition to moving, renaming, cloning, or deleting resources, folders, and projects. A typical use case is one in which you have a prototypical proxy service from which you make a number of copies—each copy can be modified programmatically.

Numerous customization options can be applied during deployment. For example, environment variables allow you to preserve or tailor settings when moving from one environment to another.

The available APIs include:

  • ProxyServiceConfigurationMBean—Enable and disable SLA alerts and pipeline alerts for proxy services

  • BusinessServiceConfigurationMBean

    • Enable and disable SLA alerts

    • Synchronize business services imported from UDDI registries

    • Detach business services from a UDDI registry

  • ALSBConfigurationMBean Interface—APIs for managing resources in an Oracle Service Bus domain, including:

    • Query, export, and import resources

    • Obtain validation errors

    • Get and set environment values

    • Modify references inside resources to new references

    • Move, rename, clone, and delete resources

  • Customization Class

    • Find and replace environment values

    • Assign environment values

    • Map references found in resources to other references

C.2 Management and Monitoring

The JMX Monitoring API in Oracle Service Bus provides external access to monitoring data. Java Management Extensions (JMX) technology was used for the implementation. Oracle Service Bus resources within a domain use JMX Managed Beans (MBeans) to expose their management functions. An MBean is a concrete Java class that is developed according to JMX specifications.

For information, see Appendix D, "JMX Monitoring API."

C.3 Deployment

You can use the Oracle Service Bus MBeans in Java programs and WLST scripts to automate promotion of Oracle Service Bus configurations from development environments through testing, staging, and finally to production environments.

Numerous customization options can be applied during deployment. For example, an extended list of environment variables allows you to preserve or tailor settings when moving from one environment to another.

For information, see "Using the Deployment APIs" in the Oracle Fusion Middleware Deployment Guide for Oracle Service Bus.