class Service

event type for unsuccessful response

Event type published each time a rule with one or more restrictions fails during message generation. The following named properties are available on the event object:

• rule the rule node
• message the message node
• target this jsx3.net.Service instance
• type the type of restriction that caused the invalidation event to be publsihed. For example, pattern.
• value the value for the type. For example if type is pattern, then [A-Z]*

Event type published each time a mapping rule is used to create a node, locate a node, or map to a node.

• target this jsx3.net.Service instance
• rule the rule node being processed
• action the action being performed by the rule. For example, Create Node, Map to Cache, Invalidate Node, etc.
• description a description of the 'action'. For example, this.eval(setValue(2));
• level the log level (e.g., 'severity' level) for the message. For example, 6 would signify a 'Trace' level event.

event type for successful response

Event type published when the response is still not ready after the specified timeout period.

instance initializer

Compiles the CXF rules for this service instance to an equivalent XSLT document. This enables much faster performance than using the DOM-based iterator (default) to convert the XML response document into a CDF Document type. Note that this process only supports the map types CDF Document, CDF Record, and CDF Attribute. Only one CDF Document can be declared per Operation. Otherwise the compilation will fail. All other mapping types will be ignored and will not be converted into an XSLT equivalent. Also note that the order of a set of sibling mapping rules does not proscribe proper processing by way of sequence. This means that any order of sibling mapping rules will result in appropriate processing, regardless of the sibling node order returned from the given service. This facilitates nested record structures in that attributes can first be applied to a given record before child elements (e.g., a 'record') are added. Stated otherwise, any rule that has a descendant rule that would created a nested 'record' node should follow all sibling mapping rules that would create an 'attribute' entity. Call this method immediately before/after doCall for best performance.

Generates the request message (if applicable) and sends to the remote service.

Applies all inbound mappings, using the server response document as the source for the operation. Although this method is called once automatically, it can be called at any time to reapply the mapping rules. Example usage: var oService = new jsx3.net.Service(); oService.setInboundDocument(objSomeDocumentIManuallyWantToLoad); oService.doInboundMap();

Gets the URL for the service endpoint where the request will be sent

Call this method after the service has responded to get a parsed instance of the server's XML response

Gets the URL for a "typical", XML-formatted server resonse document. This document is then used when the project is run in static mode (as defined by the Project Deployment Options).

Gets the method for the request. Default is POST

Gets the mode (static jsx3.Boolean.FALSE or live jsx3.Boolean.TRUE).

Gets the namespace for the server/project to run the service instance within. If a namespace isn't provided, the system will look for the first application and use its namespace. If no applications exist, the namespace will be completely ignored.

Gets the name of the operation to use within a multi-operation rules file. Note: Rules created via a WSDL often have multiple named operations. Rules files generated without a WSDL contain no named operations, and instead use a single transaction.

Call this method after 'doCall' has been called to get a parsed instance of the request document--what was actually sent to the remote service

Gets XPath address for the node in the outbound stub document to which to append the generated message.

Gets URL for the base stub to use for the request message (the XML document to contain the generated document)

Gets URL for a 'typical' XML-formatted request document to send to the server; when this is set, the mapper does not even attempt to generate a document. Instead, this document is sent directly to the server without any processing. Useful for testing requests that never change

Gets the jsx3.net.HttpRequest instance that performs the transaction with the remote service (the transport object for the message).

Gets the URL for the rules file to use (a CXF document). This rules file will be used by the Service instance to generate, send, receive and process XML messages

Returns the rules document used by the Service instance (a CXF document)

Returns the server that this service runs in, as set by the setNamespace() method.

Gets the request message specific to the MESSAGETYPE (input, output, fault). Typically only used for input (outbound) messages, but can be used for simulating a server response for output and fault (in the case of a SOAP transaction, fault) messages

Gets the HTTP response code (i.e., 200, 404, 500, etc). This will be the response code provided by the bound jsx3.net.Request instance used for the transport. However, if setStatus has been called on the Service instance, the value supplied by the developer will be used instead.

Returns a CR-LF delimited list of supported namespaces and thei related prefix (as defined by the Object, jsx3.net.Service.ns). Any nodes in a rules document (CXF) that implements one of the namespaces listed by this function, should implement the corresponding namespace prefix as also detailed here.

Gets user name to send as part of the http request (for servers requiring http authentication)

Gets password to send as part of the http request (for servers requiring http authentication)

Gets the release/build for the class (i.e., "2.2.00") @ returns {String}

Gets the parsed WSDL (what was used as the original input to create the rules file being used by this service instance).

Resets the rules tree to default state (with all 'skip' flags removed) from those rules that were skipped during the previous transaction

Dereferences the parsed rules tree (a jsx3.xml.Document instance) managed by this Service instance, forcing a reload of the document from disk the next time the rules document is requested

Sets the URL for the service endpoint where the request will be sent. Overrides the endpoint specified in the rules file.

Sets a parsed instance of the response document as soon as it returns from the server returned from the service; otherwise null

Sets the URL for a "typical", XML-formatted server resonse document. This document is then used when the project is run in static mode (as defined by the Project Settings dialog). Overrides the static setting in the rules file.

Sets the method for the request different than the one described in the rules file.

Sets the mode (static jsx3.Boolean.FALSE or live jsx3.Boolean.TRUE). Overrides the default setting for the context Server instance within which this Service instnace is running. (NOTE: This setting is accessible at the server level via the Project Settings dialog.) Setting this value to jsx3.Boolean.FALSE, forces a test document to be used to simulate a "typical" server response, instead of actually sending a request to a remote service. This is useful when setting up test environments as well as providing "live" interactions when the remote server may not be available.

Sets the namespace for the server/project to run the service instance within.

sets the script that will fire after the service has failed; if a soap fault envelope is returned, this will be processed as would any mapped tree. Allows for object repaints, cleanup, etc.

Sets the script that will fire after the service has finished an inbound mapping or a function to callback to; allows for object repaints, cleanup, etc

Sets the name of the operation to use within a multi-operation rules file. Note: Rules created via a WSDL often have multiple operations

Sets the document that will serve as the container for the message generated by doCall and/or getServiceMessage. This is a useful way to dynamically assemble documents by chaining multiple service instances, using the output from one service as the input to another. For example, when a SOAP Envelope requires both a SOAP Header as well as a SOAP Body, this method allows the Envelope to be assembled via a two-step process of first adding mapped content to the Body, followed by a call to add mapped content to the Header. Note that this method takes precedence over the static stub document url referenced in the rules file as well as any call to setOutboundStubURL. Use this method in conjunction with setOutboundStubPath to point to theer, a reference to this jsx3.net.Service instance

Sets the script that will fire after the service has finished an inbound mapping or a function to callback to; allows for object repaints, cleanup, etc

Sets the name of the operation to use within a multi-operation rules file. Note: Rules created via a WSDL often have multiple operations

Sets the document that will serve as the container for the message generated by doCall and/or getServiceMessage. This is a useful way to dynamically assemble documents by chaining multiple service instances, using the output from one service as the input to another. For example, when a SOAP Envelope requires both a SOAP Header as well as a SOAP Body, this method allows the Envelope to be assembled via a two-step process of first adding mapped content to the Body, followed by a call to add mapped content to the Header. Note that this method takes precedence over the static stub document url referenced in the rules file as well as any call to setOutboundStubURL. Use this method in conjunction with setOutboundStubPath to point to the specific location in the document where the generated message should be appended.

Sets XPath address for the node in the outbound stub document to which to append the generated message. Overrides the static setting in the rules file.

Sets the URL to the document that will serve as the container for the message generated by doCall and/or getServiceMessage. Overrides the static setting stored in the rules file. Use this method in conjunction with setOutboundStubPath to point to the specific location in the document where the generated message should be appended.

Sets the URL for a static XML-formatted request document to send to the Service. Note that when this is set, the mapper does not even attempt to generate a request document via the rules file. Instead, the static request document is sent directly to the remote Service without any processing. This is useful for requests that never change or as a means to test whether a Service is working, using a known, valid input.

Sets an HTTP Request header on the request. Set before calling, doCall()

Sets the URL for the rules file to use (a CXF document). This rules file will be used by the Service instance to generate, send, receive and process XML messages

Sets the HTTP response code (i.e., 200, 404, 500, etc). Typically, the Service instance determines this value by querying the bound request instance (jsx3.net.Request) returned by the method, [service_instance].getRequest(). However, calling this method will override normal operation by forcing a valid/invalid state that affects methdods relying on the HTTP status such as doInboundMap. This is particularly useful for SOAP services that provide alternate processing instructions and mappings when a Fault occurs as well as when running tests in Static mode.

Specifies how long to wait for the service to respond before cancelling the call. Subscribes to the ON_TIMEOUT event

Specifies timeout settings for resolving the domain name, establishing the connection to the server, sending the data, and receiving the response. The timeout parameters of the setTimeouts method are specified in milliseconds, so a value of 1000 would represent 1 second. A value of zero represents an infinite timeout. There are four separate timeout parameters: resolveTimeout, connectTimeout, sendTimeout, and receiveTimeout. When calling the setTimeouts method, all four values must be specified. The timeouts are applied at the Winsock layer.

Sets the user name to send with the posting (for those sites requiring http authentication)

Sets the password to send with the posting (for those sites requiring http authentication)