Changeset 9178 in josm for trunk/src

Timestamp:

2015-12-27T16:02:24+01:00 (9 years ago)

Author:

Don-vip

Message:

see #12231 - add support for setFixedLengthStreamingMode (used in DirectUpload plugin)

File:

• trunk/src/org/openstreetmap/josm/tools/HttpClient.java (modified) (14 diffs)

trunk/src/org/openstreetmap/josm/tools/HttpClient.java

@@ -9 +9 @@
 import java.io.InputStream;
 import java.io.OutputStream;
+import java.net.HttpRetryException;
 import java.net.HttpURLConnection;
 import java.net.URL;
@@ -36 +37 @@
     private byte[] requestBody;
     private long ifModifiedSince;
+    private long contentLength;
     private final Map<String, String> headers = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
     private int maxRedirects = Main.pref.getInteger("socket.maxredirects", 5);
@@ -61 +63 @@
         if (ifModifiedSince > 0) {
             connection.setIfModifiedSince(ifModifiedSince);
+        }
+        if (contentLength > 0) {
+            connection.setFixedLengthStreamingMode(contentLength);
         }
         connection.setUseCaches(useCache);
@@ -158 +163 @@
          * {@code Content-Disposition}
          * @return {@code this}
+         * @since 9172
          */
         public Response uncompressAccordingToContentDisposition(boolean uncompressAccordingToContentDisposition) {
@@ -168 +174 @@
          * @return the URL
          * @see HttpURLConnection#getURL()
+         * @since 9172
          */
         public URL getURL() {
@@ -177 +184 @@
          * @return the HTTP request method
          * @see HttpURLConnection#getRequestMethod()
+         * @since 9172
          */
         public String getRequestMethod() {
@@ -260 +268 @@
          *
          * @see HttpURLConnection#getResponseMessage()
+         * @since 9172
          */
         public String getResponseMessage() {
@@ -294 +303 @@
          * @return the value of the named header field, or {@code null} if there is no such field in the header
          * @see HttpURLConnection#getHeaderField(String)
+         * @since 9172
          */
         public String getHeaderField(String name) {
@@ -304 +314 @@
          * @return unmodifiable List of Strings that represents the corresponding field values
          * @see HttpURLConnection#getHeaderFields()
+         * @since 9172
          */
         public List<String> getHeaderFields(String name) {
@@ -353 +364 @@
      * @see #create(URL)
      * @see #create(URL, String)
+     * @since 9172
      */
     public URL getURL() {
@@ -362 +374 @@
      * @return the HTTP request method
      * @see #create(URL, String)
+     * @since 9172
      */
     public String getRequestMethod() {
@@ -371 +384 @@
      * @param header HTTP header name
      * @return HTTP header value
+     * @since 9172
      */
     public String getRequestHeader(String header) {
@@ -420 +434 @@
      * @param readTimeout an {@code int} that specifies the read timeout value in milliseconds
      * @return {@code this}
-     * @see HttpURLConnection#setReadTimeout(int) (int)
+     * @see HttpURLConnection#setReadTimeout(int)
      */
     public HttpClient setReadTimeout(int readTimeout) {
         this.readTimeout = readTimeout;
+        return this;
+    }
+
+    /**
+     * This method is used to enable streaming of a HTTP request body without internal buffering,
+     * when the content length is known in advance.
+     * <p>
+     * An exception will be thrown if the application attempts to write more data than the indicated content-length,
+     * or if the application closes the OutputStream before writing the indicated amount.
+     * <p>
+     * When output streaming is enabled, authentication and redirection cannot be handled automatically.
+     * A {@linkplain HttpRetryException} will be thrown when reading the response if authentication or redirection
+     * are required. This exception can be queried for the details of the error.
+     *
+     * @param contentLength The number of bytes which will be written to the OutputStream
+     * @return {@code this}
+     * @see HttpURLConnection#setFixedLengthStreamingMode(long)
+     * @since 9178
+     */
+    public HttpClient setFixedLengthStreamingMode(long contentLength) {
+        this.contentLength = contentLength;
         return this;
     }
@@ -500 +535 @@
      * @param reasonForRequest Reason to show
      * @return {@code this}
+     * @since 9172
      */
     public HttpClient setReasonForRequest(String reasonForRequest) {