Petals BC Gateway tooling

compared with
Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (5)

View Page History
The Petals BC Gateway tooling pack for Petals 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,
* {{bc-gateway.set-transport-listener-port}}: Modify the port of a transport listener,
* {{bc-gateway.del-transport-listener}}: Remove an existing transport listener,
* {{bc-gateway.list-transport-listener}}: List existing transport listeners of the Petals BC Gateway,
The default component identifier used is: {{petals-bc-jbi-gateway}}.

h2. Modify 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.

{tip}Modifying the port of a transport listener of a started BC Gateway will restart it, but the already established connections won't be stopped.{tip}

{code}
USAGE:
bc-gateway.set-transport-listener-port -i <transport-listener-identifier>
[-n <component-identifier>] -p <listening-port>


DESCRIPTION:
Modify 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
to modify in the BC
Gateway.
{code}

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

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

{tip}A transport listener can't be removed if it's currently being used by deployed service units!{tip}

{code}
USAGE: