- java.lang.Object
-
- javax.xml.soap.SOAPConnection
-
public abstract class SOAPConnection extends Object
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 anUnsupportedOperationException
.A client can obtain a
SOAPConnection
object using aSOAPConnectionFactory
object as in the following example:SOAPConnectionFactory factory = SOAPConnectionFactory.newInstance(); SOAPConnection con = factory.createConnection();
ASOAPConnection
object can be used to send messages directly to a URL following the request/response paradigm. That is, messages are sent using the methodcall
, which sends the message and then waits until it gets a reply.
-
-
Constructor Summary
Constructors Constructor and Description SOAPConnection()
-
Method Summary
Methods Modifier and Type Method and Description abstract SOAPMessage
call(SOAPMessage request, Object to)
Sends the given message to the specified endpoint and blocks until it has returned the response.abstract void
close()
Closes thisSOAPConnection
object.SOAPMessage
get(Object to)
Gets a message from a specific endpoint and blocks until it receives,
-
-
-
Method Detail
-
call
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
- theSOAPMessage
object to be sentto
- anObject
that identifies where the message should be sent. It is required to support Objects of typejava.lang.String
,java.net.URL
, and when JAXM is presentjavax.xml.messaging.URLEndpoint
- Returns:
- the
SOAPMessage
object that is the response to the message that was sent - Throws:
SOAPException
- if there is a SOAP error
-
get
public SOAPMessage get(Object to) throws SOAPException
Gets a message from a specific endpoint and blocks until it receives,- Parameters:
to
- anObject
that identifies where the request should be sent. Objects of typejava.lang.String
andjava.net.URL
must be supported.- Returns:
- the
SOAPMessage
object that is the response to the get message request - Throws:
SOAPException
- if there is a SOAP error- Since:
- SAAJ 1.3
-
close
public abstract void close() throws SOAPException
Closes thisSOAPConnection
object.- Throws:
SOAPException
- if there is a SOAP error
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/xml/soap/soapconnection.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.