Make SOAP Request Message mode

The Make SOAP Request Message mode method supports signing SOAP messages according to the Web Services Security (WSS) specification to assure the integrity of the SOAP message and allows the communication of the X.509 security token format. Signed messages also provide non-repudiation. In the Message mode, you can either provide the entire SOAP envelope or the SOAP body payload as required by the web service.

The following table describes the process inputs for the Web Services adapter with Make SOAP request in message mode.


Input

Description

Required

<adapter name>

Specifies the name of the adapter to use for this process

No

<wsdl location>

Specifies the URI (file name or URL) pointing to a XML WSDL definition

Yes

<soap message>

Specifies the fully formatted SOAP message to transmit or the SOAP body payload as required by the web service

Yes

<endpoint address>

Specifies the target service endpoint address

This element can be used if the SOAP request must be invoked on an endpoint address other than the one specified in the WSDL document.

No

<service name>

Specifies a unique name among all the services defined in the enclosing WSDL document

A service groups a set of related ports together.

No

<port name>

Specifies a unique name among all the ports defined in the enclosing WSDL document

A port defines an individual endpoint by specifying a single address for a binding.

No

<soap action>

Specifies the value of the SOAPAction header for the operation

No

<soap version>

Specifies the SOAP version to use

Valid values: 1.1 (default), 1.2

No

<invocation mode>

Specifies the ways in which a web service request can be invoked

Valid values: synchronous (default), asynchronous, one-way

No

<use ssl certificate>

Specifies whether to establish a secure connection

Set the value of this element to true when <wsdl location> uses HTTPS.
Set the value of this element to false or leave it blank when <wsdl location> uses HTTP.

Valid values: true, false (default)

No

<install certificate>

Specifies whether to install certificates

Set the value of this element to true if you prefer to have security certificates installed automatically (common). Set the value of this element to false if you prefer to manually export the security certificate from the specified target server and manually import it into the TrueSight Orchestration's local peer's cacerts file (rare).

Valid values: true, false (default)

No

<allow unsigned certificate>

Specifies whether to allow unsigned certificates from trusted zones

Set the value of this element to true, if you are using self-signed SSL certificates (a common practice).

On ecommerce sites or military installations, if you need to use signed certificates such as Verisign or Thawte, set the value of this element to false (a rare practice).

Default value: false

No

<truststore file>

Specifies the path to the truststore file containing the CAs Default value: Java standard truststore

No

<pass phrase>

Specifies the password of the truststore file

Warning

  • The value of the <passphrase> element is the passphrase for the cacerts certificate stored on the TrueSight Orchestration local peer (CDP or AP) and not the specified target host.

  • Changing the passphrase can be tricky and might destroy the cacerts security file integrity.


Verify the cacerts passphrase using the following command in UNIX or Linux:

$ /opt/bmc/ao/cdp/jvm/bin/keytool -list -keystore
/opt/bmc/ao/cdp/jvm/lib/security/cacerts

Default value: changeit

No

<keystore file>

Specifies the path to the keystore containing the client certificate

No

<keystore pass phrase>

Specifies the path to the keystore containing the client certificate

Default value: changeit

No

<client alias>

Specifies the alias name in the keystore that identifies the public key certificate (PKC) used by the web server to authenticate the client computer

No

<username token>

Builds a Web Services Username Token and inserts it into the SOAP envelope

Valid values: true, false

No

<user name>

Specifies the user name for authentication

No

<password>

Specifies the password for authentication

No

<password encryption type>

Specifies the method of encryption used to encrypt the given password

Valid values: Base64, Plain (default)

Note

This element can contain an encryption-type attribute to indicate whether the passphrase provided is encrypted:

  • If the <password-encryption-type> element is Base64, provide a Base64 encoded value.
  • If the <password-encryption-type> element is Plain, provide value in plain text.

No

<password type>

Specifies the types of password supported by UsernameToken Authentication

This parameter is read-only if the value of the <username-token> element is true.

Valid values: plain-text (default), digest

No

<timestamp>

Builds a Web Services timestamp and inserts it into the SOAP envelope Valid values: true, false (default)

No

<time to live>

Sets the time difference in seconds between the Created and the Expires values in the timestamp

Default value: 60 seconds

No

<nonce validation>

Adds a nonce element to the <username-token> element

Valid values: true, false (default)

No

<created validation>

Adds a created element to the <username-token> element

Valid values: true, false (default)

No

<sign request>

Creates a signature according to the Web Services specification X.509 profile and adds it to the Security header The Token Reference supported by the adapter is Binary Security Token.

Valid values: true, false (default)

No

<sign username token>

Signs the Web Services <username-token> element in the Security header

Valid values: true, false (default)

No

<sign timestamp>

Signs the Web Services timestamp element in the Security header

Valid values: true, false (default)

No

<signature mode>

Specifies the format in which the public (X.509 certificate) and private keys used for signing the SOAP envelope will be provided The keys can be provided via a Java Keystore (JKS), or PEM/DER files, or unencrypted Base-64 format

No

<private key file>

Specifies the file containing the private key used to sign the SOAP message using the signing algorithm

The adapter supports the following formats:

  • Base64-encoded unencrypted PEM
  • Definite Encoding Rules (DER)

Conditional; required if the value of the mode attribute of the <signature-properties> element is key-files

<certificate file>

Specifies the file containing the X.509 certificate (public key)

The adapter supports the following formats:

  • Base64-encoded unencrypted PEM
  • DER

Conditional; required if the value of the mode attribute of the <signature-properties> element is key-files

<private key data>

Specifies the private key in unencrypted Base64-encoded PEM format

Conditional; required if the value of the mode attribute of the <signature-properties> element is key-data

<certificate data>

Specifies the X.509 certificate (public key) in unencrypted Base64-encoded PEM format

Conditional; required if the value of the mode attribute of the <signature-properties> element is key-data

<signature keystore>

Specifies the XML representing details of the keystore containing the public and private keys used for signing the SOAP envelope

Conditional

<attachments>

Contains an XML document that specifies the name and path of the files to be attached

You must specify the values for the Content-Id header for the attachment, if required by the web server.

No

<download-attachments>

Specifies whether to download attachments that are embedded as MIME parts in the SOAP response

Valid value: true, false (default)

No

<character-set>

Specifies the supporting charset

Also called character set, it includes identifiers describing a series of universal characters.

No

<http request headers>

Specifies an XML document containing the list of custom HTTP headers to be added to the outgoing SOAP request

Sample XML:
<http-request-headers>
<http-request-header>
<name></name>
<value></value>
</http-request-header>
<http-request-header>
<name></name>
<value></value>
</http-request-header>
.
.
.
</http-request-headers>

No

<use-connection-pooling>

Specifies whether the connection pooling feature is enabled for the adapter

Valid values: true, false (default)

No

<max-connections>

Defines the maximum number of objects that can be in circulation in the pool, if the value of <use-connection-pooling> is true

Valid values: Any positive integer

Default value: 10

No

<connection-ttl>

Specifies the maximum amount of time, in minutes, for which a connection can remain idle in the connection pool before it is terminated, if the value of <use-connection-pooling> is true

Valid values: Any positive integer

Default value: 60 minutes

No

The following table describes the process output parameter for the Web Services adapter with JAX-WS and message mode.

Make SOAP request in message mode process output

Output

Description

<adapter response>

Specifies the Web Services adapter response

Was this page helpful? Yes No Submitting... Thank you

Comments