{section}
{column}

h1. Introduction

{warning}This version must be installed on Petals ESB 5.0.0+{warning}

h2. Features

{multi-excerpt-include:Petals-SE-rmi|name=features|nopanel=true}

h2. Recommended usage

{multi-excerpt-include:Petals-SE-rmi|name=recommended-usage|nopanel=true}

{column}

{column:width=40%}
{panel:title=Table of contents}{toc:outline=true}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list|showAnonymous=true|showCount=true|showLastTime=true}{panel}
{column}
{section}

h1. 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.

h2. Configuration

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

{center}{*}Configuration of the SE RMI component*{center}
{table-plus}
|| {color:#333333}Parameter{color} || {color:#333333}Description{color} || {color:#333333}Default{color} || {color:#333333}Required{color} || Scope ||
| port | The port used by the RMI component to contact the RMI registry. | {center}1099{center} | {center}No{center} | {center}Installation{center} |
| host | The hostname where the RMI registry is running. | {center}-{center} | {center}No{center} | {center}Installation{center} |
| 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}}' | {center}true{center} | {center}No{center} | {center}Installation{center} |
| 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. | {center}RMIComponentContext{center} | {center}No{center} | {center}Installation{center} |
{table-plus}

*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.

h2. Using an external RMI registry