Package org.jsoup

Interface Connection.Base<T extends Connection.Base>

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      T addHeader​(java.lang.String name, java.lang.String value)
      Add a header.
      java.lang.String cookie​(java.lang.String name)
      Get a cookie value by name from this request/response.
      T cookie​(java.lang.String name, java.lang.String value)
      Set a cookie in this request/response.
      java.util.Map<java.lang.String,​java.lang.String> cookies()
      Retrieve all of the request/response cookies as a map
      boolean hasCookie​(java.lang.String name)
      Check if a cookie is present
      boolean hasHeader​(java.lang.String name)
      Check if a header is present
      boolean hasHeaderWithValue​(java.lang.String name, java.lang.String value)
      Check if a header is present, with the given value
      java.lang.String header​(java.lang.String name)
      Get the value of a header.
      T header​(java.lang.String name, java.lang.String value)
      Set a header.
      java.util.Map<java.lang.String,​java.lang.String> headers()
      Retrieve all of the request/response header names and corresponding values as a map.
      java.util.List<java.lang.String> headers​(java.lang.String name)
      Get the values of a header.
      Connection.Method method()
      Get the request method
      T method​(Connection.Method method)
      Set the request method
      java.util.Map<java.lang.String,​java.util.List<java.lang.String>> multiHeaders()
      Retreive all of the headers, keyed by the header name, and with a list of values per header.
      T removeCookie​(java.lang.String name)
      Remove a cookie by name
      T removeHeader​(java.lang.String name)
      Remove headers by name.
      java.net.URL url()
      Get the URL
      T url​(java.net.URL url)
      Set the URL
    • Method Detail

      • url

        java.net.URL url()
        Get the URL
        Returns:
        URL
      • url

        T url​(java.net.URL url)
        Set the URL
        Parameters:
        url - new URL
        Returns:
        this, for chaining
      • method

        T method​(Connection.Method method)
        Set the request method
        Parameters:
        method - new method
        Returns:
        this, for chaining
      • header

        java.lang.String header​(java.lang.String name)
        Get the value of a header. If there is more than one header value with the same name, the headers are returned comma seperated, per rfc2616-sec4.

        Header names are case insensitive.

        Parameters:
        name - name of header (case insensitive)
        Returns:
        value of header, or null if not set.
        See Also:
        hasHeader(String), cookie(String)
      • headers

        java.util.List<java.lang.String> headers​(java.lang.String name)
        Get the values of a header.
        Parameters:
        name - header name, case insensitive.
        Returns:
        a list of values for this header, or an empty list if not set.
      • header

        T header​(java.lang.String name,
                 java.lang.String value)
        Set a header. This method will overwrite any existing header with the same case insensitive name. (If there is more than one value for this header, this method will update the first matching header.
        Parameters:
        name - Name of header
        value - Value of header
        Returns:
        this, for chaining
        See Also:
        addHeader(String, String)
      • addHeader

        T addHeader​(java.lang.String name,
                    java.lang.String value)
        Add a header. The header will be added regardless of whether a header with the same name already exists.
        Parameters:
        name - Name of new header
        value - Value of new header
        Returns:
        this, for chaining
      • hasHeader

        boolean hasHeader​(java.lang.String name)
        Check if a header is present
        Parameters:
        name - name of header (case insensitive)
        Returns:
        if the header is present in this request/response
      • hasHeaderWithValue

        boolean hasHeaderWithValue​(java.lang.String name,
                                   java.lang.String value)
        Check if a header is present, with the given value
        Parameters:
        name - header name (case insensitive)
        value - value (case insensitive)
        Returns:
        if the header and value pair are set in this req/res
      • removeHeader

        T removeHeader​(java.lang.String name)
        Remove headers by name. If there is more than one header with this name, they will all be removed.
        Parameters:
        name - name of header to remove (case insensitive)
        Returns:
        this, for chaining
      • headers

        java.util.Map<java.lang.String,​java.lang.String> headers()
        Retrieve all of the request/response header names and corresponding values as a map. For headers with multiple values, only the first header is returned.

        Note that this is a view of the headers only, and changes made to this map will not be reflected in the request/response object.

        Returns:
        headers
        See Also:
        multiHeaders()
      • multiHeaders

        java.util.Map<java.lang.String,​java.util.List<java.lang.String>> multiHeaders()
        Retreive all of the headers, keyed by the header name, and with a list of values per header.
        Returns:
        a list of multiple values per header.
      • cookie

        java.lang.String cookie​(java.lang.String name)
        Get a cookie value by name from this request/response.

        Response objects have a simplified cookie model. Each cookie set in the response is added to the response object's cookie key=value map. The cookie's path, domain, and expiry date are ignored.

        Parameters:
        name - name of cookie to retrieve.
        Returns:
        value of cookie, or null if not set
      • cookie

        T cookie​(java.lang.String name,
                 java.lang.String value)
        Set a cookie in this request/response.
        Parameters:
        name - name of cookie
        value - value of cookie
        Returns:
        this, for chaining
      • hasCookie

        boolean hasCookie​(java.lang.String name)
        Check if a cookie is present
        Parameters:
        name - name of cookie
        Returns:
        if the cookie is present in this request/response
      • removeCookie

        T removeCookie​(java.lang.String name)
        Remove a cookie by name
        Parameters:
        name - name of cookie to remove
        Returns:
        this, for chaining
      • cookies

        java.util.Map<java.lang.String,​java.lang.String> cookies()
        Retrieve all of the request/response cookies as a map
        Returns:
        cookies