org.qore.lang.soapclient.SoapClient Class Reference

Java wrapper for the SoapClient::SoapClient class in Qore. More...

Inheritance diagram for org.qore.lang.soapclient.SoapClient:

Public Member Methods
	SoapClient (QoreObject ds)
	creates the object
	SoapClient (Map< String, Object > h) throws Throwable
	creates the object based on a WSDL which is parsed to a WebService object which provides the basis for all communication with this object
Object	callOperation (String operation, Object args, Map< String, Object > opts) throws Throwable
	makes a server call with the given operation, arguments, options, and optional info hash reference and returns the result
HashMap< String, Object >	getInfo () throws Throwable
	returns a hash of information about the current WSDL
void	setSendEncoding (String enc) throws Throwable
	change the data content encoding (compression) option for the object; see EncodingSupport for valid options
void	setContentEncoding (String enc) throws Throwable
	sets the request and desired response encoding for the object; see EncodingSupport for valid options
void	addDefaultHeaders (Map< String, Object > h) throws Throwable
	adds default headers to each request; these headers will be sent in all requests but can be overridden in requests as well
HashMap< String, Object >	getDefaultHeaders () throws Throwable
	returns the hash of default headers to sent in all requests
String	getSendEncoding () throws Throwable
	returns the current data content encoding (compression) object or nothing if no encoding option is set; see EncodingSupport for valid options
void	log (String msg) throws Throwable
	sends a log message to the log closure or call reference, if any
void	dbglog (String msg) throws Throwable
	sends a log message to the debug log closure or call reference, if any
Public Member Methods inherited from org.qore.lang.HTTPClient
	HTTPClient (QoreObject ds)
	creates the object
	HTTPClient (Map< String, Object > opts) throws Throwable
	Creates the HTTPClient object based on the option parameter passed.
void	setHTTPVersion (String ver) throws Throwable
	Sets the HTTP protocol version string for headers in outgoing messages, allowed values are "1.0" and "1.1".
String	getHTTPVersion () throws Throwable
	Returns the HTTP protocol version string used in outgoing messages.
void	setSecure (boolean secure) throws Throwable
	Sets the object to make a secure SSL/TLS connection on the next connect if the passed argument is true, or an unencrypted cleartext connection if it is false.
boolean	isSecure () throws Throwable
	Returns true if the current connection is encrypted, false if not.
void	connect () throws Throwable
	Connects to the remote socket; SSL/TLS negotiation is performed if required.
void	disconnect () throws Throwable
	Disconnects from the remote socket if a connection is established (otherwise does nothing)
HashMap< String, Object >	send (String body, String method, String path, Map< String, Object > headers, boolean getbody) throws Throwable
	Sends an HTTP request with the specified method and optional message body and returns headers and any body received as a response in a hash format.
HashMap< String, Object >	send (String body, String method, String path, Map< String, Object > headers) throws Throwable
	Sends an HTTP request with the specified method and optional message body and returns headers and any body received as a response in a hash format.
HashMap< String, Object >	send (String body, String method, String path) throws Throwable
	Sends an HTTP request with the specified method and optional message body and returns headers and any body received as a response in a hash format.
HashMap< String, Object >	send (String body, String method) throws Throwable
	Sends an HTTP request with the specified method and optional message body and returns headers and any body received as a response in a hash format.
HashMap< String, Object >	send (byte[] body, String method, String path, Map< String, Object > headers, boolean getbody) throws Throwable
	Sends an HTTP request with the specified method and optional message body and returns headers and any body received as a response in a hash format.
HashMap< String, Object >	send (byte[] body, String method, String path, Map< String, Object > headers) throws Throwable
	Sends an HTTP request with the specified method and optional message body and returns headers and any body received as a response in a hash format.
HashMap< String, Object >	send (byte[] body, String method, String path) throws Throwable
	Sends an HTTP request with the specified method and optional message body and returns headers and any body received as a response in a hash format.
HashMap< String, Object >	send (byte[] body, String method) throws Throwable
	Sends an HTTP request with the specified method and optional message body and returns headers and any body received as a response in a hash format.
String	get (String path, Map< String, Object > headers) throws Throwable
	Sends an HTTP GET request and returns the message body received as a string or null if no message body is received.
String	get (String path) throws Throwable
	Sends an HTTP GET request and returns the message body received as a string or null if no message body is received.
String	head (String path, Map< String, Object > headers) throws Throwable
	Sends an HTTP HEAD request and returns as hash of the headers received.
String	head (String path) throws Throwable
	Sends an HTTP HEAD request and returns as hash of the headers received.
String	post (String path, String body, Map< String, Object > headers) throws Throwable
	Sends an HTTP POST request with a message body and returns the message body received as a string or null if no message body is received.
String	post (String path, String body) throws Throwable
	Sends an HTTP POST request with a message body and returns the message body received as a string or null if no message body is received.
String	post (String path) throws Throwable
	Sends an HTTP POST request without a message body and returns the response message body received as a string or null if no message body is received.
String	post (String path, byte[] body, Map< String, Object > headers) throws Throwable
	Sends an HTTP POST request with a message body and returns the message body received as a string or null if no message body is received.
String	post (String path, byte[] body) throws Throwable
	Sends an HTTP POST request with a message body and returns the message body received as a string or null if no message body is received.
void	setTimeout (int timeout_ms) throws Throwable
	Sets the default I/O timeout value in milliseconds.
int	getTimeout () throws Throwable
	Returns the default I/O timeout as an integer in milliseconds.
void	setEncoding (String encoding) throws Throwable
	Sets the string encoding for the object; any strings deserialized with this object will be tagged with this character encoding.
String	getEncoding () throws Throwable
	Returns the character encoding used for the object.
void	setURL (String url) throws Throwable
	Sets a new URL value for the next connection.
String	getURL () throws Throwable
	Returns the current URL.
void	setProxyURL () throws Throwable
	Clears the new proxy URL value for the next connection.
void	setProxyURL (String url) throws Throwable
	Sets a new proxy URL value for the next connection.
String	getProxyURL () throws Throwable
	Returns the current proxy URL as a string or null if no proxy URL is set.
void	clearProxyURL () throws Throwable
	Clears the new proxy URL value for the next connection.
void	setProxySecure (boolean b) throws Throwable
	Sets the SSL/TLS flag for the next connection to the proxy.
boolean	isProxySecure () throws Throwable
	Returns the SSL/TLS flag for the next proxy connection.
void	setMaxRedirects (int mr) throws Throwable
	Updates the setting for the max_redirects value for the object (maximum number of HTTP redirects that will be processed before an exception is raised)
int	getMaxRedirects () throws Throwable
	Returns the current max_redirects value for the object (the maximum number of HTTP redirects that will be processed before an exception is raised)
void	setConnectTimeout (int timeout_ms) throws Throwable
	Sets the connect timeout in milliseconds.
int	getConnectTimeout () throws Throwable
	Returns the connect timeout as an integer in milliseconds.
int	setNoDelay (boolean b) throws Throwable
	Sets the TCP_NODELAY setting for the object.
boolean	getNoDelay () throws Throwable
	Returns the TCP_NODELAY setting for the HTTPClient object.
boolean	isConnected () throws Throwable
	Returns true or false giving the current connection state.
void	setUserPassword (String user, String pass) throws Throwable
	Sets the username and password for the connection; call after HTTPClient::setURL()
void	setUserPassword () throws Throwable
	Clears the username and password for the connection.
void	clearUserPassword () throws Throwable
	Clears the username and password for the connection.
void	setProxyUserPassword (String user, String pass) throws Throwable
	Sets the username and password for the connection to the proxy; call after HTTPClient::setProxyURL()
void	setProxyUserPassword () throws Throwable
	Clears the username and password for the next proxy connection.
void	clearProxyUserPassword () throws Throwable
	Clears the username and password for the next proxy connection.
void	setDefaultPath (String path) throws Throwable
	Sets the default path used by the object if no path is set in the URL.
String	getDefaultPath () throws Throwable
	Returns the default path used by the object if no path is set in the URL.
String	getConnectionPath () throws Throwable
	Returns the current connection path set in the URL.
void	setConnectionPath (String uri_path) throws Throwable
	Overrides any connection path set in the URL.
void	setConnectionPath () throws Throwable
	Overrides any connection path set in the URL.
HashMap< String, Object >	getUsageInfo () throws Throwable
	Returns performance statistics for the socket.
void	clearStats () throws Throwable
	Clears performance statistics.
void	setPersistent () throws Throwable
	temporarily disables implicit reconnections; must be called when the server is already connected
boolean	setErrorPassthru (boolean set) throws Throwable
	set the error passthru status
boolean	setErrorPassthru () throws Throwable
	set the error passthru status
boolean	getErrorPassthru () throws Throwable
	get the error passthru status
boolean	setRedirectPassthru (boolean set) throws Throwable
	set the redirect passthru status
boolean	setRedirectPassthru () throws Throwable
	set the redirect passthru status
boolean	getRedirectPassthru () throws Throwable
	get the redirect passthru status
boolean	setEncodingPassthru (boolean set) throws Throwable
	set the encoding passthru status
boolean	setEncodingPassthru () throws Throwable
	set the encoding passthru status
boolean	getEncodingPassthru () throws Throwable
	get the encoding passthru status
String	getHostHeaderValue () throws Throwable
	returns the Host header value for this object

Detailed Description

Java wrapper for the SoapClient::SoapClient class in Qore.

Note

Loads and initializes the Qore library and the jni module in static initialization if necessary

Deprecated:

Use dynamic imports instead: import qoremod.SoapClient.SoapClient;

Constructor & Destructor Documentation

SoapClient()

org.qore.lang.soapclient.SoapClient.SoapClient ( Map< String, Object >  h ) throws Throwable

inline

creates the object based on a WSDL which is parsed to a WebService object which provides the basis for all communication with this object

one of either the wsdl or wsdl_file keys is required in the hash given to the constructor or an exception will be thrown

Parameters

h

valid option keys: wsdl: the URL of the web service or a WebService object itself wsdl_file: a path to use to load the WSDL and create the WebService object url: override the target URL given in the WSDL send_encoding: a send data encoding option or the value "auto" which means to use automatic encoding; if not present defaults to no content-encoding on sent message bodies content_encoding: for possible values, see EncodingSupport; this sets the send encoding (if the "send_encoding" option is not set) and the requested response encoding [service]: in case multiple service entries are found in the WSDL, give the one to be used here [port]: in case multiple port entries are found in the WSDL, give the one to be used here; note that the SOAP binding is resolved from the service and port options. [log]: a log closure or call reference taking a single string giving the log message [dbglog]: a log closure or call reference taking a single string giving the debug log message also all options from SoapClient::HTTPOptions, which are passed to HTTPClient::constructor()

Member Function Documentation

addDefaultHeaders()

void org.qore.lang.soapclient.SoapClient.addDefaultHeaders ( Map< String, Object >  h ) throws Throwable

inline

adds default headers to each request; these headers will be sent in all requests but can be overridden in requests as well

Example:

// disable gzip and bzip encoding in responses
soap.addDefaultHeaders(hdrs);

Parameters

h	a hash of headers to add to the default headers to send on each request

Note

default headers can also be set in the constructor

See also

getDefaultHeaders()

callOperation()

Object org.qore.lang.soapclient.SoapClient.callOperation ( String  operation, Object  args, Map< String, Object >  opts  ) throws Throwable

inline

makes a server call with the given operation, arguments, options, and optional info hash reference and returns the result

Parameters

operation	the SOAP operation to use to serialize the request; if the operation is not known to the underlying WebService class, an exception will be thrown
args	the arguments to the SOAP operation
opts	an optional hash of options for the call as follows: soap_header: a hash giving SOAP header information, if required by the message http_header: a hash giving HTTP header information to include in the message (does not override automatically-generated SOAP message headers) xml_opts: an integer XML generation option code; see xml_generation_constants for possible values; combine multiple codes with binary or (|) soapaction: an optional string that will override the SOAPAction for the request; en empty string here will prevent the SOAPAction from being sent binding: the SOAP binding name, if not provided the first binding assigned to the operation will be used

Returns

a hash with the following keys:

• hdr: a hash of message headers
• body: the serialized message body

Exceptions

WSDL-OPERATION-ERROR	the operation is not defined in the WSDL
WSDL-BINDING-ERROR	the binding is not assigned to a SOAP operation in the WSDL
HTTP-CLIENT-RECEIVE-ERROR	this exception is thrown when the SOAP server returns an HTTP error code; if a SOAP fault is returned, then it is deserialized and returned in the arg key of the exception hash

Note

this method can throw any exception that HTTPClient::send() can throw as well as any XML parsing errors thrown by parse_xml()

getDefaultHeaders()

HashMap< String, Object > org.qore.lang.soapclient.SoapClient.getDefaultHeaders ( ) throws Throwable

inline

returns the hash of default headers to sent in all requests

Example:

HashMap<String, Object> h = soap.getDefaultHeaders();

Returns

the hash of default headers to sent in all requests

Note

default headers can be set in the constructor and in addDefaultHeaders()

See also

setDefaultHeaders()

getInfo()

HashMap< String, Object > org.qore.lang.soapclient.SoapClient.getInfo ( ) throws Throwable

inline

returns a hash of information about the current WSDL

Returns

a hash with the following keys:

• "service": the name of the SOAP service used
• "pore": the name of the SOAP port used
• "binding": the name of the binding used
• "url": the target URL

getSendEncoding()

String org.qore.lang.soapclient.SoapClient.getSendEncoding ( ) throws Throwable

inline

returns the current data content encoding (compression) object or nothing if no encoding option is set; see EncodingSupport for valid options

Example:

String ce = soap.getSendEncoding();

Returns

the current data content encoding (compression) object or nothing if no encoding option is set; see EncodingSupport for valid options

See also

• setContentEncoding()
• setSendEncoding()

setContentEncoding()

void org.qore.lang.soapclient.SoapClient.setContentEncoding ( String  enc ) throws Throwable

inline

sets the request and desired response encoding for the object; see EncodingSupport for valid options

Example:

soap.setContentEncoding("gzip");

Parameters

enc	the data content encoding (compression) option for requests and the desired response content encoding for the object; see EncodingSupport for valid options; if the value "auto" is passed then "gzip" encoding is used for outgoing requests and requested for responses

Exceptions

SOAPCLIENT-ERROR

invalid or unsupported data content encoding / compression option

See also

• getSendEncoding()
• setSendEncoding()

Since

SoapClient 0.2.4

setSendEncoding()

void org.qore.lang.soapclient.SoapClient.setSendEncoding ( String  enc ) throws Throwable

inline

change the data content encoding (compression) option for the object; see EncodingSupport for valid options

Example:

sc.setSendEncoding("gzip");

The default is to send requests unencoded/uncompressed.

Parameters

enc	the data content encoding (compression) option for the object; see EncodingSupport for valid options; if the value "auto" is passed then "gzip" encoding is used

Exceptions

SOAPCLIENT-ERROR

invalid or unsupported data content encoding / compression option

See also

• setContentEncoding()
• getSendEncoding()

---

The documentation for this class was generated from the following file:

• /tmp/module-jni/src/java/org/qore/lang/soapclient/SoapClient.java