Class EnsLib.HTTP.GenericOperation

class EnsLib.HTTP.GenericOperation extends Ens.BusinessOperation

Forwards contents of an HTTP request to a remote HTTP service and sends the HTTP response as its reply message

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
2	5	4

Summary

This is a Business Operation class.

The associated Adapter class is EnsLib.HTTP.OutboundAdapter.

Request	Response
EnsLib.HTTP.GenericMessage	EnsLib.HTTP.GenericMessage

Properties
%AlertStartTime	%ConfigName	%ConfigQueueName	%ExcludeOutboundHeaders
%LastActionTime	%LastHandledTime	%LastReportedError	%QuitTask
%RequestHeader	%SessionId	%SuperSession	%WarnedLatest
%isShadow	Adapter	AlertGroups	AlertOnError
AlertRetryGracePeriod	ArchiveIO	BusinessPartner	DeferResponse
FailureTimeout	IOLogEntry	InactivityTimeout	NoFailWhileDisconnected
QueueCountAlert	QueueWaitAlert	ReadRawMode	ReplyCodeActions
Retry	RetryCount	RetryInterval	SOAPPrefix
SendSuperSession	SuspendMessage	ThrottleDelay	WriteRawMode

Methods
%AddToSaveSet	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends
%GetParameter	%IsA	%IsModified	%New
%NormalizeObject	%ObjectModified	%OnClose	%OnNew
%OriginalNamespace	%PackageName	%RemoveFromSaveSet	%SerializeObject
%SetModified	%SuperSessionSet	%ValidateObject	AdapterName
AssignOneSetting	CloseIOLogEntry	DeferResponse	EnumerateSettingsClose
EnumerateSettingsExecute	EnumerateSettingsFetch	GenerateSuperSession	GetDeferredResponseToken
GetMessageList	GetMsgHdrRequestKey	GetProductionSettingValue	GetProductionSettings
GetPropertyConnections	GetSettings	GetShadowInstance	IncludeSuperSession
NewIOLogEntry	OnError	OnFailureTimeout	OnGenerateSuperSession
OnGetConnections	OnGetReplyAction	OnInit	OnKeepalive
OnMessage	OnMonitor	OnProductionStart	OnProductionStop
OnTearDown	QueueName	SaveIOLogEntry	SendAlert
SendDeferredResponse	SendRequestAsync	SendRequestSync

Subclasses
EnsLib.HTTP.GenericOperationInProc	EnsLib.REST.GenericOperation

Parameters

• parameter ADAPTER = "EnsLib.HTTP.OutboundAdapter";

The type of adapter used to communicate with external systems

• parameter SETTINGS = "ReadRawMode,WriteRawMode";

List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

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

Comma separated list of HTTP Headers associated with the message request sent to the business operation that are not to be passed to the external system. The values are case-insensitive. The appropriate Content-Length, Content-Type, Host and SOAPAction will be sent and ought not be specified here.

• property ReadRawMode as %Boolean [ InitialExpression = 1 ];

Read Raw Mode
If true (the default) then the body of the response will be read in using RAW mode
i.e., with no characterset translation. If false then it will use the charset specified
in the response headers. This uses the ReadRawMode property of the HTTP request object
Uncheck to not use Read Raw Mode

• property SOAPPrefix as %String [ InitialExpression = "SOAP-ENV" ];

Prefix to be used for the SOAP Envelope namespace if envelope elements must be constructed

• property WriteRawMode as %Boolean [ InitialExpression = 0 ];

Write Raw Mode
If true then the body of the request will be written using RAW mode
i.e., with no characterset translation. If false (the default) then it will use the charset specified
in the request headers. This uses the WriteRawMode property of the HTTP request object
Check to use Write Raw Mode

Methods

• method OnInit() as %Status

This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()

• method OnMessage(pRequest As EnsLib.HTTP.GenericMessage, Output pResponse As EnsLib.HTTP.GenericMessage) as %Status

Invoke a remote HTTP Service given a generic HTTP request

Class Reference IRIS for UNIX 2024.1.2
Documentation Search