MANUAL (RPGLE)

Web Service: PortName_operation()
Details ....

Copybooks  

QWSDL2RPG,TYPES_H
QWSDL2RPG,PWSDL2R90 WSDL2RPG: AppMsg
QWSDL2RPG,PWSDL2R94 WSDL2RPG: MultiRef
QWSDL2RPG,PWSDL2R97 WSDL2RPG: eXpat Adapter
QWSDL2RPG,PWSDL2R98 WSDL2RPG: UnMarshaller/Marshaller
QWSDL2RPG,PWSDL2R42 WSDL2RPG: User name and password
QWSDL2RPG,CLIB C Runtime Library
QBASICS1,PBASICS1 Tools/400 Runtime Library
QMIME,PMIME Tools/400 MIME Parser
QMIME,HTTPMIME_H Tools/400 MIME Parser to HTTP API adapter
QRPGLESRC,HTTPAPI_H HTTP-API Service Program
QWSDL2RPG,PWSDL2R70 WSDL2RPG: HTTP API Header Extensions
QWSDL2RPG,PWSDL2R86 WSDL2RPG: Stream
QWSDL2RPG,PWSDL2R87 WSDL2RPG: ManagedMemoryDataSource
QWSDL2RPG,PWSDL2R89 WSDL2RPG: List of attachments

Procedures  

HTTPDataSink_bodyData
Receives the body data of a MIME part.
HTTPDataSink_endPart
Ends a MIME body part.
HTTPDataSink_startPart
Starts a MIME body part.
HTTP_receiveResponse
HTTP_setContentTypeAndSOAPAction
PortName_Attachments_getexported
Returns the file name of a given content ID.
PortName_Attachments_getAtPosexported
Returns the attachment of a specified index.
PortName_Attachments_getNumEexported
Returns the number of attachments.
PortName_Attachments_removeAllexported
removes all attachments.
PortName_enableAxis2095
PortName_getEndpointexported
Returns the endpoint of the web service.
PortName_getHostexported
Returns the host name of the web service.
PortName_getPortexported
Returns the port number of the web service.
PortName_HttpError_getCodeexported
Returns the HTTP error code.
PortName_HttpError_getTextexported
Returns the HTTP error text.
PortName_isErrorexported
Returns TRUE if the last call to the web service ended in error.
PortName_operationexported
Web Service Operation
PortName_registerLoginCallbackexported
Register login callback procedure.
PortName_setAttachmentFolderexported
Specifies the attachment folder to use.
PortName_setEndpointexported
Sets the name of the endpoint of the web service.
PortName_setHostexported
Sets the host name of the web service.
PortName_setHttpDebugexported
Turns debugging info *ON or *OFF.
PortName_setPortexported
Sets the port number of the web service.
PortName_setProxyexported
Specifies the proxy server.
PortName_SoapError_getCodeexported
Returns the SOAP error code.
PortName_SoapError_getTextexported
Returns the SOAP error text.
PortName_XmlError_getCodeexported
Returns the XML parser error code.
PortName_XmlError_getTextexported
Returns the XML parser error text.
SOAPMessage_Envelope
SOAPMessage_FaultDetailEnd
SOAPMessage_FaultDetailStart
SOAPMessage_FaultEnd
SOAPMessage_FaultStart
SOAPMessage_NULLEnd
SOAPMessage_NULLStart
tns_response_of_stringEnd
tns_response_of_stringStart

Detailed Description  

This module is the web service stub of the web service operation: PortName_operation()
Author:
WSDL2RPG V1.10 beta 5 / 16.12.2009
Date:
Dec 18, 2009 (11:48:35)

Procedure Documentation  

HTTPDataSink_bodyData  

HTTPDataSink_bodyData(pointer, pointer, pointer, integer)
This procedure is called by the WSDL2RPG runtime whenever body data of a MIME part needs to be processed.

You may use this procedure to append the body data to a file.

Parameter:
pointer   constHandle of the current part.
pointer   constPointer to user data as specified at http_mime_DataSink_initialize().
pointer   constPointer to decoded body data.
numeric (integer) (10)   constSize of decoded body data.
Return value:
void

HTTPDataSink_endPart  

HTTPDataSink_endPart(pointer, pointer)
This procedure is called by the WSDL2RPG runtime whenever a MIME part ends.

You may use this procedure to close a the file you may have opened in HTTPDataSink_startPart().

Parameter:
pointer   constHandle of the current part.
pointer   constPointer to user data as specified at http_mime_DataSink_initialize().
Return value:
void

HTTPDataSink_startPart  

HTTPDataSink_startPart(pointer, pointer)
This procedure is called by the WSDL2RPG runtime whenever a MIME part is started.

You may use this procedure to create or open a file to receive the data. In order to keep track of the open file you may create a data structure to store the file handle. Then call http_mime_Part_setUserData() to associate that data structure with the current part.

Use http_mime_Part_getUserData() from within HTTPDataSink_bodyData() and and HTTPDataSink_endPart() to get access to that data structure.

Parameter:
pointer   constHandle of the current part.
pointer   constPointer to user data as specified at http_mime_DataSink_initialize().
Return value:
void

HTTP_receiveResponse  

voidHTTP_receiveResponse()

HTTP_setContentTypeAndSOAPAction  

voidHTTP_setContentTypeAndSOAPAction()

PortName_Attachments_get  

wsdl_path_tPortName_Attachments_get()
Returns the file name of the attachment that is associated to a given content ID.
Parameter:
Content ID.
Return value:
wsdl_path_tPath name
Exported.

PortName_Attachments_getAtPos  

wsdl_attachment_tPortName_Attachments_getAtPos(integer)
Returns the attachment of the specified index.
Parameter:
numeric (integer) (10)   constIndex
Return value:
wsdl_attachment_tStructure: attachment
Exported.

PortName_Attachments_getNumE  

integerPortName_Attachments_getNumE()
Returns the number of attachments that were downloaded with the last call of the web service.
Return value:
numeric (integer) (10)Number of attachments
Exported.

PortName_Attachments_removeAll  

PortName_Attachments_removeAll()
Removes all attachments from the list of attachments of this web service.
Return value:
void
Exported.

PortName_enableAxis2095  

voidPortName_enableAxis2095()

PortName_getEndpoint  

characterPortName_getEndpoint()
Returns the endpoint of the web service.
Return value:
character (32767)URL of the endpoint of the web service
Exported.

PortName_getHost  

characterPortName_getHost()
Returns the host name of the web service. The host name of the web service is part of the URL of the endpoint of the web service.
Return value:
character (32767)Host name
Exported.

PortName_getPort  

integerPortName_getPort()
Returns the port number of the web service. The port number of the web service is part of the URL of the endpoint of the web service.
Return value:
numeric (integer) (10)Port number
Exported.

PortName_HttpError_getCode  

wsdl_http_ErrorNo_tPortName_HttpError_getCode()
Returns the HTTP error code in case the web service ended in error.
Return value:
wsdl_http_ErrorNo_tHTTP error code
Exported.

PortName_HttpError_getText  

wsdl_http_ErrorText_tPortName_HttpError_getText()
Returns the HTTP error text in case the web service ended in error.
Return value:
wsdl_http_ErrorText_tHTTP error text
Exported.

PortName_isError  

booleanPortName_isError()
Returns TRUE if the last call to the web service ended in error, else FALSE. Use this procedure to check for an error after you called the web service.

Errors may occur at different level:

HTTP errors
SOAP errors
eXpat errors

Return value:
booleanError indicator. TRUE in case of an error, else FALSE.
Exported.

PortName_operation  

tns_response_tPortName_operation(character)
Operation to be called by RPG to consume the web service.
Parameter:
  constWeb Service input message data
character (128)   varyingOutput error message
Return value:
tns_response_tWeb service response message data
Exported.

PortName_registerLoginCallback  

PortName_registerLoginCallback(pointer)
Registers a user supplied callback procedure to provide login credentials whenever a server requires user authentication.

Procedure prototype of callback procedure:

D PortName_supplyLoginData...
D PR 10I 0
D extproc('+
D PortName+
D _supplyLoginData+
D ')
D i_authType 14A const varying
D i_realm 126A const varying
D i_numAttempts 10I 0 const
D o_user 50A varying
D o_password 50A varying

Parameter:
pointer   valueProcedure pointer of callback procedure.
Return value:
void
Exported.

PortName_setAttachmentFolder  

PortName_setAttachmentFolder(character)
Specifies the name of the folder where to put attachments in.
Parameter:
character (1024)   const   variable size   varyingFolder for attachments
Return value:
void
Exported.

PortName_setEndpoint  

PortName_setEndpoint(character)
Sets the name of the endpoint of the web service. Usually there is no need for changing the URL of the endpoint since the WSDL file should specify the right endpoint.
Parameter:
character (32767)   const   variable size   varyingURL of the endpoint of the web service
Return value:
void
Exported.

PortName_setHost  

PortName_setHost(character)
Sets the host name of the web service. The host name of the web service is part of the URL of the endpoint of the web service. Usually there is no need for changing the host name of the web service since the WSDL file should specify the right host name.
Parameter:
character (32767)   const   variable size   varyingHost name
Return value:
void
Exported.

PortName_setHttpDebug  

PortName_setHttpDebug(boolean, character)
If status is set to TRUE, debugging information is turned on, else it is turned off.
Parameter:
boolean   constStatus, either TRUE or FALSE.
character (500)   const   varying   optionalFile name
Return value:
void
Exported.

PortName_setPort  

PortName_setPort(integer)
Sets the port number of the web service. The port number of the web service is part of the URL of the endpoint of the web service. Usually there is no need for changing the port number of the web service since the WSDL file should specify the right port number.
Parameter:
numeric (integer) (10)   constPort number
Return value:
void
Exported.

PortName_setProxy  

PortName_setProxy(character, integer)
Specifies the proxy server and port address that is used to connect to the Internet.
Parameter:
character (256)   constHost name
numeric (integer) (10)   constPort number
Return value:
void
Exported.

PortName_SoapError_getCode  

wsdl_soap_faultcode_tPortName_SoapError_getCode()
Returns the SOAP error code in case the web service ended in error.
Return value:
wsdl_soap_faultcode_tSOAP error code
Exported.

PortName_SoapError_getText  

wsdl_soap_faultstring_tPortName_SoapError_getText()
Returns the SOAP error text in case the web service ended in error.
Return value:
wsdl_soap_faultstring_tSOAP error text
Exported.

PortName_XmlError_getCode  

wsdl_xml_ErrorNo_tPortName_XmlError_getCode()
Returns the XML parser error code in case the web service ended in error.
Return value:
wsdl_xml_ErrorNo_tXML parser error code
Exported.

PortName_XmlError_getText  

wsdl_xml_ErrorText_tPortName_XmlError_getText()
Returns the XML parser error text in case the web service ended in error.
Return value:
wsdl_xml_ErrorText_tXML parser error text
Exported.

SOAPMessage_Envelope  

voidSOAPMessage_Envelope()

SOAPMessage_FaultDetailEnd  

voidSOAPMessage_FaultDetailEnd()

SOAPMessage_FaultDetailStart  

voidSOAPMessage_FaultDetailStart()

SOAPMessage_FaultEnd  

voidSOAPMessage_FaultEnd()

SOAPMessage_FaultStart  

voidSOAPMessage_FaultStart()

SOAPMessage_NULLEnd  

voidSOAPMessage_NULLEnd()

SOAPMessage_NULLStart  

voidSOAPMessage_NULLStart()

tns_response_of_stringEnd  

voidtns_response_of_stringEnd()

tns_response_of_stringStart  

voidtns_response_of_stringStart()