Copyright © Cloud Software Group, Inc. All Rights Reserved

Infrastructure Classes

These classes provide functions such as setting up the action request, creating a socket, performing an XSL transform, etc.

The classes available in this category are listed in the table below (click on the class name to link to the method descriptions for that class).

 

Class1	Description
Action	Provides an object model interface to support the creation of Action Processor commands.
AuthenticateRequests	Provides login and logout requests.
Socket	Provides socket access for components.
UtilityRequests	Provides general-utility Action Processor requests.
XmlElement	Provides support creating XML elements.
XslTransform	Provides support for performing XSL transforms on XML documents.

---

1

All classes are prefixed with “com.tibco.bpm.ipc”.

Each of the infrastructure classes is described in the following subsections.

Action

The com.tibco.bpm.ipc.Action class defines an object model interface to support the TIBCO Action Processor protocol. The Action Processor supports XML communication using the following example protocol:

The command consists of an Action that can support multiple requests. This class adds structure around an object model that enables developers to build these requests. The following is an example of how to use this class to construct a simple MakeWorkItemList request. The purpose of this request is to obtain the list state object to obtain the available count that the WICriteria filter expression defines:

---

 

var action = new com.tibco.bpm.ipc.Action();

var request = action.addRequest("MakeWorkItemList", "212");

request.addParameter(new com.tibco.bpm.ipc.XmlElement("WorkQTag", "i2tagtest|swadmin|R"));

request.addParameter(new com.tibco.bpm.ipc.vWICriteria('SW_STEPDESC = "First Step"'));

request.addParameter(new com.tibco.bpm.ipc.vWIContent());

request.addParameter(new com.tibco.bpm.ipc.XmlElement("StartIndex", 0));

request.addParameter(new com.tibco.bpm.ipc.XmlElement("ReturnCout", 0));

request.addParameter(new com.tibco.bpm.ipc.XmlElement("Keep", false));

---

 

Calling action.toXml() on the above Action object returns the following valid XML string:

The com.tibco.bpm.ipc.Action class contains the following public methods.

 

Method	Description
init(requests)	Constructor — initializes the class. Optionally creates an Action Processor command for the specified array of request objects. Parameters requests - (optional) An array of Request objects (com.tibco.bpm.ipc.RequestXml). Returns An instance of the com.tibco.bpm.ipc.Action class.
addRequest(strCommand,            strRequestId)	Adds a new Request to the Action command. Parameters strCommand - (String) The request command. strRequestId - (String) A unique ID for the request. This is the ID of the XML cache that will hold the XML document returned by the Action Processor. Returns Request object (com.tibco.bpm.ipc.RequestXml).
addRequestParameter(strRequestId,                     objParameter)	Adds parameters to a Request and identifies the Request by unique ID. Parameters strRequestId - (String) Unique ID of the request. objParameter - (com.tibco.bpm.ipc.XmlElement) XML element object to add to the request. Returns None.
toXml()	Outputs a valid XML string for the com.tibco.bpm.ipc.Action command. Returns Action object serialized as an XML string.

AuthenticateRequests

The com.tibco.bpm.ipc.AuthenticateRequests class provides methods for creating server requests to log in and log out. The following examples show the execution of login and logout requests.

Login

var socket = this.getApp().newSocket('Login');

var nodeId = new com.tibco.bpm.ipc.vNodeId(name, computername, ipaddress, tcpport, director);

socket.setAsync(false);

var action = new com.tibco.bpm.ipc.Action([

   com.tibco.bpm.ipc.AuthenticateRequests.login(
   'Login', new com.tibco.bpm.ipc.NodeCtx('userId', 'password',
   nodeId))]);

socket.addParameter('action', action.toXml());

socket.execute();

Logout

var socket = this.getApp().newSocket('Logout');

socket.setAsync(false);

var action = new com.tibco.bpm.ipc.Action([   com.tibco.bpm.ipc.AuthenticateRequests.logout('Logout', true)]);

socket.addParameter('action', action.toXml());

socket.execute();

The com.tibco.bpm.ipc.AuthenticateRequests class contains the following public methods.

 

Method	Description
init()	Constructor — initializes the class. Returns An instance of the com.tibco.bpm.ipc.AuthenticateRequests class.
login(id,       nodeCtx)	Performs login authentication. Parameters id - (String) Unique ID of the request. This is the ID of the XML cache that will hold the XML document returned by the Action Processor. nodeCtx - (com.tibco.bpm.ipc.NodeCtx) Node connection object. Note - As there is not a data class for NodeCtx that can be created and passed into the login method, you must create one as shown in the example on page 146, for example: new com.tibco.bpm.ipc.NodeCtx('userId', 'password', nodeId) The nodeId parameter provides connection information — this can be created using the vNodeId data class — see page 211. Returns Server Request object for issuing a login request: com.tibco.bpm.ipc.ServerRequest.
logout(id,        releaseAllResources)	Performs logout and closes the SAL session. Parameters id - (String) Unique ID of the request. This is the ID of the XML cache that will hold the XML document returned by the Action Processor. releaseAllResources - (boolean) If true, the SAL session is closed by the resulting request. Returns Server Request object for issuing a logout request: com.tibco.bpm.ipc.ServerRequest.

Socket

The com.tibco.bpm.ipc.Socket class provides socket access for components.

Note that the constructor for this class is private. Use the following factory method to create an instance:

com.tibco.bpm.ipc.Application.newSocket(id)

where:

−	id is the unique ID assigned to the request. This is the ID of the XML cache that will hold the XML document returned by the Action Processor. The newSocket method dispatches the socketResult event when the result is returned.

For a code example showing the creation of a socket, execution of the request, and error handling, see Example Request.

The com.tibco.bpm.ipc.Socket class contains the following public methods.

 

Method	Description
addParameter(strName,              strValue)	Registers the URL argument name and value pairs that will be appended to the base URL prior to request communication. Parameters strName - (String) The parameter name. strValue - (String) The parameter value. Returns None.
cancelRequest(strRequestId)	Cancels the named request. Parameters strRequestId - (String) Unique ID for the request (assigned when the socket was instanced). Returns None.
execute()	Opens the request and dispatches the socket call. Returns None.
getApExMessage()	Returns A string containing exception messages returned in the Action Processor response. Expressed as a <ap:ExceptionMessage> value in the response XML.
getApExStackTrace()	Returns A string containing exception stack trace returned in the Action Processor response. Expressed as a <ap:ExceptionStackTrace> value in the response XML.
getApReturnCode()	Returns A string containing the Action Processor request response code. Expressed as a <ap:ReturnCode> value in the response XML.
getApReturnComment()	Returns A string containing the Action Processor request response comment. Expressed as a <ap:ReturnComment> value in the response XML.
getApReturnDate()	Returns A string containing the date and time of the Action Processor response. Expressed as a <ap:ReturnDateTime> value in the response XML.
getBaseUrl()	Returns A string containing the base URL (Action Processor URL) to access the XML data.
getErrorMessage()	Returns A string containing an error message describing the error that occurred when isSuccess returns false, indicating a failure during socket processing.
getId()	Returns A string containing the object ID value used for request and cache identification (assigned when the socket was instanced). There will never be two com.tibco.bpm.ipc.Sockets with the same ID.
getRequestType()	Returns A string containing 'GET' or 'POST' (default = 'POST').
getSsoErrorCount()	Returns An integer that is the number of vExceptionDetail nodes returned by iProcess Server Objects in the response message.
getSsoErrorMsg()	Returns A string containing the value of any iProcess Server Objects-generated errors.
getSsoExceptionNode()	Returns A jsx3.xml.Entity object, which is the sso:Exception element returned in the response message.
isSuccess()	Returns A boolean that indicates the request communication success (true) or failure (false).
reportErrors()	Combines any error message from the socket, or Action Processor, with any iProcess Server Objects exception error messages. Also logs the messages and displays a message to user.
setAsync(bAsync)	Specifies whether request communication, with the Action Processor, will be asynchronous or synchronous. Parameters bAsync - (boolean) true for asynchronous communication, false for synchronous (default = true). Returns None.
setBaseUrl(strUrl)	Sets the base URL (Action Processor URL) for accessing the XML data. Parameters strUrl - (String) The base URL to access the XML data. Returns None.
setErrorMsgPrefix(strPrefix)	Used to specify a prefix for an action-specific error message that may be generated by an action. Use this method to add custom messages that will be displayed to the user if the action generates an error message. Parameters strPrefix - (String) Action-specific error message that will prefix any error messages generated by the action. Returns None.
setRequestType(strType)	Sets the request type. Parameters strType - (String) Type of request, either 'GET' or 'POST' (default = 'POST'). Returns None.
setShowUserMsg(bShow)	Specifies whether or not to display error messages, returned in the action result, to the user. Parameters bShow - (boolean) If true, any errors generated by an action will be displayed to the user. This can be set to false if the calling class needs to override the message show to the user (default = true). Returns None.

UtilityRequests

The com.tibco.bpm.ipc.UtilityRequests class provides general-utility Action Processor requests.

This class contains the following public methods.

 

Method	Description
init()	Constructor - initializes the class. Returns An instance of the com.tibco.bpm.ipc.UtilityRequests class.
ping()	Sends a simple request to verify that the Action Processor is responding. Returns A Server Request object (com.tibco.bpm.ipc.ServerRequest) for issuing a ping request.

XmlElement

The com.tibco.bpm.ipc.XmlElement class provides support for creating XML elements.

This class contains the following public methods.

 

Method	Description
init(tagName,      objText)	Constructor - initializes the class. Parameters tagName - (String) The name that defines the XML element tag. objText - (boolean, object, number, string) This is an optional argument. When passed, the constructor attempts to convert the argument to a valid string, which is the text that the XML element encloses. Returns An instance of the com.tibco.bpm.ipc.XmlElement class. Example new com.tibco.bpm.ipc.XmlElement("WorkQTag", "i2tagtest|swadmin|R"); returns the following XML element: <WorkQTag>i2tagtest|swadmin|R</WorkQTag>
addAttribute(strName,              strValue)	Adds a name/value pair as an attribute of the XML element. Parameters strName - (String) The name of the attribute. strValue - (String) The value of the attribute. Returns None. Example var xmlElement = new com.tibco.bpm.ipc.XmlElement("WorkQ"); xmlElement.addAttribute("tag","i2tagtest| swadmin|R"); creates the following XML element and adds an attribute: <WorkQ tag="i2tagtest|swadmin|R"/>
addChild(objChild)	Adds a child to the children of the XML element. Parameters objChild - (com.tibco.bpm.ipc.XmlElement) The child object to add to the XML element. Returns None. Example var xmlElement = new com.tibco.bpm.ipc.XmlElement("WorkQ"); var xmlChild = new com.tibco.bpm.ipc.XmlElement("WorkItem", "1234"); xmlElement.addChild(xmlChild); creates the following XML element with a child element: <WorkQ><WorkItem>1234</WorkItem></WorkQ>
toXml()	Outputs a valid XML string representing the XML element and all of its children. Returns A string containing the XML element and all of its children.

XslTransform

The com.tibco.bpm.ipc.XslTransform class provides support for performing XSL transforms on XML documents.

Note that the constructor for this class is private. Use the following factory method to create an instance:

com.tibco.bpm.ipc.Application.newXslTransform (xmlDoc, xslDoc)

where:

−	xmlDoc is the path to the XML file, XML string, cacheId or jsx3.xml.Document object for the XML document.

−	xslDoc is the path to the XSL file, XSL string, cacheId or jsx3.xml.Document object for the XSL document.

This class contains the following public methods.

 

Method	Description
addParameter(strName,              strValue)	Adds a parameter to the XSL transform. Parameters strName - (String) The name of the parameter. strValue - (String) The value of the parameter. Returns None.
removeParameter(strName)	Removes a parameter from the XSL transform. Parameters strName - (String) The name of the parameter to remove from the XSL transform. Returns None.
doTransform(strCacheId)	Performs the XSL transform. Parameters strCacheId - (String) Optional. If provided, a jsx3.xml.Document containing the transform results is stored in cache under the given strCacheId. Returns A string containing the results of the XSL transform.

 

Copyright © Cloud Software Group, Inc. All Rights Reserved