Web Services API

Web Services API

The web services Lua API exposes JSLEE WebServicesSendRequestEvent handling functionality for use within the Lua script engine.

Functions

WebServicesSendRequestEvent:wrap (javaobject)

Description

Wraps a web services send request message from Java in the Lua web services API.

Arguments

Argument Comments
javaObject The handle to the Java object to wrap.

Returns

Return Type Comments
wrappedObject Object The wrapped object.

Example

local s = WebServicesSendRequestEvent:wrap (obj)

WebServicesSendRequestEvent:create (context, templateName, parameters)

Description

Creates a Java WebServicesSendRequestEvent with the given parameters.

Arguments

Argument Comments
context The JSLEE message context to use.
templateName The template filename to use for request generation.
parameters A Java JsonObject of template parameters.

Returns

Return Type Comments
wrappedObject Object The wrapped object after creation.

Example

local r = WebServicesSendRequestEvent:create(context, template.templateFile, JSLEE.createJsonObject (inputParameters))

WebServicesSendRequestEvent:unwrap ()

Description

Unwraps a Lua web services API WebServicesSendRequestEvent that can be sent across the JSLEE.

Arguments

None.

Returns

Return Type Comments
unwrappedObject Object The unwrapped Java object.

Example

local r = resp:unwrap())

WebServicesSendRequestEvent:setTemplateName (templateName)

Description

Sets the template name on a created WebServicesSendRequestEvent.

Arguments

Argument Comments
templateName The template name to set. Must not be nil.

Returns

Nothing.

Example

local r = WebServicesSendRequestEvent:create(context, template.templateFile, JSLEE.createJsonObject (inputParameters))
r:setTemplateName("newname")

WebServicesSendRequestEvent:setParameters (parameters)

Description

Sets the parameters on a created WebServicesSendRequestEvent.

Arguments

Argument Comments
parameters The parameters to set. Must be a Java JsonObject.

Returns

Nothing.

Example

local r = WebServicesSendRequestEvent:create(context, template.templateFile, JSLEE.createJsonObject (inputParameters))
r:setParameters(JSLEE.createJsonObject ())

WebServicesSendRequestEvent:getTemplateName ()

Description

Returns the template name of a created WebServicesSendRequestEvent.

Arguments

None.

Returns

Return Type Comments
templateName String The web service request’s template name.

Example

local r = WebServicesSendRequestEvent:create(context, template.templateFile, JSLEE.createJsonObject (inputParameters))
JSLEE.debug(r:getTemplateName())

WebServicesSendRequestEvent:getParameters ()

Description

Returns the parameters of a created WebServicesSendRequestEvent.

Arguments

None.

Returns

Return Type Comments
parameters String The web service request’s parameters.

Example

local r = WebServicesSendRequestEvent:create(context, template.templateFile, JSLEE.createJsonObject (inputParameters))
JSLEE.debug(r:getParameters():toString())

WebServicesSendRequestEvent:generateHTTPDate ()

Description

Generates the current date in RFC 1123 format, as used in HTTP headers.

Arguments

None.

Returns

Return Type Comments
date String The current date and time in RFC 1123 format.

Example

local value = WebServicesSendRequestEvent:generateHTTPDate()