Home > Class Reference > ENSLIB namespace > %SOAP.WebClient


abstract class %SOAP.WebClient extends %SOAP.WebBase

SOAP Web Client class.
Properties of this class that begin with Http are passed through to the %Net.HttpRequest instance used by the class. The only supported use of this class is as the super class for a SOAP Web Client. Parameters, properties and methods may be used by the application.

Property Inventory (Including Private)

Method Inventory (Including Private)


If the web client has the parameter SOAPACTIONQUOTED=1, then the web client will quote the SOAPAction value for SOAP 1.1. The default will be SOAPACTIONQUOTED=0 in order to be compatible with earlier versions of Cache.
Default charset for remote SOAP binary server. This parameter is by default used to dertermine if binary message needs to be UTF8 encoded.
parameter SOAPVERSION;
The SOAPVERSION parameter specified the version of SOAP which is supported. Possible values for the version are 1.1 and 1.2. The default value "" specifies that both SOAP 1.1 and SOAP 1.2 are supported.

Properties (Including Private)

property ContentType as %String [ Transient ];
Content-Type to be used for transport class
Property methods: ContentTypeDisplayToLogical(), ContentTypeGet(), ContentTypeIsValid(), ContentTypeLogicalToDisplay(), ContentTypeLogicalToOdbc(), ContentTypeNormalize(), ContentTypeSet()
property GzipOutput as %Boolean [ InitialExpression = ..#GZIPOUTPUT , Transient ];
If the GzipOutput property is set to true (1), then the output request will be compressed using GZIP. The default value for GzipOutput is the GZIPOUTPUT parameter.
Property methods: GzipOutputDisplayToLogical(), GzipOutputGet(), GzipOutputIsValid(), GzipOutputLogicalToDisplay(), GzipOutputNormalize(), GzipOutputSet()
property HTTPVersion as %String [ InitialExpression = "1.1" , Transient ];
The HTTP version we should report to the server when making the request. Defaults to '1.1'.
Property methods: HTTPVersionDisplayToLogical(), HTTPVersionGet(), HTTPVersionIsValid(), HTTPVersionLogicalToDisplay(), HTTPVersionLogicalToOdbc(), HTTPVersionNormalize(), HTTPVersionSet()
property HttpAccept202 as %Boolean [ Transient ];
If HttpAccept202=0 (default) we follow the WS-I Basic Profile which calls for HTTP response status 202 to be used only if no SOAP envelope is in the HTTP response and return an error if no envelope.
If HttpAccept202=1, HTTP status 202 will treated just the same as HTTP status 200. The HttpResponse.StatusCode property may be checked to see if 202 was actually returned.
Property methods: HttpAccept202DisplayToLogical(), HttpAccept202Get(), HttpAccept202IsValid(), HttpAccept202LogicalToDisplay(), HttpAccept202Normalize(), HttpAccept202Set()
property HttpFollowRedirect as %Boolean [ Transient ];
If true then automatically follow redirection requests from the web server. These are signaled by the HTTP status codes of the form 3xx. The default is false.
Property methods: HttpFollowRedirectDisplayToLogical(), HttpFollowRedirectGet(), HttpFollowRedirectIsValid(), HttpFollowRedirectLogicalToDisplay(), HttpFollowRedirectNormalize(), HttpFollowRedirectSet()
property HttpHeaders as %String [ Private , MultiDimensional , Transient ];
Internal structure used to store the collection of headers for %Net.HttpRequest.
Property methods: HttpHeadersDisplayToLogical(), HttpHeadersGet(), HttpHeadersIsValid(), HttpHeadersLogicalToDisplay(), HttpHeadersLogicalToOdbc(), HttpHeadersNormalize(), HttpHeadersSet()
property HttpInitiateAuthentication as %String [ Transient ];
A client may initiate a connection to the server with an "Authorization" header containing the initial token for the server for a chosen authentication scheme. %Net.HttpRequest is asked to initiate the connection by setting the InitiateAuthentication property to a string which is a single scheme name. This form will bypass the initial 401 error from the server when the client knows that the server will accept the specified scheme. Supported schemes are Negotiate, Kerberos, NTLM and Basic.
Property methods: HttpInitiateAuthenticationDisplayToLogical(), HttpInitiateAuthenticationGet(), HttpInitiateAuthenticationIsValid(), HttpInitiateAuthenticationLogicalToDisplay(), HttpInitiateAuthenticationLogicalToOdbc(), HttpInitiateAuthenticationNormalize(), HttpInitiateAuthenticationSet()
property HttpPassword as %String [ Transient ];
If the Username and Password are defined then this information will be sent using Basic authentication to the web server. If you manually set the Authorization header this property will be ignored.
Property methods: HttpPasswordDisplayToLogical(), HttpPasswordGet(), HttpPasswordIsValid(), HttpPasswordLogicalToDisplay(), HttpPasswordLogicalToOdbc(), HttpPasswordNormalize(), HttpPasswordSet()
property HttpProxyAuthorization as %String [ Transient ];
Sets/get the 'Proxy-Authorization:' header field in the Http request.

A user agent that wishes to authenticate itself with a proxy-- usually, but not necessarily, after receiving a 407 response--may do so by including an Proxy-Authorization header field with the request. The Proxy-Authorization field value consists of credentials containing the authentication information of the user agent for the realm of the resource being requested.

Property methods: HttpProxyAuthorizationDisplayToLogical(), HttpProxyAuthorizationGet(), HttpProxyAuthorizationIsValid(), HttpProxyAuthorizationLogicalToDisplay(), HttpProxyAuthorizationLogicalToOdbc(), HttpProxyAuthorizationNormalize(), HttpProxyAuthorizationSet()
property HttpProxyHTTPS as %Boolean [ Transient ];
HttpProxyHTTPS property is ignored since the use of SSL to the end point is now determiend from the url. If using a proxy server and this is true then it issues a request for an https page rather than the normal http page. This allows a proxy server that support https to support a secure connection from this %Net.Httprequest class.
Property methods: HttpProxyHTTPSDisplayToLogical(), HttpProxyHTTPSGet(), HttpProxyHTTPSIsValid(), HttpProxyHTTPSLogicalToDisplay(), HttpProxyHTTPSNormalize(), HttpProxyHTTPSSet()
property HttpProxyPort as %String [ Transient ];
The port to connect to the proxy web server on. This is often port 8080 (the default).

You can specify a default proxy server for this namespace or for this Caché by setting ^SYS("HttpRequest","ProxyPort") or ^%SYS("HttpRequest","ProxyPort").

Property methods: HttpProxyPortDisplayToLogical(), HttpProxyPortGet(), HttpProxyPortIsValid(), HttpProxyPortLogicalToDisplay(), HttpProxyPortLogicalToOdbc(), HttpProxyPortNormalize(), HttpProxyPortSet()
property HttpProxySSLConnect as %Boolean [ Transient ];
SSL connection to the proxy server will be used if the HttpProxySSLConnect property = 1. Use of SSL to the eventual endpoint is determined by the protocol part of web service's location url.
Property methods: HttpProxySSLConnectDisplayToLogical(), HttpProxySSLConnectGet(), HttpProxySSLConnectIsValid(), HttpProxySSLConnectLogicalToDisplay(), HttpProxySSLConnectNormalize(), HttpProxySSLConnectSet()
property HttpProxyServer as %String [ Transient ];
If you need to make SOAP request through a proxy server you specify the proxy server host name in this property. If this property is defined then the http request will be directed at this machine and it will forward the request to the machine at Location and return the response.

You can specify a