Home > Class Reference > ENSLIB namespace > EnsLib.HTTP.GenericOperation

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

parameter ADAPTER = EnsLib.HTTP.OutboundAdapter;
Inherited description: The type of adapter used to communicate with external systems
parameter SETTINGS = ReadRawMode,WriteRawMode;
Inherited description: 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 methods: %ExcludeOutboundHeadersDisplayToLogical(), %ExcludeOutboundHeadersGet(), %ExcludeOutboundHeadersIsValid(), %ExcludeOutboundHeadersLogicalToDisplay(), %ExcludeOutboundHeadersLogicalToOdbc(), %ExcludeOutboundHeadersNormalize(), %ExcludeOutboundHeadersSet()
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
ie. 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 methods: ReadRawModeDisplayToLogical(), ReadRawModeGet(), ReadRawModeIsValid(), ReadRawModeLogicalToDisplay(), ReadRawModeNormalize(), ReadRawModeSet()
property SOAPPrefix as %String [ InitialExpression = "SOAP-ENV" ];
Prefix to be used for the SOAP Envelope namespace if envelope elements must be constructed
Property methods: SOAPPrefixDisplayToLogical(), SOAPPrefixGet(), SOAPPrefixIsValid(), SOAPPrefixLogicalToDisplay(), SOAPPrefixLogicalToOdbc(), SOAPPrefixNormalize(), SOAPPrefixSet()
property WriteRawMode as %Boolean [ InitialExpression = 0 ];
Write Raw Mode
If true then the body of the request will be written using RAW mode
ie. 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
Property methods: WriteRawModeDisplayToLogical(), WriteRawModeGet(), WriteRawModeIsValid(), WriteRawModeLogicalToDisplay(), WriteRawModeNormalize(), WriteRawModeSet()

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

Inherited Methods

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

Subclasses

EnsLib.HTTP.GenericOperationInProc EnsLib.REST.GenericOperation