SoapConfig

Configuration Object für Soap Webservice Aufrufe. Das resultierende Objekt wird bei Ausführung auf plausible Konfiguration geprüft (validiert).

Methods

action

action(pAction): SoapConfig

The function that is to be called on the webservice.

Parameters

pAction

string | number | boolean

the function name

Returns

SoapConfig

SoapConfig

---

addHeader

addHeader(pName, pValue): SoapConfig

Adds a header entry.

Parameters

pName

string | number | boolean

the name of the header entry

pValue

string | number | boolean

the value of the header entry

Returns

SoapConfig

RestConfig

---

addHeaders

addHeaders(pName, pValues): SoapConfig

Adds a header entry.

Parameters

pName

string | number | boolean

the name of the header entry

pValues

string[]

the values of the header entry

Returns

SoapConfig

RestConfig

---

addQueryParameter

addQueryParameter(pName, pValue): SoapConfig

Adds a query parameter.

Parameters

pName

string | number | boolean

the name of the parameter

pValue

string | number | boolean

the value of the parameter

Returns

SoapConfig

RestConfig

---

addQueryParameters

addQueryParameters(pName, pValues): SoapConfig

Adds a query parameter.

Parameters

pName

string | number | boolean

the name of the parameter

pValues

string[]

the values of the parameter

Returns

SoapConfig

RestConfig

---

connectionTimeoutInMillis

connectionTimeoutInMillis(pValue): SoapConfig

The timeout in milliseconds when connecting.

Parameters

pValue

number

the value

Returns

SoapConfig

SoapConfig

---

getAction

getAction(): string

Returns the action (function name).

Returns

string

the action

---

getConnectionTimeoutInMillis

getConnectionTimeoutInMillis(): number

Returns the timeout in milliseconds when reading.

Returns

number

the timeout value

---

getHeaders

getHeaders(): Map<string, string[]>

Returns the headers.

Returns

Map<string, string[]>

the headers

---

getQueryParameters

getQueryParameters(): Map<string, string[]>

Returns the query parameters.

Note: Curly braces in parameter values (e.g. {value}) may be interpreted as URI templates by underlying JDK implementations (see UriBuilder.queryParam(String, Object...)).

If raw values are needed, ensure they are properly escaped before being added.

Returns

Map<string, string[]>

the parameters

---

getReadTimeoutInMillis

getReadTimeoutInMillis(): number

Returns the timeout in milliseconds when reading.

Returns

number

the timeout value

---

getUrl

getUrl(): string

Return the URL of the webservice request.

Returns

string

the URL

---

getXml

getXml(): string

Returns the xml payload.

Returns

string

xml as String

---

readTimeoutInMillis

readTimeoutInMillis(pValue): SoapConfig

The timeout in milliseconds when reading.

Parameters

pValue

number

the value

Returns

SoapConfig

SoapConfig

---

url

url(pUrl): SoapConfig

The URL to be called in the webservice request.

Parameters

pUrl

string | number | boolean

the URL

Returns

SoapConfig

SoapConfig

---

xml

xml(pXml): SoapConfig

The xml representing the request as String.

Parameters

pXml

string | number | boolean

the xml

Returns

SoapConfig

SoapConfig