Package jakarta.xml.soap

Class SOAPConnection

  • All Implemented Interfaces:
    java.lang.AutoCloseable
    public abstract class SOAPConnection
extends java.lang.Object
implements java.lang.AutoCloseable
    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.
    Since:
    1.6

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected SOAPConnection()
      Default constructor.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract SOAPMessage call​(SOAPMessage request, java.lang.Object to)
      Sends the given message to the specified endpoint and blocks until it has returned the response.
      abstract void close()
      Closes this SOAPConnection object.
      SOAPMessage get​(java.lang.Object to)
      Gets a message from a specific endpoint and blocks until it receives,
      int getConnectTimeout()
      Returns setting for connect timeout.
      int getReadTimeout()
      Returns setting for read timeout.
      void setConnectTimeout​(int timeout)
      Sets the read timeout to a specified timeout, in milliseconds.
      void setReadTimeout​(int timeout)
      Sets the read timeout to a specified timeout, in milliseconds.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SOAPConnection

        protected SOAPConnection()
        Default constructor.

    • Method Detail

      • call

        public abstract SOAPMessage call​(SOAPMessage request,
                                 java.lang.Object to)
                          throws SOAPException
        Sends the given message to the specified endpoint and blocks until it has returned the response.
        Parameters:
        request - the SOAPMessage object to be sent
        to - 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:
        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​(java.lang.Object to)
                throws SOAPException
        Gets a message from a specific endpoint and blocks until it receives,
        Parameters:
        to - an Object that identifies where the request should be sent. Objects of type java.lang.String and java.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:
        1.6, SAAJ 1.3

      • setConnectTimeout

        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 - an int that specifies the timeout value to be used in milliseconds
        Throws:
        java.lang.IllegalArgumentException - if the timeout parameter is negative
        Since:
        3.0

      • getConnectTimeout

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

      • setReadTimeout

        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 - an int that specifies the timeout value to be used in milliseconds
        Throws:
        java.lang.IllegalArgumentException - if the timeout parameter is negative
        Since:
        3.0

      • getReadTimeout

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

      • close

        public abstract void close()
                    throws SOAPException
        Closes this SOAPConnection object.
        Specified by:
        close in interface java.lang.AutoCloseable
        Throws:
        SOAPException - if there is a SOAP error