Petals-BC-SOAP 5.1.0+

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

Changes (16)

View Page History

{anchor:componentConfiguration}
h1. Component Configuration
h1. Configuring the component

{include:0 CDK Component Configuration Table 5.6.0}
The component can be configured through the parameters of its JBI descriptor file. These parameters are divided in following groups:
* *JBI parameters* that have not to be changed otherwise the component will not work,
* *CDK parameters* that are parameters driving the processing of the CDK layer,
* and parameters dedicated to the embedded SOAP servers and clients:
** embedded HTTP server,
** embedded HTTP web-service clients,
** embedded JMS client listenning incoming messages.

{center}{*}Configuration of the component, component part{*}{center}
{table-plus:columnAttributes=,,style="text-align:center;",style="text-align:center;"}
h2. CDK parameters
The component configuration includes the configuration of the CDK. The following parameters correspond to the CDK configuration.

{include:0 CDK Component Configuration Table 5.8.0}

h2. Interception configuration
{include:0 CDK Component Interceptor configuration 5.8.0}

h2. Dedicated configuration

These parameters drive features proposed by the component and configure the embedded SOAP servers and clients:
** embedded HTTP server,
** embedded HTTP web-service clients,
** embedded JMS client listenning incoming messages.

h3. Parameters of the embedded HTTP server

{table-plus:columnAttributes=,,style="text-align:center;",style="text-align:center;"}
|| Parameter || Description || Default || Required ||
| http-port | HTTP port of the Jetty embedded server \\ | 8084 | No |
| http-acceptors | Number of acceptors for HTTP. Its value is limited to the number of available CPU. *Caution*, as an acceptor is a thread borrowed from the thread pool, the values of {{http-thread-pool-size-min}} and {{http-thread-pool-size-max}} MUST take into account this value. If {{http-thread-pool-size-max}} < {{http-acceptors}} + {{https-acceptors}}, no request can be processed. | 4 | No |
| http-backlog-size | The size of the TCP queue in which incoming HTTP connection request are put waiting to be accepted. | 50 | No |
| max-http-connections-per-host | Max concurrently opened connections to external services (used by provides). | The max size of the message exchange processor thread pool ({{processor-max-pool-size}}) | No |
| https-enabled \\ | Enable the HTTPS support. \\
Possible values are: true, false. \\ | false \\ | No \\ |
| https-truststore-file \\ | File path of the truststore. | \- \\ | No \\ |
| https-truststore-password \\ | Password of the truststore. | \- \\ | No \\ |
{table-plus}

h3. Parameters of the embedded HTTP web-service clients

{table-plus:columnAttributes=,,style="text-align:center;",style="text-align:center;"}
|| Parameter || Description || Default || Required ||
| max-http-connections-per-host | Max concurrently opened connections to external services (used by provides). | The max size of the message exchange processor thread pool ({{processor-max-pool-size}}) | No |
{table-plus}

h3. Parameters of the embedded JMS client listenning incoming messages

{table-plus:columnAttributes=,,style="text-align:center;",style="text-align:center;"}
|| Parameter || Description || Default || Required ||
| java-naming-factory-initial | The initial context factory class needed to access the JNDI server where the JMS connection factory can be found. | \- | No |
| java-naming-provider-url | The JNDI provider URL where the JMS connection factory can be found. | \- | No |
{table-plus}

{include:0 CDK Parameter scope}
h1. Business monitoring

h2. MONIT traces

{include:0 CDK BC Business Monitoring Traces 5.8.0}

Following MONIT level traces have information specific to the component defined here:

|| Trace code || Description || Specific information || Message content stored ||
| {{consumeExtFlowStepBegin}} | An external incoming web-service request received | * {{requestedURL}}: URL of the web-service invoked | - |
| {{provideExtFlowStepBegin}} | An external outgoing web-service request is sent | * {{requestedURL}}: URL of the web-service invoked | - |

h2. Flow tracing activation

{include:0 CDK BC Provides Business Monitoring Flow Tracing Activation 5.8.0}

h1. Monitoring the component

* and execution status (PENDING, ERROR, FAULT, SUCCEEDED). | integer counter value, since the last startup of the component | no |


h2. Receiving alerts

* {{user data}}: The web-service client pool id as {{String}} |

{show-to:users=llacote, cdeneux}

h1. MONIT level traces description

Following MONIT level traces have information specific to the component defined here:

|| Trace code \\ || Specific information \\ || Message content stored \\ ||
| MON-005 | * specific information identifying the outside client: IP-address
* specific information identifying the consume service unit: URL of the exposed webservice | * SOAP Envelope,
* attachments |
| MON-006 | * specific information identifying the external service provider: URL of the external webservice | * SOAP Envelope,
* attachments |
| MON-007 | \- \\ | * SOAP Envelope,
* attachments |
| MON-008 | \- \\ | * SOAP Envelope,
* attachments |
{show-to}

{anchor:op-resolving}

h1. Operation resolving: Mapping from URI, SOAP/WSA Action, Document/Literal-wrapped pattern and RPC/Literal pattern