Class EnsLib.SOAP.CST.OutboundAdapter

class EnsLib.SOAP.CST.OutboundAdapter extends EnsLib.TCP.OutboundAdapter, EnsLib.SOAP.CST.Common

An adapter for sending requests to a simple one-object-in, one-object-out service using the CST-over-HTTP protocol that is supported by the EnsLib.SOAP.InboundAdapter.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	10	8

Summary

Properties
%CredentialsObj	%WarnedLatest	%lastRetryReconnect	%logConnections
BusinessHost	ConnectTimeout	Connected	Credentials
Device	GetReply	IOAddr	IPAddress
KeepaliveInterval	LocalInterface	Location	OldIO
Port	ProxyHTTPS	ProxyPort	ProxyServer
ReadTimeout	ReconnectRetry	RegistryID	ResponseTimeout
SSLConfig	Socket	StayConnected	Terminators

Methods
%AddToSaveSet	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends
%GetParameter	%IsA	%IsModified	%New
%NormalizeObject	%ObjectModified	%OriginalNamespace	%PackageName
%RemoveFromSaveSet	%SerializeObject	%SetModified	%ValidateObject
AssignOneSetting	ClearAllAppData	ClearRuntimeAppData	ClearStaticAppData
Connect	ConnectedSet	CredentialsSet	Disconnect
EnumerateSettingsClose	EnumerateSettingsExecute	EnumerateSettingsFetch	FlushWrite
GetAddress	GetSettings	IPAddressSet	Invoke
IsReadError	IsWriteError	LocationSet	OnInit
OnKeepalive	OnTearDown	PortSet	ProxyHTTPSSet
ProxyPortSet	ProxyServerSet	TestConnection	exportCST
getSignature	importCST	initIPPort	readObj
readProp	readStream	readString	writeObj
writeProp	writeStream	writeString

Parameters

• parameter SETTINGS = "Location,ProxyServer,ProxyPort,ProxyHTTPS";

These are the production settings for this object

Properties

• property Credentials as %String;

This is the ID name of the set of credentials values (Username, Password) to be used to access the external SOAP/CST server

• property Location as %String(MAXLEN=1000);

Location URL path to request from the server (optionally including 'http://' and server ip:port address; values here override IPAddress and Port settings); default is LOCATION parameter of BusinessOperation if any

• property ProxyHTTPS as %Boolean;

Should the proxy (if any) use HTTPS to communicate with the real HTTP/HTTPS server?

• property ProxyPort as %Integer(MAXVAL=65535,MINVAL=0) [ InitialExpression = 80 ];

Proxy server port on which to send HTTP requests, if using a proxy server

• property ProxyServer as %String(MAXLEN=1000);

Proxy server through which to send HTTP requests, if any

• property ResponseTimeout as %Numeric(MINVAL=0) [ InitialExpression = 30 ];

Timeout for getting a response from the server (the timeout for opening the connection to the server is always 5 seconds). Setting the timeout to -1 means wait forever.

• property Terminators as %String [ InitialExpression = $C(10) ];

Read-terminator character or characters, if any, for subclasses that do terminated reads.

Methods

• method IPAddressSet(pInVal As %String) as %Status

This is a Set accessor method for the IPAddress property.

• method Invoke(pMethodname As %String, pRequestType As %String, pResponseType As %String, pRequest As %RegisteredObject, Output pResponse As %RegisteredObject) as %Status

• method LocationSet(pInVal As %String) as %Status

This is a Set accessor method for the Location property.

• method PortSet(pInVal As %String) as %Status

This is a Set accessor method for the Port property.

• method ProxyHTTPSSet(pInVal As %Boolean) as %Status

This is a Set accessor method for the ProxyHTTPS property.

• method ProxyPortSet(pInVal As %String) as %Status

This is a Set accessor method for the ProxyPort property.

• method ProxyServerSet(pInVal As %String) as %Status

This is a Set accessor method for the ProxyServer property.

• method initIPPort(pInVal As %String) as %Status

Set up IPAddress and Port overrides for Location and Proxy settings

Class Reference IRIS for UNIX 2024.1.2
Documentation Search