Package org.gcube.common.gxhttp.request

Class GXHTTPStreamRequest

java.lang.Object
org.gcube.common.gxhttp.request.GXHTTPStreamRequest
All Implemented Interfaces:
GXHTTP<InputStream,HttpURLConnection>
@Deprecated(since="1.1.0", forRemoval=true) public class GXHTTPStreamRequest extends Object implements GXHTTP<InputStream,HttpURLConnection>
Deprecated, for removal: This API element is subject to removal in a future version.
use GXRequest, which returns a GXResponse
A context-aware request to a web application. It supports sending streams through Put/Post requests.
Author:
Manuele Simi (ISTI CNR), Luca Frosini (ISTI-CNR)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected GXHTTPRequestBuilder
    builder
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected static final org.slf4j.Logger
    logger
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Clear up the request.
    HttpURLConnection
    connect()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    GXHTTPStreamRequest
    connectTimeout(int connectTimeout)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the connect timeout of the request.
    HttpURLConnection
    delete()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    GXHTTPStreamRequest
    from(String agent)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the User-Agent for the request
    HttpURLConnection
    get()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    HttpURLConnection
    head()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    GXHTTPStreamRequest
    header(String name, String value)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Adds a header to the request
    static GXHTTPStreamRequest
    newRequest(String address)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new request.
    HttpURLConnection
    options()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    HttpURLConnection
    patch()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    HttpURLConnection
    patch(InputStream body)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sends the PATCH request to the web application.
    GXHTTPStreamRequest
    path(String path)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Adds a path to the request URL
    HttpURLConnection
    post()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    HttpURLConnection
    post(InputStream body)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sends the POST request to the web application.
    HttpURLConnection
    purge()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    HttpURLConnection
    put()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    HttpURLConnection
    put(InputStream body)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sends the PUT request to the web application.
    GXHTTPStreamRequest
    queryParams(Map<String,String> queryParams)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Adds query parameters to the request
    GXHTTPStreamRequest
    readTimeout(int readTimeout)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the read timeout of the request.
    HttpURLConnection
    trace()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.gcube.common.gxhttp.reference.GXHTTP

    connect, delete, get, head, options, patch, post, purge, put, trace

  • Field Details

    • logger

      protected static final org.slf4j.Logger logger
      Deprecated, for removal: This API element is subject to removal in a future version.

    • builder

      protected GXHTTPRequestBuilder builder
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • newRequest

      public static GXHTTPStreamRequest newRequest(String address)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new request.
      Parameters:
      address - the address of the web app to call
      Returns:
      the request

    • put

      public HttpURLConnection put(InputStream body) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: GXHTTP
      Sends the PUT request to the web application.
      Specified by:
      put in interface GXHTTP<InputStream,HttpURLConnection>
      Parameters:
      body - the body of the request
      Returns:
      the response
      Throws:
      Exception - if an error occurs

    • post

      public HttpURLConnection post(InputStream body) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: GXHTTP
      Sends the POST request to the web application.
      Specified by:
      post in interface GXHTTP<InputStream,HttpURLConnection>
      Parameters:
      body - the body of the request
      Returns:
      the response
      Throws:
      Exception - if an error occurs

    • patch

      public HttpURLConnection patch(InputStream body) throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: GXHTTP
      Sends the PATCH request to the web application.
      Specified by:
      patch in interface GXHTTP<InputStream,HttpURLConnection>
      Parameters:
      body - the body of the request
      Returns:
      the response
      Throws:
      Exception - if an error occurs

    • from

      public GXHTTPStreamRequest from(String agent)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the User-Agent for the request
      Parameters:
      agent - the agent
      Returns:
      the request

    • path

      public GXHTTPStreamRequest path(String path) throws UnsupportedEncodingException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Adds a path to the request URL
      Parameters:
      path - the path to add
      Returns:
      the request
      Throws:
      UnsupportedEncodingException - if the encoding is not supported

    • header

      public GXHTTPStreamRequest header(String name, String value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Adds a header to the request
      Parameters:
      name - the name of the header
      value - the value of the header
      Returns:
      the request

    • connectTimeout

      public GXHTTPStreamRequest connectTimeout(int connectTimeout)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the connect timeout of the request.
      Parameters:
      connectTimeout - the timeout in milliseconds; 0 means infinite
      Returns:
      the request

    • readTimeout

      public GXHTTPStreamRequest readTimeout(int readTimeout)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sets the read timeout of the request.
      Parameters:
      readTimeout - the timeout in milliseconds; 0 means infinite
      Returns:
      the request

    • queryParams

      public GXHTTPStreamRequest queryParams(Map<String,String> queryParams) throws UnsupportedEncodingException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Adds query parameters to the request
      Parameters:
      queryParams - the query parameters
      Returns:
      the request
      Throws:
      UnsupportedEncodingException - if the encoding is not supported

    • put

      public HttpURLConnection put() throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      Exception

    • delete

      public HttpURLConnection delete() throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      Exception

    • purge

      public HttpURLConnection purge() throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      Exception

    • head

      public HttpURLConnection head() throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      Exception

    • get

      public HttpURLConnection get() throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      Exception

    • post

      public HttpURLConnection post() throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      Exception

    • trace

      public HttpURLConnection trace() throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      Exception

    • patch

      public HttpURLConnection patch() throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      Exception

    • options

      public HttpURLConnection options() throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      Exception

    • connect

      public HttpURLConnection connect() throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      Exception

    • clear

      public void clear()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Clear up the request.