View Source

{section}
{column}

h1. Introduction

The Petals ESB "Embedded Petals Registry Overlay" is a *pre*-extension embedding a default [Petals Registry Overlay|Petals ESB Hazelcast Registry client].

This extension was created to simplify the start of a Petals ESB container member of a default standalone topology avoiding to start the Petals registry Overlay as another system process.

{column}
{column:width=35%}
{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 of the extension

This extension is embedded with [the ZIP archive of the Petals ESB container|Installing Petals ESB using the ZIP archive], so no installation is required.

This extension is not available as Debian package because it's dedicated to sample standalone topologies. Debian packages are designed for production installations that are currently based on topologies containing several nodes.

This extension is activated if, in order:
* the topology is a standalone topology (ie. the topology contains only one container),
* no registry implementation is configured in the topology,
* the server property {{petals.embedded-registry-overlay}} is not set or set to {{true}}.

To install this extension over a Petals ESB installed through Debian packages:
# if needed, create the directory {{/usr/share/petals-esb/extensions}}
# unzip the archive of the extension into the directory {{/usr/share/petals-esb/extensions}}

h1. Using the Embedded Petals Registry Overlay

The Embedded Petals Registry Overlay provided with this extension is one configured with the following cluster definition:
{code:xml}
<tns:petals-registry-overlay xmlns:tns="http://petals.ow2.org/registry-overlay/configuration/1.0">
<tns:credentials>
<tns:group>default-sample</tns:group>
<tns:password>s3cr3t</tns:password>
</tns:credentials>
<tns:members>
<!-- Default listening port: 7900 -->
<tns:member id="sample-member-0">localhost</tns:member>
</tns:members>
<!-- By default, the support of the Hazelcast Management Center is enable -->
<!--tns:management-console enable="true">http://localhost:8080/mancenter</tns:management-console-->
</tns:petals-registry-overlay>
{code}

You can connect your Hazelcast Management console to this registry.

{anchor:Configuration}
h1. Configuration

h2. Runtime configuration parameters

Configuration parameters of the Embedded Petals Registry Overlay are available into the container local configuration (ie. into the file {{server.properties}}:
|| Parameter/Property name || Default value || Description ||
| {{petals.embedded-registry-overlay}} | {{true}} | Flag enabling/disabling the extension if the topology authorizes to use this extension |
| {{petals.embedded-registry-overlay.port}} | {{7900}} | The listening TCP port of the embedded registry |

h2. Logging configuration parameters

This extension uses the following logger name to trace its execution: {{Petals.Extensions.EmbeddedRegistryOverlayService}}.

As this extension is provided into the ZIP Archive of Petals ESB, its logging configuration is already configured. If you install this extension through Debian or RPM package, just add something like the following lines to your {{loggers.properties}}:
{code}
Petals.Extensions.EmbeddedRegistryOverlayService.level=FINEST
{code}