Merge pull request #436 from rpmoore/3_2_11

Adding an aggregate exception class to the interface module to be use…

Author: GraciesPadre

build.gradle

@@ -15,7 +15,7 @@
 
 allprojects {
     group = 'com.spectralogic.ds3'
-    version = '3.2.10'
+    version = '3.2.11'
 }
 
 subprojects {

ds3-interfaces/build.gradle

@@ -7,7 +7,12 @@ buildscript {
 
 apply plugin: 'com.github.johnrengelman.shadow'
 
+dependencies {
+    compile 'commons-io:commons-io:2.4'
+}
+
 shadowJar {
+    relocate 'org.apache', 'ds3fatjar.org.apache'
     dependencies {
         exclude(dependency('org.hamcrest:hamcrest-library:1.3'))
         exclude(dependency('org.mockito:mockito-core:1.10.19'))

ds3-interfaces/src/main/java/com/spectralogic/ds3client/exceptions/AggregateException.java

@@ -0,0 +1,60 @@
+/*
+ * ****************************************************************************
+ *    Copyright 2014-2016 Spectra Logic Corporation. All Rights Reserved.
+ *    Licensed under the Apache License, Version 2.0 (the "License"). You may not use
+ *    this file except in compliance with the License. A copy of the License is located at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    or in the "license" file accompanying this file.
+ *    This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ *    CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ *    specific language governing permissions and limitations under the License.
+ *  ****************************************************************************
+ */
+
+package com.spectralogic.ds3client.exceptions;
+
+import org.apache.commons.io.output.StringBuilderWriter;
+
+import java.io.PrintWriter;
+import java.util.ArrayList;
+import java.util.List;
+
+public class AggregateException extends RuntimeException {
+
+    private final List<Throwable> exceptions;
+
+    public AggregateException(final Iterable<Throwable> exceptions) {
+        super("One or more exceptions were aggregated together");
+        this.exceptions = exceptionList(exceptions);
+    }
+
+    private static List<Throwable> exceptionList(final Iterable<Throwable> exceptions) {
+        final List<Throwable> exceptionList = new ArrayList<>();
+        for (final Throwable t : exceptions) {
+            exceptionList.add(t);
+        }
+        return exceptionList;
+    }
+
+    public Iterable<Throwable> getExceptions() {
+        return exceptions;
+    }
+
+    public String toString() {
+        final StringBuilder builder = new StringBuilder();
+        builder.append("One or more exceptions were aggregated:");
+
+        try (final StringBuilderWriter writer = new StringBuilderWriter(builder);
+             final PrintWriter printWriter = new PrintWriter(writer)) {
+
+            for (final Throwable t : exceptions) {
+                printWriter.append("Exception: ").append(t.getMessage());
+                t.printStackTrace(printWriter);
+            }
+        }
+
+        return builder.toString();
+    }
+}

ds3-interfaces/src/test/java/com/spectralogic/ds3client/exceptions/AggregateException_Test.java

@@ -0,0 +1,73 @@
+/*
+ * ****************************************************************************
+ *    Copyright 2014-2016 Spectra Logic Corporation. All Rights Reserved.
+ *    Licensed under the Apache License, Version 2.0 (the "License"). You may not use
+ *    this file except in compliance with the License. A copy of the License is located at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    or in the "license" file accompanying this file.
+ *    This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ *    CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ *    specific language governing permissions and limitations under the License.
+ *  ****************************************************************************
+ */
+
+package com.spectralogic.ds3client.exceptions;
+
+import org.junit.Test;
+
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.CoreMatchers.notNullValue;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertThat;
+import static org.junit.Assert.assertTrue;
+
+public class AggregateException_Test {
+
+    @Test
+    public void basicAggregate() {
+        final Exception e1 = new Exception("first exception");
+        final Exception e2 = new Exception("second exception");
+
+        final List<Throwable> exceptionList = new ArrayList<>();
+        exceptionList.add(e1);
+        exceptionList.add(e2);
+
+        final AggregateException aggregateException = new AggregateException(exceptionList);
+
+        final Iterator<Throwable> exceptionIter = aggregateException.getExceptions().iterator();
+
+        assertTrue(exceptionIter.hasNext());
+        assertThat(exceptionIter.next(), is(notNullValue()));
+        assertTrue(exceptionIter.hasNext());
+        assertThat(exceptionIter.next(), is(notNullValue()));
+        assertFalse(exceptionIter.hasNext());
+    }
+
+    @Test
+    public void repeatIteration() {
+        final Exception e1 = new Exception("first exception");
+
+        final List<Throwable> exceptionList = new ArrayList<>();
+        exceptionList.add(e1);
+
+        final AggregateException aggregateException = new AggregateException(exceptionList);
+
+        final Iterator<Throwable> exceptionIter = aggregateException.getExceptions().iterator();
+
+        assertTrue(exceptionIter.hasNext());
+        assertThat(exceptionIter.next(), is(notNullValue()));
+        assertFalse(exceptionIter.hasNext());
+
+        final Iterator<Throwable> repeatIter = aggregateException.getExceptions().iterator();
+        assertTrue(repeatIter.hasNext());
+        assertThat(repeatIter.next(), is(notNullValue()));
+        assertFalse(repeatIter.hasNext());
+
+    }
+}

ds3-metadata/src/main/java/com/spectralogic/ds3client/metadata/MetadataReceivedListenerImpl.java

@@ -15,15 +15,24 @@
 
 package com.spectralogic.ds3client.metadata;
 
+import com.google.common.collect.ImmutableList;
+import com.spectralogic.ds3client.exceptions.AggregateException;
 import com.spectralogic.ds3client.helpers.MetadataReceivedListener;
 import com.spectralogic.ds3client.metadata.interfaces.MetadataRestore;
 import com.spectralogic.ds3client.networking.Metadata;
+import com.spectralogic.ds3client.utils.Guard;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
 
 public class MetadataReceivedListenerImpl implements MetadataReceivedListener {
+
+    private final static Logger LOG = LoggerFactory.getLogger(MetadataReceivedListenerImpl.class);
+
     private final String localFilePath;
 
+
     public MetadataReceivedListenerImpl(final String localFilePath) {
         this.localFilePath = localFilePath;
     }
@@ -45,17 +54,41 @@ public void metadataReceived(final String filename, final Metadata metadata) {
      * @param metadata   metadata which needs to be set on local file
      */
     private void restoreMetaData(final String objectName, final Metadata metadata) throws IOException, InterruptedException {
+
+        final ImmutableList.Builder<Throwable> exceptionBuilder = ImmutableList.builder();
+
         //get metadatarestore on the basis of os
         final MetadataRestore metadataRestore = new MetadataRestoreFactory().getOSSpecificMetadataRestore(metadata, objectName);
         //restore os name
         metadataRestore.restoreOSName();
+
         //restore user and owner based on OS
-        metadataRestore.restoreUserAndOwner();
+        try {
+            metadataRestore.restoreUserAndOwner();
+        } catch (final Throwable t) {
+             LOG.error("Could not restore owner and owner information", t);
+             exceptionBuilder.add(t);
+        }
+
         //restore creation and modified time based on OS
-        metadataRestore.restoreFileTimes();
-        //restore permissions based on OS
-        metadataRestore.restorePermissions();
-    }
+        try {
+            metadataRestore.restoreFileTimes();
+        } catch (final Throwable t) {
+            LOG.error("Could not restore the file times", t);
+            exceptionBuilder.add(t);
+        }
 
+        //restore permissions based on OS
+        try {
+            metadataRestore.restorePermissions();
+        } catch (final Throwable t) {
+            LOG.error("Could not restore the file permissions", t);
+            exceptionBuilder.add(t);
+        }
 
+        final ImmutableList<Throwable> exceptions = exceptionBuilder.build();
+        if (!Guard.isNullOrEmpty(exceptions)) {
+            throw new AggregateException(exceptions);
+        }
+    }
 }

ds3-sdk/build.gradle

@@ -77,7 +77,6 @@ jar.dependsOn genConfigProperties
 
 dependencies {
     compile     'org.apache.httpcomponents:httpclient:4.5.1'
-    compile     'commons-io:commons-io:2.4'
     compile     'org.codehaus.woodstox:woodstox-core-asl:4.4.1'
     compile     'com.fasterxml.jackson.dataformat:jackson-dataformat-xml:2.7.1'
     compile     'com.google.guava:guava:20.0'