Home > Class Reference > ENSLIB namespace > EnsLib.ebXML.Operation.SOAPOperation

EnsLib.ebXML.Operation.SOAPOperation

class EnsLib.ebXML.Operation.SOAPOperation extends Ens.BusinessOperation, EnsLib.ebXML.Operation.AbstractOperationDelegate

ebXML outbound SOAP operation

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter ADAPTER = EnsLib.SOAP.OutboundAdapter;
Inherited description: The type of adapter used to communicate with external systems
parameter INVOCATION = Queue;
Inherited description: 2 modes: Queue, InProc
parameter OPERATIONDELEGATE = EnsLib.ebXML.Operation.AbstractOperationDelegate;
parameter SETTINGS = CustomSOAPAction,OperationDelegateClass,MessageTypeClass,MessageWithPayloadTypeClass,ValidateManifest,Allow202WithContent,HandleErrorListAsFatal,-WebServiceClientClass;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names
parameter WEBSERVICECLIENTCLASS = EnsLib.ebXML.Operation.SOAPServiceClient;
Web services client class

Properties (Including Private)

property Allow202WithContent as %Boolean [ InitialExpression = 1 ];
Allow HTTP 202 response to have content (note: this is non-standard)
Property methods: Allow202WithContentDisplayToLogical(), Allow202WithContentGet(), Allow202WithContentIsValid(), Allow202WithContentLogicalToDisplay(), Allow202WithContentNormalize(), Allow202WithContentSet()
property CustomSOAPAction as %String (MAXLEN = 512);
Custom SOAPAction header (defaults to ebXML)
Property methods: CustomSOAPActionDisplayToLogical(), CustomSOAPActionGet(), CustomSOAPActionIsValid(), CustomSOAPActionLogicalToDisplay(), CustomSOAPActionLogicalToOdbc(), CustomSOAPActionNormalize(), CustomSOAPActionSet()
property HandleErrorListAsFatal as %Boolean [ InitialExpression = 1 ];
Flag to convert an ebXML ErrorList into a %Status
Property methods: HandleErrorListAsFatalDisplayToLogical(), HandleErrorListAsFatalGet(), HandleErrorListAsFatalIsValid(), HandleErrorListAsFatalLogicalToDisplay(), HandleErrorListAsFatalNormalize(), HandleErrorListAsFatalSet()
property MessageTypeClass as Ens.DataType.Class (EXTENDS = "EnsLib.ebXML.Message") [ InitialExpression = "EnsLib.ebXML.Message" , Required ];
Default ebXML message type
Property methods: MessageTypeClassDisplayToLogical(), MessageTypeClassGet(), MessageTypeClassIsValid(), MessageTypeClassLogicalToDisplay(), MessageTypeClassLogicalToOdbc(), MessageTypeClassNormalize(), MessageTypeClassSet()
property MessageWithPayloadTypeClass as Ens.DataType.Class (EXTENDS = "EnsLib.ebXML.MessageWithPayload") [ InitialExpression = "EnsLib.ebXML.MessageWithPayload" , Required ];
Default ebXML message type
Property methods: MessageWithPayloadTypeClassDisplayToLogical(), MessageWithPayloadTypeClassGet(), MessageWithPayloadTypeClassIsValid(), MessageWithPayloadTypeClassLogicalToDisplay(), MessageWithPayloadTypeClassLogicalToOdbc(), MessageWithPayloadTypeClassNormalize(), MessageWithPayloadTypeClassSet()
property OperationDelegate as EnsLib.ebXML.Operation.AbstractOperationDelegate [ InitialExpression = $this ];
Property methods: OperationDelegateClassDisplayToLogical(), OperationDelegateClassGet(), OperationDelegateClassIsValid(), OperationDelegateClassLogicalToDisplay(), OperationDelegateClassLogicalToOdbc(), OperationDelegateClassNormalize(), OperationDelegateClassSet(), OperationDelegateGet(), OperationDelegateGetSwizzled(), OperationDelegateIsValid(), OperationDelegateNewObject(), OperationDelegateSet()
property OperationDelegateClass as Ens.DataType.Class (EXTENDS = "EnsLib.ebXML.Operation.AbstractOperationDelegate");
Name of a class that implements the EnsLib.ebXML.Operation.AbstractOperationDelegate interface that we can call to do routing
Property methods: OperationDelegateClassDisplayToLogical(), OperationDelegateClassGet(), OperationDelegateClassIsValid(), OperationDelegateClassLogicalToDisplay(), OperationDelegateClassLogicalToOdbc(), OperationDelegateClassNormalize(), OperationDelegateClassSet()
property ValidateManifest as %Boolean [ InitialExpression = 0 ];
Flag to enable validation of the Manifest for messages with payload
Property methods: ValidateManifestDisplayToLogical(), ValidateManifestGet(), ValidateManifestIsValid(), ValidateManifestLogicalToDisplay(), ValidateManifestNormalize(), ValidateManifestSet()

Methods (Including Private)

method %OnNew(pConfigName As %RegisteredObject) as %Status
Because we implement a delegate, we must "fix" %OnNew otherwise, we get the implementation from Ens.AbstractDelegate and not the one from Ens.Host which is required.
method CreateNewMessage() as EnsLib.ebXML.Message
Construct a new instance of an ebXML message (no payload)
method CreateNewMessageWithPayload() as EnsLib.ebXML.MessageWithPayload
Construct a new instance of an ebXML message with payload
method OnInit() as %Status
This user callback method is called just after %OnNew()
method ProcessTargetMHSResponse(pSender As %RegisteredObject, pRequest As EnsLib.ebXML.Message, ByRef pResponse As EnsLib.ebXML.Message) as %Status
Default implemention of the response processing
method RouteMessageToTargetMHS(pSender As %RegisteredObject, ByRef pRequest As EnsLib.ebXML.Message, ByRef pTargetUrl As %String, ByRef pSOAPAction As %String) as %Status
Default implementation for the routing delegate
method SendMessage(pRequest As EnsLib.ebXML.Message, ByRef pResponse As EnsLib.ebXML.Message) as %Status
Send an ebXML message to a remote MHS via an HTTP POST operation (note that since ebXML messages are packaged in a SOAP wrapper, this will look like a web service request, although it's technically not). Depending on the presence of a SyncReply SOAP header, we may get a response from the remote MHS, or just nothing.

Inherited Members

Inherited Properties (Including Private)