J2EERun (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Parameters of procedure to run
Type of parameter
Call to J2EERun

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

J2EERun (Function)

In french: J2EEExécute

Runs a procedure on a server of J2EE XML Web services.

Note: The procedure parameters must be specified before using J2EERun via the J2EE structure (see the Notes).

Example

// This example is based on the presence of Text2Image Webservice
// on the dwdemos.alphaworks.ibm.com site.
// If the module was no longer available on the site,
// the example would not operate anymore
// Parameters to pass to the service
// Width of the image
J2EE.Value[1] = EDT_WIDTH
J2EE.Name[1] = "ImageWidth"
J2EE.Type[1] = J2EEIntType
...
// Interrogate the Webservice on the Web server
IF J2EERun(...
"http://dwdemos.alphaworks.ibm.com:8085/soap/servlet/rpcrouter", ...
"createImage", "urn:text2image", ...
"http://alphaworks.ibm.com/alphabeans/text2image/createImage/") THEN
// The result is an image, it will be changed into a temporary file
nFileID is int
nFileID = fOpen(fExeDir() + "\temp.gif", foCreate)
fWrite(nFileID, J2EEGetResult(J2EEResult))
fClose(nFileID)
// Display
IMG_GEN = ""
IMG_GEN = fExeDir() + "\temp.gif"
// Delete the temporary file
fDelete(IMG_GEN)
ELSE
// If the service returns no error (ex: Server not accessible)
IF J2EEError(J2EEErrMessage) ~= "" THEN
Error(ErrorInfo())
// If the service returned an error (service error)
ELSE
Error("J2EE error: " + J2EEError(J2EEErrMessage))
END
END

Syntax

<Result> = J2EERun(<Server URL> , <Procedure Name> [, <Procedure Namespace> [, <Procedure Action> [, <Encoding Style>]]])

<Result>: Boolean

True if the communication was established with the server,
False otherwise (no communication was established). To find out the error details, use ErrorInfo associated with the errMessage constant.

<Server URL>: Character string (with quotes)

URL of server to contact. This parameter is supplied in the documentation of server of J2EE XML Web services.

<Procedure Name>: Character string (with quotes)

Name of the procedure that will be run on the specified server. This parameter is supplied in the documentation of server of J2EE XML Web services.
Make sure to respect the case (lowercase/uppercase characters) in the name of the procedure.

<Procedure Namespace>: Optional character string (with quotes)

Namespace of procedure to run. This parameter is supplied in the documentation of server of J2EE XML Web services.

<Procedure Action>: Optional character string (with quotes)

Action of procedure (also called "J2EEAction"). This parameter is supplied in the documentation of server of J2EE XML Web services.

<Encoding Style>: Optional character string (with quotes)

Encoding style of procedure (also called "EncodingStyle"). This parameter is supplied in the documentation of server of J2EE XML Web services.

Remarks

Parameters of procedure to run

To pass parameters to a procedure run on a server of J2EE XML Web services, the following structure is used by WINDEV:

Variable	Type	Details

J2EE.NameSpace	Optional character string	"NameSpace" of parameter.
J2EE.Name	Character string	Name of parameter.
J2EE.XMLParam	Optional character string	Full description of parameter in XML format. The other parameters (Value, Name, Type, NameSpace and EncodingStyle) are ignored if this parameter is specified.
J2EE.EncodingStyle	Optional character string	Encoding style of parameter.
J2EE.Type	Constant	Type of parameter
J2EE.Value	Any type	Value of parameter.

This structure must be used for each parameter. For example:

J2EE.Value[1] = 94010
J2EE.Name[1] = "ZipCode"
J2EE.Type[1] = J2EEStringType

This structure is equivalent to:

J2EE.XMLParam[1] = <ZipCode xsi:type="xsd:string">94010</ZipCode>

Type of parameter

The type of parameter can be:

Constant	Type

J2EEBase64BinaryType	Binary
J2EEHexBinaryType	Hexadecimal binary
J2EEBooleanType	Boolean
J2EEStringType	Character string
J2EENormalizedStringType	Character string without carriage return (CR) and without tabulation (TAB)
J2EEDecimalType	Any number without limit
J2EEIntType	Integer included between - 2 147 483 648 and + 2 147 483 647)
J2EEShortType	Short integer
J2EEUnsignedShortType	Unsigned short integer
J2EEIntegerType	Integer (no limit)
J2EELongType	Long integer
J2EEUnsignedLongType	Long unsigned integer
J2EENegativeIntegerType	Negative integer (except 0)
J2EENonNegativeIntegerType	Non-negative integer
J2EENonPositiveIntegerType	Non-positive integer
J2EEUnsignedIntType	Unsigned integer
J2EEPositiveIntegerType	Positive integer (except 0)
J2EEByteType	Byte
J2EEUnsignedByteType	Unsigned byte
J2EEFloatType	Real
J2EEDoubleType	Double real
J2EEAnyURIType	URL address

Call to J2EERun

After the call to J2EERun:

The procedure parameters are erased.
The structure of header specified by J2EEAddHeader is erased.
J2EEGetResult returns the result of the procedure run.
J2EEError returns the error message of the procedure run.

Component : wd240com.dll