Petals BC Gateway tooling

Introduction

The Petals BC Gateway tooling pack for Petals ESB CLI is a set of commands relatives to the Petals BC Gateway. The pack comes with the commands:

  • bc-gateway.add-transport-listener: Add a new transport listener to the given BC Gateway.
  • bc-gateway.set-transport-listener-port: Set the port of a transport listener of the given BC Gateway.
  • bc-gateway.del-transport-listener: Remove a transport listener of the given BC Gateway.
  • bc-gateway.list-transport-listener: List transport listeners of the given BC Gateway.
  • bc-gateway.repropagate: Repropagate all elected endpoints to the client domains of the BC Gateway.
  • bc-gateway.reconnect: Triggers reconnection of client domains of the BC Gateway.
Contributors
No contributors found for: authors on selected page(s)

Installing the Petals BC Gateway tooling pack

Through Debian packages

If you have installed Petals ESB CLI using the Debian packages, we recommend you to install the Petals BC Gateway tooling pack using its own Debian package (petals-cli-bc-gateway). Otherwise, unzip the content of the ZIP archive in the directory $PETALS_CLI_HOME/extensions.

Through ZIP archives

If you have installed the full ZIP archive, the extension should be already installed. Otherwise, unzip the content of the ZIP archive petals-cli-bc-gateway in the directory $PETALS_CLI_HOME/extensions.

Installation verification

To check that the installation is correct, just get the list of available commands of your Petals ESB CLI, you should see the command 'bc-gateway.*' in the list:

> ./petals-cli.sh -c -- help
Available commands:
...
   bc-gateway.repropagate
               Repropagate all elected endpoints to the client domains of the BC Gateway.
   connect     Connect to a Petals ESB node.
...

Commands

Adding a new transport listener

The command bc-gateway.add-transport-listener provides a way to configure a Petals BC Gateway to add a new transport listener.

USAGE:
 bc-gateway.add-transport-listener usage: bc-gateway.add-transport-listener -i
       <transport-listener-identifier> [-n <component-identifier>] -p
       <listening-port>


DESCRIPTION:
 Add a new transport listener to the given BC Gateway

OPTIONS DESCRIPTION:
 -i,--identifier <transport-listener-identifier>   The unique identifier
                                                   of the transport
                                                   listener to add to the
                                                   BC Gateway.
 -n,--component <component-identifier>             The component
                                                   identifier associated
                                                   to the BC Gateway.
 -p,--port <listening-port>                        The listening port of
                                                   the transport listener
                                                   to add to the BC
                                                   Gateway.

The default component identifier used is: petals-bc-gateway.

Modifying the port of a transport listener

The command bc-gateway.set-transport-listener-port provides a way to configure a Petals BC Gateway to modify the port of one of its transport listener.

Modifying the port of a transport listener of a started BC Gateway will restart it, even if it is the same port, but an already established connections won't be stopped.
USAGE:
 bc-gateway.set-transport-listener-port usage: bc-gateway.set-transport-listener-port -i
       <transport-listener-identifier> [-n <component-identifier>] -p
       <listening-port>


DESCRIPTION:
 Set the port of a transport listener of the given BC Gateway

OPTIONS DESCRIPTION:
 -i,--identifier <transport-listener-identifier>   The unique identifier
                                                   of the transport
                                                   listener to modify in
                                                   the BC Gateway.
 -n,--component <component-identifier>             The component
                                                   identifier associated
                                                   to the BC Gateway.
 -p,--port <listening-port>                        The new listening port
                                                   of the transport
                                                   listener.

The default component identifier used is: petals-bc-gateway.

Removing an existing transport listener

The command bc-gateway.del-transport-listener provides a way to configure a Petals BC Gateway to remove an existing transport listener.

A transport listener can't be removed if it's currently being used by deployed service units!
USAGE:
 bc-gateway.del-transport-listener usage: bc-gateway.del-transport-listener -i
       <transport-listener-identifier> [-n <component-identifier>]


DESCRIPTION:
 Remove a transport listener of the given BC Gateway

OPTIONS DESCRIPTION:
 -i,--identifier <transport-listener-identifier>   The unique identifier
                                                   of the transport
                                                   listener to remove from
                                                   the BC Gateway.
 -n,--component <component-identifier>             The component
                                                   identifier associated
                                                   to the BC Gateway.

The default component identifier used is: petals-bc-gateway.

Listing existing transport listeners

The command bc-gateway.list-transport-listener provides a way to list all configured transport listeners of the given Petals BC Gateway and given criteria: transport listener identifier, listening status and/or port.

USAGE:
 bc-gateway.list-transport-listener usage: bc-gateway.list-transport-listener [-i
       <transport-listener-identifier>] [-l <boolean>] [-n
       <component-identifier>] [-p <listening-port>]


DESCRIPTION:
 List transport listeners of the given BC Gateway

OPTIONS DESCRIPTION:
 -i,--identifier <transport-listener-identifier>   The unique identifier
                                                   of the transport
                                                   listener to list.
 -l,--listening <boolean>                          The listening status of
                                                   the transport listeners
                                                   to list.
 -n,--component <component-identifier>             The component
                                                   identifier associated
                                                   to the BC Gateway.
 -p,--port <listening-port>                        The listening port of
                                                   the transport listeners
                                                   to list.

The default component identifier used is: petals-bc-gateway.

Refresh endpoint propagations

The command bc-gateway.repropagate provides a way to refresh endpoint propagations to domain clients of the current gateway.

USAGE:
 bc-gateway.repropagate usage: bc-gateway.repropagate [-c <consumer-domain-identifier>] [-n
       <component-identifier>] [-s <service-unit-identifier>]


DESCRIPTION:
 Repropagate all elected endpoints to the client domains of the BC Gateway

OPTIONS DESCRIPTION:
 -c,--consumer-domain <consumer-domain-identifier>   The consumer domain
                                                     identifier defined in
                                                     the specified service
                                                     unit.
 -n,--component <component-identifier>               The component
                                                     identifier associated
                                                     to the BC Gateway.
 -s,--service-unit <service-unit-identifier>         The service unit
                                                     identifier deployed
                                                     on the BC Gateway.

The default component identifier used is: petals-bc-gateway.

Reconnect clients

The command bc-gateway.reconnect provides a way to reconnect the clients of the Petals BC Gateway that are disconnected (or even that are connect if the force option is used).

USAGE:
 bc-gateway.reconnect usage: bc-gateway.reconnect [-c <provider-domain-identifier>] [-f] [-n
       <component-identifier>] [-s <service-unit-identifier>]


DESCRIPTION:
 Triggers reconnection of client domains of the BC Gateway

OPTIONS DESCRIPTION:
 -c,--provider-domain <provider-domain-identifier>   The provider domain
                                                     identifier defined in
                                                     the specified service
                                                     unit.
 -f,--force                                          Force reconnection
                                                     even if the provider
                                                     domain is already
                                                     connected.
 -n,--component <component-identifier>               The component
                                                     identifier associated
                                                     to the BC Gateway.
 -s,--service-unit <service-unit-identifier>         The service unit
                                                     identifier deployed
                                                     on the BC Gateway.

The default component identifier used is: petals-bc-gateway.

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