Jakarta SOAP with Attachments API 3.0.0 · jakarta.xml.soap.SOAPConnection

A point-to-point connection that a client can use for sending messages directly to a remote party (represented by a URL, for instance).

The SOAPConnection class is optional. Some implementations may not implement this interface in which case the call to SOAPConnectionFactory.newInstance() (see below) will throw an UnsupportedOperationException.

A client can obtain a SOAPConnection object using a SOAPConnectionFactory object as in the following example:

SOAPConnectionFactory factory = SOAPConnectionFactory.newInstance();
     SOAPConnection con = factory.createConnection();

A SOAPConnection object can be used to send messages directly to a URL following the request/response paradigm. That is, messages are sent using the method call, which sends the message and then waits until it gets a reply.

Modifier and Type	Field and Description
private int	connectTimeout
private int	readTimeout

Access	Constructor and Description
protected	SOAPConnection() Default constructor.

Method Summary

Modifier and Type	Method and Description
public abstract SOAPMessage	Returns: the `SOAPMessage` object that is the response to the message that was sent call(SOAPMessage the `SOAPMessage` object to be sent request, Object an `Object` that identifies where the message should be sent. It is required to support Objects of type `java.lang.String` and `java.net.URL` to) Sends the given message to the specified endpoint and blocks until it has returned the response.
public abstract void	close() Redeclares java.lang.AutoCloseable.close. Closes this `SOAPConnection` object.
public SOAPMessage	Returns: the `SOAPMessage` object that is the response to the get message request get(Object an `Object` that identifies where the request should be sent. Objects of type `java.lang.String` and `java.net.URL` must be supported. to) Gets a message from a specific endpoint and blocks until it receives,
public int	Returns: an `int` that indicates the connect timeout value in milliseconds getConnectTimeout() Returns setting for connect timeout.
public int	Returns: an `int` that indicates the read timeout value in milliseconds getReadTimeout() Returns setting for read timeout.
public void	setConnectTimeout(int an `int` that specifies the timeout value to be used in milliseconds timeout) Sets the read timeout to a specified timeout, in milliseconds.
public void	setReadTimeout(int an `int` that specifies the timeout value to be used in milliseconds timeout) Sets the read timeout to a specified timeout, in milliseconds.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

connectTimeout	back to summary
private int connectTimeout

readTimeout	back to summary
private int readTimeout

Constructor Detail

SOAPConnection	back to summary
protected SOAPConnection() Default constructor.

Method Detail

call back to summary

call	back to summary
public abstract SOAPMessage call(SOAPMessage request, Object to) throws SOAPException Sends the given message to the specified endpoint and blocks until it has returned the response. Parameters request:SOAPMessage the `SOAPMessage` object to be sent to:Object an `Object` that identifies where the message should be sent. It is required to support Objects of type `java.lang.String` and `java.net.URL` Returns:SOAPMessage the `SOAPMessage` object that is the response to the message that was sent Exceptions SOAPException: if there is a SOAP error

public abstract SOAPMessage call(SOAPMessage request, Object to) throws SOAPException

Sends the given message to the specified endpoint and blocks until it has returned the response.

Parameters

request:SOAPMessage: the SOAPMessage object to be sent
to:Object: an Object that identifies where the message should be sent. It is required to support Objects of type java.lang.String and java.net.URL

Returns:SOAPMessage

the SOAPMessage object that is the response to the message that was sent

Exceptions

SOAPException:: if there is a SOAP error

close back to summary

close	back to summary
public abstract void close() throws SOAPException Redeclares java.lang.AutoCloseable.close. Closes this `SOAPConnection` object. Exceptions SOAPException: if there is a SOAP error

public abstract void close() throws SOAPException

Redeclares java.lang.AutoCloseable.close.

Closes this SOAPConnection object.

Exceptions

SOAPException:: if there is a SOAP error

get back to summary

get	back to summary
public SOAPMessage get(Object to) throws SOAPException Gets a message from a specific endpoint and blocks until it receives, Parameters to:Object an `Object` that identifies where the request should be sent. Objects of type `java.lang.String` and `java.net.URL` must be supported. Returns:SOAPMessage the `SOAPMessage` object that is the response to the get message request Exceptions SOAPException: if there is a SOAP error Since 1.6, SAAJ 1.3

public SOAPMessage get(Object to) throws SOAPException

Gets a message from a specific endpoint and blocks until it receives,

Parameters

to:Object: an Object that identifies where the request should be sent. Objects of type java.lang.String and java.net.URL must be supported.

Returns:SOAPMessage

the SOAPMessage object that is the response to the get message request

Exceptions

SOAPException:: if there is a SOAP error

Since

1.6, SAAJ 1.3

getConnectTimeout back to summary

getConnectTimeout	back to summary
public int getConnectTimeout() Returns setting for connect timeout. `0` implies infinite timeout Returns:int an `int` that indicates the connect timeout value in milliseconds Since 3.0

public int getConnectTimeout()

Returns setting for connect timeout. 0 implies infinite timeout

Returns:int: an int that indicates the connect timeout value in milliseconds
Since: 3.0

getReadTimeout back to summary

getReadTimeout	back to summary
public int getReadTimeout() Returns setting for read timeout. `0` implies infinite timeout Returns:int an `int` that indicates the read timeout value in milliseconds Since 3.0

public int getReadTimeout()

Returns setting for read timeout. 0 implies infinite timeout

Returns:int: an int that indicates the read timeout value in milliseconds
Since: 3.0

setConnectTimeout back to summary

setConnectTimeout	back to summary
public void setConnectTimeout(int timeout) Sets the read timeout to a specified timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout. Parameters timeout:int an `int` that specifies the timeout value to be used in milliseconds Exceptions IllegalArgumentException: if the timeout parameter is negative Since 3.0

public void setConnectTimeout(int timeout)

Sets the read timeout to a specified timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout.

Parameters

timeout:int: an int that specifies the timeout value to be used in milliseconds

Exceptions

IllegalArgumentException:: if the timeout parameter is negative

Since

3.0

setReadTimeout back to summary

setReadTimeout	back to summary
public void setReadTimeout(int timeout) Sets the read timeout to a specified timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout. Parameters timeout:int an `int` that specifies the timeout value to be used in milliseconds Exceptions IllegalArgumentException: if the timeout parameter is negative Since 3.0

public void setReadTimeout(int timeout)

Sets the read timeout to a specified timeout, in milliseconds. A timeout of zero is interpreted as an infinite timeout.

Parameters

timeout:int: an int that specifies the timeout value to be used in milliseconds

Exceptions

IllegalArgumentException:: if the timeout parameter is negative

Since

3.0

public abstract Class SOAPConnection

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail