Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Anchortoptop

5. JBI

...

Overview

What is JBI ?

...

...

A brief introduction to JBI is available in the What is JBI? document. This document is more in-depth and supplemental.

...

JBI is a java based standard to build integrations systems by using plug-in components which interoperates through mediated normalized message exchanges.
The message exchange model is based on the web services description language (WSDL).

The figure at the top shows a high level concept of JBI of the plug-in framework. The JBI environment provides interfaces to be used by plug-in components, while the components provides interfaces used by the JBI environment. Components do not interact with each other directly. Instead, as shown in the bottom figure, JBI acts as an intermediary to route messages between components. This separation is the key to decoupling between service providers and consumers, which is one of the goal of service oriented architectures. In addition, it provides a key point for message processing and monitoring.

...

Image Modified

...

...

Image Modified

In this WSDL-based, service-oriented model, JBI plug-in components are responsible for providing and consuming services. By providing a service, a component is making available a function or functions that can be consumed by other components (or even itself). Such functions are modeled as WSDL 2.0 operations, which involve the exchange of one or more messages. A set of four WSDL-defined, basic message exchange patterns (MEPs) crisply defines the sequence of messages allowed during execution of an operation. This shared understanding, between consumer and provider components, of the message exchange pattern is the foundation of interoperability of such components in JBI.

The services provided by components (if any) are described to JBI by the component, using WSDL 1.1 or 2.0. This provides an abstract, technology-neutral model of services using XML-based message exchanges. WSDL also provides a mechanism for declaring additional service metadata of interest to service consumers and JBI itself. Components can query JBI for the for the WSDL describing available services.

JBI Architecture

...

...

This picture describes the architecture of the JBI system.

  • The JBI environment provides deployment, control & monitoring features through JMX based administration tools
  • The Normalized Message Router or NMR, which provides the mediated message exchange infrastructure
  • Components (in white rectangles)

Components are divided in two categories:

  • Service Engines (on top) provides business logic and transformation services and also consumes such services.
  • Binding Components provide connectivity to services external to the JBI environment.
    Service engines and binding components can function as service providers, consumers, or both. Note that the distinction between SEs and BCs is purely pragmatic, but the separation of business logic from communications logic reduces complexity and increases flexibility.

...

...

Image Modified

The JBI environment, in addition to the messaging system, defines a management structure based on JMX which provides standard mechanisms for:

...

The core message exchange concept implements WSDL messaging. Service requests are generated by consumer components, routed by the NMR, and delivered to a provider component. For example, the BPEL SE may generate a request, which happens to be provided by the external service provider connected to the WS-I BC. The NMR will route the request to the WS-I binding. The SE in this case is a service consumer, and the BC a provider.

#top

WSDL messaging model

...

...

JBI models services produced and consumed by components using Web Service Description Language 1.1 or 2.0. When the terminology differs between the two version, the 2.0 one is used. This is mainly the case for the interface and endpoint terms, which are called respectively "port type" and "port" in WSDL 1.1.

WSDL provides a declarative model of message-based services on two levels:

  • The abstract model defines services without references to a particular protocol or wire encoding
  • The concrete model is bound to a particular communication protocol and communications endpoint

JBI uses the abstract service model as the main basis for component interactions. Components play one of two roles in such interactions:

  • Service provider. The component that performs the given service (either directly or as a proxy for an external provider)
  • Service consumer. The component that invokes a given service (either directly or as a proxy for an external

...

  • consumer)

...

Image Modified

Abstract model

JBI models services produced and consumed by components using Web Service Description Language 1.1 or 2.0. When the terminology differs between the two version, the 2.0 one is used. This is mainly the case for the interface and endpoint terms, which are called respectively "port type" and "port" in WSDL 1.1.

...

The concrete service model defines the following items:

  • Binding types. A binding type identifies the type of protocol to which the service is being "bound".
  • Endpoints. An endpoint designates the communications endpoint information needed by a service consumer to interact with a service provider, using a particular protocol. In JBI endpoints are pro forma; the only protocol used internally is the standard Java-based JBI messaging contracts, which do not involve the use of normal communications protocols at all. An endpoint definition includes the following items that are of interest to JBI:
    • Endpoint name. This is a simple name, used to designate the endpoint within its service.
    • Binding type. This associates a binding type with an endpoint.
  • Service. A service is a collection of endpoints that offer access to the same service. A service "implements" a particular service type (interface). A service has the following items:
    • Service name. A qualified name used to indicate the particular service implementation.
    • Service type name. The name of the interface implemented by the service.
    • Endpoints. The service "contains" one or more endpoints, which are the individual endpoints providing access to the concrete service.

...

...

Image Modified

...

The Normalized Message Router (or NMR) receives message exchanges from JBI components and routes them to the appropriate component for processing. This decouples the service producers from consumers and enable additional processing.

Consumers and providers

...

...

JBI components (Service Engines and Binding Components) can act as a service consumer, a service provider or both. The diagram to the right outlines this using the example of a ServiceMix HTTP Consumer BC and a ServiceMix HTTP Provider BC. Notice where requests are initiated and the direction of the arrows to denote the flow from the initiator.

The provider makes a WSDL-described service available through an endpoint. This service implements a WSDL interface, which is a collection of operations.
The consumer can invoke the service by creating a message exchange that invoke a particular operation.
Consumers and providers only share the abstract service definition and are thus decoupled, as the consumer does not know the protocol and location of the invoked service.
Several services can implement the same WSDL interface so a consumer looking providers of an interface may find more than one endpoint.

...

...

Image Modified

Normalized message

...

...

JBI uses the concept of a normalized message for interactions between consumers and providers.
A normalized message consists of three parts:

  • A payload, which is an xml document that conforms to a WSDL message type without any protocol or encoding
  • Properties (or metadata) holds extra data associated with the message (security, transactions ...)
  • Attachments are arbitrary (non-xml) data that contain a data handler to

...

  • manipulate them

...

Image Modified

Delivery Channel

A Delivery Channel is a bidirectional asynchronous communication pipes between a component and the NMR.
A service consumer uses its delivery channel to initiate a service invocation, while the provider uses its delivery channel to receive such invocations.
Each component is provided with a single delivery channel, so the same channel is used for both inbound and outbound communications.

...

This sequence diagram shows a InOut service invocation between a consumer and a provider.

...

...

Image Modified

...

  1. The consumer creates an InOut message exchange, populates the "in" message (the request) and send it to the NMR
  2. The provider component polls the delivery channel for an exchange
  3. It processes the request, populates the "out" message and send it back to the NMR
  4. The consumer polls the delivery channel for the response
  5. It processes the response and mark the exchange as "done"
  6. The provider receives the "done" status from the delivery channel

...

People may wonder why there is a need for a "done" status... In JBI, all exchanges are terminated by either a "done" or an "error" status. Errors are different from faults which are parts of the normal exchange processing. So, the done status is very useful to implement reliable message, transactions or passing streams inside the exchange.
Let's take the example a file binding component, which would poll for files, send the content as an InOnly request, and delete them afterwards. For performance reasons, it will send an opened stream on the file, but it has to close the stream and delete the file once processed. If the consumer is asynchronous (which is better because it saves threads), it needs a way to know when the file has to be deleted, hence the need for the "done" status.

#top

JBI packaging

...

...

JBI defines a standard packaging for installing new components and deploying artifacts onto these components that can function as "containers".
All these artifacts contain a JBI descriptor in the META-INF directory called jbi.xml.

...

...

Image Modified

We have already discussed some of these artifacts, but let's dive in them a bit more. There are four types of artifacts, all packaged as zip or jar files:

...