NonStop SOAP User's Manual

Customizing the SOAP Server
NonStop SOAP User’s Manual—520501-012
8-15
class ServiceEnv
•
This method provides a valid request HeaderManager object during any of the
user-exit methods.
•
Memory allocation is not necessary for the HeaderManager object. The NonStop
SOAP server code cleans up this object during execution.
getRespHeaderMgr()
•
Returns the UESoapHeaderManager object that represents the SOAP headers to
be put in the SOAP response message. You should use this object to set SOAP
headers in the SOAP response.
•
The input value is none.
•
The output value is a pointer to a UESoapHeaderManager object.
•
Memory allocation is not necessary for the UESoapHeaderManager object. The
NonStop SOAP Server cleans up this object during execution.
setRespHeaderMgr()
•
Sets the HeaderManager which should be used by the NonStop SOAP server
while creating the response SOAP message. The output bool value indicates
whether the operation was successful. A true return value indicates a successful
method call and a false return value indicates a problem with the input parameter.
•
The input value is a pointer to a UESoapHeaderManager object.
•
The output value is bool.
•
The NonStop SOAP server uses the SOAP headers set in the HeaderManager to
create the SOAP response message's SOAP header elements.
•
To provide custom SOAP headers in the response SOAP message this method
must be called during or before the execution of the pre_marshal_header(…)
user-exit method. .
void skipParse(bool bSkip=true)
•
Indicates to the SOAP server not to parse and unmarshal the SOAP message.
This should be called in the pre_process() method of the user supplied user-
exit handler. You can then implement the pre_service() user-exit method and
populate the DDL buffer that is sent to the TS/MP server class.
void skipService(bool bSkip=true)
•
Indicates to the SOAP server to skip its service() method (where the SOAP
server performs a Pathsend to the TS/MP service). This is useful in these cases:
•
When it is determined in the user-exit (most likely based on the information in
the SOAP message), and/or some other conditions on the system that the call
to the TS/MP server class should not be made.
Note. If the user creates a response HeaderManager object then the user needs to
explicitly delete the object to avoid a memory leak.