SOAP_CALLIN_PRE

Operation that is called before activating a requested web service operation.

operation SOAP_CALLIN_PRE
params
  string Envelope: INOUT ; or IN
  string ServVars: IN
endparams

Your Code here ...

end; operation SOAP_CALLIN_PRE

Parameters

  • Envelope—content of the SOAP envelope.
  • ServVars—server variables; optional

Return Values

Value Meaning
0

>1

Operation succeeded and processing can continue. The Envelope parameter contains a valid SOAP envelope that Uniface can successfully parse and understand.

1 Fast track response. No web service is actually called, no further callbacks, pre or post, are called and the returned envelope is treated as the response.
<0 Operation failed to successfully process the SOAP envelope. A SOAP fault is returned in an HTTP status 500 message, and the call-in procedure stops.

For more information, see SOAP Faults.

Description

You can implement the SOAP_CALLIN_PRE operation in the web service itself or in a separate Uniface service. It is only called if the service is specified by the $SOAP_CALLIN_CB setting in the assignment file of the Uniface Server handling SOAP requests (by default the wasv.asn file).

If you are only using SOAP_CALLIN_PRE to validate the incoming SOAP envelope, you can specify the first parameter as an IN parameter instead of an INOUT parameter.

If you have no need for server variables, you can omit the second parameter.

The names of the parameters are optional. Any other change to the interface, such as additional parameters or a different operation name, cause the operation to fail.

For information on generating SOAP faults when an error is detected, see SOAP Faults in Web Services Call-In.