Appearance

API: soap ​

Source: net/soap.ts

Utility class for creating, parsing, and calling SOAP messages. It wraps the underlying Java javax.xml.soap API.

Usage ​

javascript
import { soap } from "sdk/net";
import { response } from "sdk/http";

response.setContentType("text/plain; charset=UTF-8");

let requestMessage = soap.createMessage();
let part = requestMessage.getPart();
let envelope = part.getEnvelope();
envelope.addNamespaceDeclaration("ws", "http://ws.cdyne.com/");
let body = envelope.getBody();
let resolveIPElement = body.addChildElement("ResolveIP", "ws");
let ipAddressElement = resolveIPElement.addChildElement("ipAddress", "ws");
ipAddressElement.addTextNode("213.239.203.158");
let licenseKeyElement = resolveIPElement.addChildElement("licenseKey", "ws");
licenseKeyElement.addTextNode("");

let mimeHeaders = requestMessage.getMimeHeaders();
mimeHeaders.addHeader("SOAPAction", "http://ws.cdyne.com/ResolveIP");

requestMessage.save();
response.println("Request: " + requestMessage.getText());

let responseMessage = soap.call(requestMessage, "http://ws.cdyne.com/ip2geo/ip2geo.asmx");

response.println("Response: " + responseMessage.getText());

response.flush();
response.close();

Classes ​

SOAP ​

Utility class for creating, parsing, and calling SOAP messages.
It wraps the underlying Java javax.xml.soap API.

Methods ​

call ​

  • call (message:Message, url:string):string)

    Call a given SOAP endpoint with a given request message
    @param message The SOAP Message wrapper object.
    @param url The target SOAP endpoint URL.

trustAll ​

  • trustAll ()void

createMessage ​

  • createMessage ():Message

    Creates a new, empty SOAP message.

parseMessage ​

  • parseMessage (mimeHeaders:MimeHeaders, inputStream:InputStream):Message

    Parses a SOAP message from an InputStream and MimeHeaders.
    @param mimeHeaders The MimeHeaders wrapper object.
    @param inputStream The InputStream wrapper object.

parseRequest ​

  • parseRequest ():Message

    Parses a SOAP message from the current HTTP request input stream.

createMimeHeaders ​

  • createMimeHeaders ():MimeHeaders

    Creates a new, empty MimeHeaders object.

Message ​

SOAP Message Wrapper

Methods ​

getPart ​

  • getPart ():Part

    SOAP Message Wrapper

getMimeHeaders ​

  • getMimeHeaders ():MimeHeaders

save ​

  • save ():void

getText ​

  • getText ():string

Part ​

SOAP Part Wrapper

Methods ​

getEnvelope ​

  • getEnvelope ():Envelope

    SOAP Part Wrapper

MimeHeaders ​

SOAP Mime Headers Wrapper

Methods ​

addHeader ​

  • addHeader (name:string, value:string):void

    SOAP Mime Headers Wrapper

addBasicAuthenticationHeader ​

  • addBasicAuthenticationHeader (username:string, password:string):void

Envelope ​

SOAP Envelope Wrapper

Methods ​

addNamespaceDeclaration ​

  • addNamespaceDeclaration (prefix:string, uri:string):void

    SOAP Envelope Wrapper

getBody ​

  • getBody ():Body

getHeader ​

  • getHeader ():Header

createName ​

  • createName (localName:string, prefix:string, uri:string):Name

Body ​

SOAP Body Wrapper

Methods ​

addChildElement ​

  • addChildElement (localName:string, prefix:string):Element

    SOAP Body Wrapper

getChildElements ​

  • getChildElements ():Element[]

SOAP Header Wrapper

Methods ​

addHeaderElement ​

  • addHeaderElement (element:Element):void

    SOAP Header Wrapper

Name ​

SOAP Name Wrapper

Methods ​

getNative ​

  • getNative ():string

    SOAP Name Wrapper

getLocalName ​

  • getLocalName ():string

getPrefix ​

  • getPrefix ():string

getQualifiedName ​

  • getQualifiedName ():string

getURI ​

  • getURI ():string

Element ​

SOAP Element Wrapper

Methods ​

addChildElement ​

  • addChildElement (localName:string, prefix:string):string)

    SOAP Element Wrapper

addTextNode ​

  • addTextNode (text:string):Element

addAttribute ​

  • addAttribute (name:Name, value:any):Element

getChildElements ​

  • getChildElements ():Element[]

getElementName ​

  • getElementName ():Name|undefined

getValue ​

  • getValue ():any

isSOAPElement ​

  • isSOAPElement ():boolean