You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ol...@apache.org on 2014/09/05 03:29:44 UTC

[10/12] git commit: formatting and add @since 2.7

formatting and add @since 2.7


Project: http://git-wip-us.apache.org/repos/asf/maven-wagon/repo
Commit: http://git-wip-us.apache.org/repos/asf/maven-wagon/commit/d6746d87
Tree: http://git-wip-us.apache.org/repos/asf/maven-wagon/tree/d6746d87
Diff: http://git-wip-us.apache.org/repos/asf/maven-wagon/diff/d6746d87

Branch: refs/heads/master
Commit: d6746d873313fb083e3b5dfd0d85392e0629eec3
Parents: ba89e09
Author: Olivier Lamy <ol...@apache.org>
Authored: Fri Sep 5 11:04:58 2014 +1000
Committer: Olivier Lamy <ol...@apache.org>
Committed: Fri Sep 5 11:04:58 2014 +1000

----------------------------------------------------------------------
 .../maven/wagon/http/HttpWagonTestCase.java     | 104 ++++++++++---------
 .../providers/http/AbstractHttpClientWagon.java |  92 ++++++++--------
 .../maven/wagon/providers/http/HttpWagon.java   |  27 +++--
 3 files changed, 117 insertions(+), 106 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/maven-wagon/blob/d6746d87/wagon-provider-test/src/main/java/org/apache/maven/wagon/http/HttpWagonTestCase.java
----------------------------------------------------------------------
diff --git a/wagon-provider-test/src/main/java/org/apache/maven/wagon/http/HttpWagonTestCase.java b/wagon-provider-test/src/main/java/org/apache/maven/wagon/http/HttpWagonTestCase.java
index e20dc40..ffe49b4 100644
--- a/wagon-provider-test/src/main/java/org/apache/maven/wagon/http/HttpWagonTestCase.java
+++ b/wagon-provider-test/src/main/java/org/apache/maven/wagon/http/HttpWagonTestCase.java
@@ -52,7 +52,6 @@ import javax.servlet.ServletException;
 import javax.servlet.ServletInputStream;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
-
 import java.io.ByteArrayOutputStream;
 import java.io.File;
 import java.io.FileInputStream;
@@ -246,7 +245,7 @@ public abstract class HttpWagonTestCase
     }
 
     public void testList429()
-            throws Exception
+        throws Exception
     {
         StreamingWagon wagon = (StreamingWagon) getWagon();
         try
@@ -255,17 +254,19 @@ public abstract class HttpWagonTestCase
             Server server = new Server( 0 );
             final AtomicBoolean called = new AtomicBoolean();
 
-            AbstractHandler handler = new AbstractHandler() {
-                public void handle(String s, HttpServletRequest request, HttpServletResponse response, int i) throws IOException, ServletException
+            AbstractHandler handler = new AbstractHandler()
+            {
+                public void handle( String s, HttpServletRequest request, HttpServletResponse response, int i )
+                    throws IOException, ServletException
                 {
-                    if (called.get())
+                    if ( called.get() )
                     {
                         response.setStatus( 200 );
                         ( (Request) request ).setHandled( true );
                     }
                     else
                     {
-                        called.set(true);
+                        called.set( true );
                         response.setStatus( 429 );
                         ( (Request) request ).setHandled( true );
 
@@ -281,7 +282,7 @@ public abstract class HttpWagonTestCase
 
             try
             {
-                wagon.getFileList("resource");
+                wagon.getFileList( "resource" );
             }
             finally
             {
@@ -295,11 +296,15 @@ public abstract class HttpWagonTestCase
         {
             assertTrue( true );
         }
-        catch ( TransferFailedException e ) {
-            if (wagon.getClass().getName().contains("Lightweight")) {
+        catch ( TransferFailedException e )
+        {
+            if ( wagon.getClass().getName().contains( "Lightweight" ) )
+            {
                 //we don't care about lightweight
                 assertTrue( true );
-            } else {
+            }
+            else
+            {
                 fail();
             }
 
@@ -316,7 +321,7 @@ public abstract class HttpWagonTestCase
         }
         catch ( TransferFailedException e )
         {
-            assertTrue(true);
+            assertTrue( true );
         }
     }
 
@@ -336,7 +341,7 @@ public abstract class HttpWagonTestCase
 
         try
         {
-            wagon.getToStream("resource", new ByteArrayOutputStream());
+            wagon.getToStream( "resource", new ByteArrayOutputStream() );
             fail();
         }
         finally
@@ -389,26 +394,28 @@ public abstract class HttpWagonTestCase
     }
 
     public void testResourceExists429()
-            throws Exception
+        throws Exception
     {
         try
         {
 
             final AtomicBoolean called = new AtomicBoolean();
 
-            AbstractHandler handler = new AbstractHandler() {
-                public void handle(String s, HttpServletRequest request, HttpServletResponse response, int i)
-                        throws IOException, ServletException
+            AbstractHandler handler = new AbstractHandler()
+            {
+                public void handle( String s, HttpServletRequest request, HttpServletResponse response, int i )
+                    throws IOException, ServletException
                 {
-                    if (called.get())
+                    if ( called.get() )
                     {
-                        response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
-                        ((Request) request).setHandled(true);
-                    } else
+                        response.setStatus( HttpServletResponse.SC_INTERNAL_SERVER_ERROR );
+                        ( (Request) request ).setHandled( true );
+                    }
+                    else
                     {
-                        called.set(true);
-                        response.setStatus(429);
-                        ((Request) request).setHandled(true);
+                        called.set( true );
+                        response.setStatus( 429 );
+                        ( (Request) request ).setHandled( true );
                     }
                 }
             };
@@ -431,7 +438,6 @@ public abstract class HttpWagonTestCase
                 server.stop();
             }
 
-
             fail();
         }
         catch ( TransferFailedException e )
@@ -1410,48 +1416,51 @@ public abstract class HttpWagonTestCase
     }
 
     public void testPut429()
-            throws Exception
+        throws Exception
     {
 
-        try {
-
+        try
+        {
 
             StreamingWagon wagon = (StreamingWagon) getWagon();
-            Server server = new Server(0);
+            Server server = new Server( 0 );
             final AtomicBoolean called = new AtomicBoolean();
 
-            AbstractHandler handler = new AbstractHandler() {
-                public void handle(String s, HttpServletRequest request, HttpServletResponse response, int i)
-                        throws IOException, ServletException
+            AbstractHandler handler = new AbstractHandler()
+            {
+                public void handle( String s, HttpServletRequest request, HttpServletResponse response, int i )
+                    throws IOException, ServletException
                 {
-                    if (called.get())
+                    if ( called.get() )
                     {
-                        response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
-                        ((Request) request).setHandled(true);
-                    } else
+                        response.setStatus( HttpServletResponse.SC_INTERNAL_SERVER_ERROR );
+                        ( (Request) request ).setHandled( true );
+                    }
+                    else
                     {
-                        called.set(true);
-                        response.setStatus(429);
-                        ((Request) request).setHandled(true);
+                        called.set( true );
+                        response.setStatus( 429 );
+                        ( (Request) request ).setHandled( true );
                     }
                 }
             };
 
-            server.setHandler(handler);
-            addConnectors(server);
+            server.setHandler( handler );
+            addConnectors( server );
             server.start();
 
-            wagon.connect(new Repository("id", getRepositoryUrl(server)));
+            wagon.connect( new Repository( "id", getRepositoryUrl( server ) ) );
 
-            File tempFile = File.createTempFile("wagon", "tmp");
+            File tempFile = File.createTempFile( "wagon", "tmp" );
             tempFile.deleteOnExit();
-            FileUtils.fileWrite(tempFile.getAbsolutePath(), "content");
+            FileUtils.fileWrite( tempFile.getAbsolutePath(), "content" );
 
             try
             {
-                wagon.put(tempFile, "resource");
+                wagon.put( tempFile, "resource" );
                 fail();
-            } finally
+            }
+            finally
             {
                 wagon.disconnect();
 
@@ -1460,11 +1469,12 @@ public abstract class HttpWagonTestCase
                 tempFile.delete();
             }
 
-        } catch ( TransferFailedException e )
+        }
+        catch ( TransferFailedException e )
         {
             assertTrue( true );
         }
-      }
+    }
 
 
     private void runTestPut( int status )

http://git-wip-us.apache.org/repos/asf/maven-wagon/blob/d6746d87/wagon-providers/wagon-http/src/main/java/org/apache/maven/wagon/providers/http/AbstractHttpClientWagon.java
----------------------------------------------------------------------
diff --git a/wagon-providers/wagon-http/src/main/java/org/apache/maven/wagon/providers/http/AbstractHttpClientWagon.java b/wagon-providers/wagon-http/src/main/java/org/apache/maven/wagon/providers/http/AbstractHttpClientWagon.java
index 34ba447..6e7cf9e 100755
--- a/wagon-providers/wagon-http/src/main/java/org/apache/maven/wagon/providers/http/AbstractHttpClientWagon.java
+++ b/wagon-providers/wagon-http/src/main/java/org/apache/maven/wagon/providers/http/AbstractHttpClientWagon.java
@@ -19,25 +19,6 @@ package org.apache.maven.wagon.providers.http;
  * under the License.
  */
 
-import java.io.ByteArrayInputStream;
-import java.io.Closeable;
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.OutputStream;
-import java.nio.ByteBuffer;
-import java.text.SimpleDateFormat;
-import java.util.Date;
-import java.util.Locale;
-import java.util.Map;
-import java.util.Properties;
-import java.util.TimeZone;
-import java.util.concurrent.TimeUnit;
-
-import javax.net.ssl.HttpsURLConnection;
-import javax.net.ssl.SSLContext;
-
 import org.apache.http.Header;
 import org.apache.http.HttpEntity;
 import org.apache.http.HttpException;
@@ -94,6 +75,24 @@ import org.apache.maven.wagon.shared.http.EncodingUtil;
 import org.codehaus.plexus.util.IOUtil;
 import org.codehaus.plexus.util.StringUtils;
 
+import javax.net.ssl.HttpsURLConnection;
+import javax.net.ssl.SSLContext;
+import java.io.ByteArrayInputStream;
+import java.io.Closeable;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.nio.ByteBuffer;
+import java.text.SimpleDateFormat;
+import java.util.Date;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Properties;
+import java.util.TimeZone;
+import java.util.concurrent.TimeUnit;
+
 /**
  * @author <a href="michal.maczka@dimatics.com">Michal Maczka</a>
  * @author <a href="mailto:james@atlassian.com">James William Dumay</a>
@@ -270,7 +269,6 @@ public abstract class AbstractHttpClientWagon
     private static final PoolingHttpClientConnectionManager CONN_MAN = createConnManager();
 
 
-
     /**
      * See RFC6585
      */
@@ -284,27 +282,29 @@ public abstract class AbstractHttpClientWagon
      * Initial seconds to back off when a HTTP 429 received.
      * Subsequent 429 responses result in exponental backoff.
      * <b>5 by default</b>
+     * @since 2.7
      */
     protected final static int INITIAL_BACKOFF_SECONDS =
-            Integer.parseInt( System.getProperty( "maven.wagon.httpconnectionManager.backoffSeconds", "5" ) );
+        Integer.parseInt( System.getProperty( "maven.wagon.httpconnectionManager.backoffSeconds", "5" ) );
 
     /**
      * The maximum amount of time we want to back off in the case of
      * repeated HTTP 429 response codes.
+     * @since 2.7
      */
     protected final static int MAX_WAIT_SECONDS =
-            Integer.parseInt( System.getProperty( "maven.wagon.httpconnectionManager.maxBackoffSeconds", "180" ) );
-
+        Integer.parseInt( System.getProperty( "maven.wagon.httpconnectionManager.maxBackoffSeconds", "180" ) );
 
 
-    protected int backoff(int wait, String url) throws InterruptedException, TransferFailedException
+    protected int backoff( int wait, String url )
+        throws InterruptedException, TransferFailedException
     {
-        TimeUnit.SECONDS.sleep(wait);
+        TimeUnit.SECONDS.sleep( wait );
         int nextWait = wait * 2;
-        if (nextWait >= MAX_WAIT_SECONDS)
+        if ( nextWait >= MAX_WAIT_SECONDS )
         {
             throw new TransferFailedException(
-                    "Waited too long to access: " + url + ". Return code is: " + SC_TOO_MANY_REQUESTS);
+                "Waited too long to access: " + url + ". Return code is: " + SC_TOO_MANY_REQUESTS );
         }
         return nextWait;
     }
@@ -524,7 +524,7 @@ public abstract class AbstractHttpClientWagon
     {
         put( resource, source, httpEntity, buildUrl( resource ) );
     }
-    
+
     /**
      * Builds a complete URL string from the repository URL and the relative path of the resource passed.
      *
@@ -533,19 +533,19 @@ public abstract class AbstractHttpClientWagon
      */
     private String buildUrl( Resource resource )
     {
-    	return EncodingUtil.encodeURLToString( getRepository().getUrl(), resource.getName() );
+        return EncodingUtil.encodeURLToString( getRepository().getUrl(), resource.getName() );
     }
 
 
-    private void put(Resource resource, File source, HttpEntity httpEntity, String url )
-            throws TransferFailedException, AuthorizationException, ResourceDoesNotExistException
+    private void put( Resource resource, File source, HttpEntity httpEntity, String url )
+        throws TransferFailedException, AuthorizationException, ResourceDoesNotExistException
     {
-        put(INITIAL_BACKOFF_SECONDS, resource, source, httpEntity, url);
+        put( INITIAL_BACKOFF_SECONDS, resource, source, httpEntity, url );
     }
 
 
-    private void put(int wait, Resource resource, File source, HttpEntity httpEntity, String url )
-    throws TransferFailedException, AuthorizationException, ResourceDoesNotExistException
+    private void put( int wait, Resource resource, File source, HttpEntity httpEntity, String url )
+        throws TransferFailedException, AuthorizationException, ResourceDoesNotExistException
     {
 
         //Parent directories need to be created before posting
@@ -620,9 +620,9 @@ public abstract class AbstractHttpClientWagon
                         throw new ResourceDoesNotExistException( "File: " + url + " does not exist" + reasonPhrase );
 
                     case SC_TOO_MANY_REQUESTS:
-                        put(backoff(wait, url), resource, source, httpEntity, url);
+                        put( backoff( wait, url ), resource, source, httpEntity, url );
                         break;
-                        //add more entries here
+                    //add more entries here
                     default:
                     {
                         TransferFailedException e = new TransferFailedException(
@@ -677,12 +677,13 @@ public abstract class AbstractHttpClientWagon
     }
 
     public boolean resourceExists( String resourceName )
-            throws TransferFailedException, AuthorizationException {
-        return resourceExists( INITIAL_BACKOFF_SECONDS, resourceName);
+        throws TransferFailedException, AuthorizationException
+    {
+        return resourceExists( INITIAL_BACKOFF_SECONDS, resourceName );
     }
 
 
-    private boolean resourceExists(int wait,  String resourceName )
+    private boolean resourceExists( int wait, String resourceName )
         throws TransferFailedException, AuthorizationException
     {
         String repositoryUrl = getRepository().getUrl();
@@ -718,7 +719,7 @@ public abstract class AbstractHttpClientWagon
                         break;
 
                     case SC_TOO_MANY_REQUESTS:
-                        return resourceExists(backoff(wait, resourceName), resourceName);
+                        return resourceExists( backoff( wait, resourceName ), resourceName );
 
                     //add more entries here
                     default:
@@ -909,11 +910,12 @@ public abstract class AbstractHttpClientWagon
     }
 
     public void fillInputData( InputData inputData )
-            throws TransferFailedException, ResourceDoesNotExistException, AuthorizationException {
-        fillInputData(INITIAL_BACKOFF_SECONDS, inputData);
+        throws TransferFailedException, ResourceDoesNotExistException, AuthorizationException
+    {
+        fillInputData( INITIAL_BACKOFF_SECONDS, inputData );
     }
 
-    private void fillInputData(int wait, InputData inputData )
+    private void fillInputData( int wait, InputData inputData )
         throws TransferFailedException, ResourceDoesNotExistException, AuthorizationException
     {
         Resource resource = inputData.getResource();
@@ -965,10 +967,10 @@ public abstract class AbstractHttpClientWagon
                     throw new ResourceDoesNotExistException( "File: " + url + " " + reasonPhrase );
 
                 case SC_TOO_MANY_REQUESTS:
-                    fillInputData(backoff(wait, url), inputData);
+                    fillInputData( backoff( wait, url ), inputData );
                     break;
 
-                    // add more entries here
+                // add more entries here
                 default:
                 {
                     cleanupGetTransfer( resource );

http://git-wip-us.apache.org/repos/asf/maven-wagon/blob/d6746d87/wagon-providers/wagon-http/src/main/java/org/apache/maven/wagon/providers/http/HttpWagon.java
----------------------------------------------------------------------
diff --git a/wagon-providers/wagon-http/src/main/java/org/apache/maven/wagon/providers/http/HttpWagon.java b/wagon-providers/wagon-http/src/main/java/org/apache/maven/wagon/providers/http/HttpWagon.java
index 2048937..9634ce6 100755
--- a/wagon-providers/wagon-http/src/main/java/org/apache/maven/wagon/providers/http/HttpWagon.java
+++ b/wagon-providers/wagon-http/src/main/java/org/apache/maven/wagon/providers/http/HttpWagon.java
@@ -19,11 +19,6 @@ package org.apache.maven.wagon.providers.http;
  * under the License.
  */
 
-import java.io.IOException;
-import java.util.Collections;
-import java.util.List;
-import java.util.concurrent.TimeUnit;
-
 import org.apache.http.HttpEntity;
 import org.apache.http.HttpException;
 import org.apache.http.HttpStatus;
@@ -34,21 +29,24 @@ import org.apache.maven.wagon.TransferFailedException;
 import org.apache.maven.wagon.authorization.AuthorizationException;
 import org.apache.maven.wagon.shared.http.HtmlFileListParser;
 
+import java.io.IOException;
+import java.util.Collections;
+import java.util.List;
+
 /**
  * @author <a href="michal.maczka@dimatics.com">Michal Maczka</a>
- *
  */
 public class HttpWagon
     extends AbstractHttpClientWagon
 {
 
-    public List<String> getFileList(String destinationDirectory )
-            throws AuthorizationException, ResourceDoesNotExistException, TransferFailedException
+    public List<String> getFileList( String destinationDirectory )
+        throws AuthorizationException, ResourceDoesNotExistException, TransferFailedException
     {
-        return getFileList(INITIAL_BACKOFF_SECONDS, destinationDirectory);
+        return getFileList( INITIAL_BACKOFF_SECONDS, destinationDirectory );
     }
-    
-    private List<String> getFileList(int wait,  String destinationDirectory )
+
+    private List<String> getFileList( int wait, String destinationDirectory )
         throws TransferFailedException, ResourceDoesNotExistException, AuthorizationException
     {
         if ( destinationDirectory.length() > 0 && !destinationDirectory.endsWith( "/" ) )
@@ -63,7 +61,8 @@ public class HttpWagon
         try
         {
             CloseableHttpResponse response = execute( getMethod );
-            try {
+            try
+            {
                 int statusCode = response.getStatusLine().getStatusCode();
 
                 fireTransferDebug( url + " - Status code: " + statusCode );
@@ -86,9 +85,9 @@ public class HttpWagon
                         throw new ResourceDoesNotExistException( "File: " + url + " does not exist" );
 
                     case SC_TOO_MANY_REQUESTS:
-                        return getFileList(backoff(wait, url), destinationDirectory);
+                        return getFileList( backoff( wait, url ), destinationDirectory );
 
-                        //add more entries here
+                    //add more entries here
                     default:
                         throw new TransferFailedException(
                             "Failed to transfer file: " + url + ". Return code is: " + statusCode );