Petals-SE-RMI 1.6.x

Introduction

This version must be installed on Petals ESB 5.0.0+

Features

The Petals RMI service engine aims to provide a direct access to the internal NMR of a Petals ESB container. So an external Java client can interact directly with the NMR:
  • to activate, deactivate or search endpoints,
  • to create, send or receive message exchanges.


The external Java client can act as a service consumer or a service consumer:

  • a Java client as service consumer will create message exchanges, send and receive them. Such a client is responsible to apply correctly message exchange patterns,
  • a Java Client as service provider will activate/deactivate endpoints receiving and replying to message exchanges.
Petals SE RMI overview

Recommended usage

This component should be used in test context, for example for integration tests of JBI components.

This component is distributed with the Petals Community Pack, and we discourage you from using it in a production environment.

Contributors
No contributors found for: authors on selected page(s)

Usage

Once the RMI component is started, it binds a representation of its component context in the RMI registry. A client is thus able to access to this remote representation of the component context to create severals endpoints and communicate with others JBI services.

From this remote component context, the client can get the RMI representation of :

  • the delivery channel,
  • the message exchange factory.

The RMI client can also :

  • receive JBI messages,
  • send JBI messages.

To make easier these different actions, a client library is provided. The next section of this document defines how to use this library to create an RMI client.

The current version of the Petals SE RMI registers only one remote component context. So, just one client can be connected to this context on this component. This restriction will be deleted in a next version of the component. For now, if you want install several clients, you must install several rmi components.

Installation

The installation of the RMI component is achieved in the same way as classical components, please refer to the user guide for more details.

Configuration

This component is not based on the Petals CDK, so all standard configuration parameters are not available.

Configuration of the SE RMI component

Parameter Description Default Required Scope
port The port used by the RMI component to contact the RMI registry.
1099
No
Installation
host The hostname where the RMI registry is running.
-
No
Installation
embeddedregistry Defines if the internal RMI registry of the component must be activated. By default, the internal RMI registry is started on the port defined by the parameter 'port'. If this parameter is set to false, the administrator of the Petals SE RMI component is in charge to manage and start his own RMI registry before starting the RMI component. The hostname of the RMI registry must be set using the parameter 'host'
true
No
Installation
componentcontextname Define the reference name registered in the RMI registry when the bind with the remote component context is realized. This remote component context is just a representation of the concrete component context of PEtALS. No direct access to a concrete component is provided to clients.
RMIComponentContext
No
Installation

Definition of the parameter 'scope':

  • Installation: The parameter can be set during the installation of the component, by using the installation MBean (see JBI specifications for details about the installation sequence). If the parameter is optional and has not been defined during the development of the component, it is not available at installation time.
  • Runtime: The parameter can be set during the installation of the component and during runtime. The runtime configuration can be changed using the CDK custom MBean named RuntimeConfiguration. If the parameter is optional and has not been defined during the development of the component, it is not available at installation and runtime times.

Using an external RMI registry

If the component is configured to have an external RMI registry (the parameter 'embeddedregistry' is set to false), this external registry must be started before installation:

Petals SE RMI overview
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.