E-mail
Installing the Petals BC Gateway tooling pack
Through Debians packages
If you have installed Petals 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 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
Add 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 -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-jbi-gateway.
Remove 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.
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-jbi-gateway.
List 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 and/or port.
USAGE:
bc-gateway.list-transport-listener [-i <transport-listener-identifier>]
[-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.
-n,--component <component-identifier> The component
identifier associated
to the BC Gateway.
-p,--port <listening-port> The listening port of
the transport listener
to list.
The default component identifier used is: petals-bc-jbi-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 [-n <component-identifier>]
DESCRIPTION:
Repropagate all elected endpoints to the client domains of the BC Gateway
OPTIONS DESCRIPTION:
-n,--component <component-identifier> The component identifier
associated to the BC Gateway.
The default component identifier used is: petals-bc-jbi-gateway.