Merge pull request #36 from rpmoore/master

Updating how Logging is Implemented

Author: rpmoore

build.gradle

@@ -25,7 +25,7 @@ apply plugin: 'maven'
 apply plugin: 'idea'
 apply plugin: 'application'
 
-version = '1.1.3'
+version = '1.1.4'
 group = 'com.spectralogic'
 
 mainClassName = 'com.spectralogic.ds3cli.Main'
@@ -44,7 +44,9 @@ dependencies {
   compile 'commons-cli:commons-cli:1.2'
   compile 'com.google.guava:guava:18.0'
   compile 'joda-time:joda-time:2.7'
-  compile 'com.spectralogic.ds3:ds3-sdk:1.1.0-RC3'
+  compile 'ch.qos.logback:logback-core:1.0.13'
+  compile 'ch.qos.logback:logback-classic:1.0.13'
+  compile 'com.spectralogic.ds3:ds3-sdk:1.1.0-RC4'
   compile (
     [group: 'com.fasterxml.jackson.core', name: 'jackson-core', version: '2.2.3'],
     [group: 'com.fasterxml.jackson.core', name: 'jackson-annotations', version: '2.2.3'],
@@ -70,5 +72,5 @@ task genConfigProperties << {
 jar.dependsOn genConfigProperties
 
 task wrapper(type: Wrapper) {
-  gradleVersion = '2.3'
+  gradleVersion = '2.4'
 }

src/main/java/com/spectralogic/ds3cli/Arguments.java

@@ -15,10 +15,12 @@
 
 package com.spectralogic.ds3cli;
 
-import com.spectralogic.ds3cli.logging.Logging;
+import ch.qos.logback.classic.Level;
 import com.spectralogic.ds3client.models.bulk.Priority;
 import com.spectralogic.ds3client.models.bulk.WriteOptimization;
 import org.apache.commons.cli.*;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -28,6 +30,8 @@
 
 public class Arguments {
 
+    private final static Logger LOG = LoggerFactory.getLogger(Arguments.class);
+
     private final static String PROPERTY_FILE = "config.properties";
 
     private final Options options;
@@ -120,6 +124,8 @@ public class Arguments {
         version.setLongOpt("version");
         final Option verbose = new Option(null, "Verbose output");
         verbose.setLongOpt("verbose");
+        final Option debug = new Option(null, "Debug output.  If set takes presidence over the 'verbose' option");
+        debug.setLongOpt("debug");
         final Option viewType = new Option(null, true, "Configure how the output should be displayed.  Possible values: ["+ ViewType.valuesString() +"]");
         viewType.setLongOpt("output-format");
         options.addOption(ds3Endpoint);
@@ -144,6 +150,7 @@ public class Arguments {
         options.addOption(http);
         options.addOption(version);
         options.addOption(verbose);
+        options.addOption(debug);
         options.addOption(viewType);
 
         // Disabled until they are enabled in DS3.
@@ -159,12 +166,21 @@ private void processCommandLine() throws ParseException, BadArgumentException {
         final CommandLine cmd = parser.parse(options, args);
 
         final List<String> missingArgs = new ArrayList<>();
-        if (cmd.hasOption("verbose")) {
-            Logging.setVerbose(true);
-            Logging.log("Verbose output has been enabled");
-            Logging.logf("Version: %s", this.version);
+
+        final ch.qos.logback.classic.Logger rootLogger = (ch.qos.logback.classic.Logger) LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME);
+
+        if (cmd.hasOption("debug")) {
+            rootLogger.setLevel(Level.DEBUG);
+            rootLogger.info("Debug output enabled");
+        } else if (cmd.hasOption("verbose")) {
+            rootLogger.setLevel(Level.INFO);
+            rootLogger.info("Verbose output enabled");
+        } else {
+            rootLogger.setLevel(Level.OFF);
         }
 
+        rootLogger.info("Version: " + this.version);
+
         if (cmd.hasOption('h')) {
             printHelp();
             System.exit(0);
@@ -283,13 +299,13 @@ private void processCommandLine() throws ParseException, BadArgumentException {
         final String proxy = System.getenv("http_proxy");
         if (proxy != null) {
             setProxy(proxy);
-            Logging.logf("Proxy: %s", getProxy());
+            LOG.info("Proxy: %s", getProxy());
         }
 
         if (!missingArgs.isEmpty()) {
             throw new MissingOptionException(missingArgs);
         }
-        Logging.logf("Access Key: %s | Secret Key: %s | Endpoint: %s", getAccessKey(), getSecretKey(), getEndpoint());
+        LOG.info("Access Key: " + getAccessKey() +" | Secret Key: " + getSecretKey() + " | Endpoint: " + getEndpoint());
     }
 
     private WriteOptimization processWriteOptimization(final CommandLine cmd, final String writeOptimization) throws BadArgumentException {
@@ -341,7 +357,7 @@ private void loadProperties() {
             this.buildDate = (String) props.get("build.date");
             } catch (final IOException e) {
                 System.err.println("Failed to load version property file.");
-                if (Logging.isVerbose()) {
+                if (LOG.isInfoEnabled()) {
                     e.printStackTrace();
                 }
 

src/main/java/com/spectralogic/ds3cli/Main.java

@@ -15,17 +15,20 @@
 
 package com.spectralogic.ds3cli;
 
-import com.spectralogic.ds3cli.logging.Logging;
 import com.spectralogic.ds3cli.util.Ds3Provider;
 import com.spectralogic.ds3cli.util.FileUtils;
 import com.spectralogic.ds3client.Ds3Client;
 import com.spectralogic.ds3client.Ds3ClientBuilder;
 import com.spectralogic.ds3client.helpers.Ds3ClientHelpers;
 import com.spectralogic.ds3client.models.Credentials;
 import com.spectralogic.ds3client.networking.FailedRequestException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 public class Main {
 
+    private final static Logger LOG = LoggerFactory.getLogger(Main.class);
+
     public static void main(final String[] args) {
         try {
             final Arguments arguments = new Arguments(args);
@@ -38,11 +41,11 @@ public static void main(final String[] args) {
             System.exit(response.getReturnCode());
         } catch (final Exception e) {
             System.out.println("ERROR: " + e.getMessage());
-            if (Logging.isVerbose()) {
+            if (LOG.isInfoEnabled()) {
                 e.printStackTrace();
                 if (e instanceof FailedRequestException) {
-                    Logging.log("Printing out the response from the server:");
-                    Logging.log(((FailedRequestException) e).getResponseString());
+                    LOG.info("Printing out the response from the server:");
+                    LOG.info(((FailedRequestException) e).getResponseString());
                 }
             }
             System.exit(2);

src/main/java/com/spectralogic/ds3cli/command/DeleteBucket.java

@@ -17,7 +17,6 @@
 
 import com.spectralogic.ds3cli.Arguments;
 import com.spectralogic.ds3cli.CommandException;
-import com.spectralogic.ds3cli.logging.Logging;
 import com.spectralogic.ds3cli.models.DeleteResult;
 import com.spectralogic.ds3cli.util.Ds3Provider;
 import com.spectralogic.ds3cli.util.FileUtils;
@@ -28,12 +27,16 @@
 import com.spectralogic.ds3client.models.Contents;
 import com.spectralogic.ds3client.utils.SSLSetupException;
 import org.apache.commons.cli.MissingOptionException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
 import java.security.SignatureException;
 
 public class DeleteBucket extends CliCommand<DeleteResult> {
-    
+
+    private static final Logger LOG = LoggerFactory.getLogger(DeleteBucket.class);
+
     private String bucketName;
     private boolean clearBucket;
     public DeleteBucket(final Ds3Provider provider, final FileUtils fileUtils) {
@@ -74,7 +77,7 @@ private String deleteBucket() throws SignatureException, SSLSetupException, Comm
     private String clearObjects() throws SignatureException, SSLSetupException, CommandException {
         // TODO when the multi object delete command has been added to DS3
         // Get the list of objects from the bucket
-        Logging.log("Deleting objects in bucket first");
+        LOG.debug("Deleting objects in bucket first");
         final Ds3Client client = getClient();
         final Ds3ClientHelpers helper = Ds3ClientHelpers.wrap(client);
 
@@ -83,7 +86,7 @@ private String clearObjects() throws SignatureException, SSLSetupException, Comm
             for (final Contents content : fileList) {
                 client.deleteObject(new DeleteObjectRequest(bucketName, content.getKey()));
             }
-            Logging.log("Deleting bucket");
+            LOG.debug("Deleting bucket");
             getClient().deleteBucket(new DeleteBucketRequest(bucketName));
 
         } catch (final IOException e) {

src/main/java/com/spectralogic/ds3cli/command/GetBulk.java

@@ -18,11 +18,9 @@
 import com.google.common.base.Function;
 import com.google.common.collect.Iterables;
 import com.spectralogic.ds3cli.Arguments;
-import com.spectralogic.ds3cli.logging.Logging;
 import com.spectralogic.ds3cli.models.GetBulkResult;
 import com.spectralogic.ds3cli.util.Ds3Provider;
 import com.spectralogic.ds3cli.util.FileUtils;
-import com.spectralogic.ds3client.Ds3Client;
 import com.spectralogic.ds3client.helpers.Ds3ClientHelpers;
 import com.spectralogic.ds3client.helpers.FileObjectGetter;
 import com.spectralogic.ds3client.helpers.options.ReadJobOptions;
@@ -32,6 +30,8 @@
 import com.spectralogic.ds3client.serializer.XmlProcessingException;
 import com.spectralogic.ds3client.utils.SSLSetupException;
 import org.apache.commons.cli.MissingOptionException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
 import java.nio.channels.SeekableByteChannel;
@@ -40,6 +40,9 @@
 import java.security.SignatureException;
 
 public class GetBulk extends CliCommand<GetBulkResult> {
+
+    private final static Logger LOG = LoggerFactory.getLogger(GetBulk.class);
+
     private String bucketName;
     private Path outputPath;
     private String prefix;
@@ -89,11 +92,11 @@ public GetBulkResult call() throws Exception {
         }
 
         if (this.prefix == null) {
-            Logging.log("Getting all objects from " + this.bucketName);
+            LOG.info("Getting all objects from " + this.bucketName);
             return new GetBulkResult(restoreAll(getter));
         }
         else {
-            Logging.log("Getting only those objects that start with " + this.prefix);
+            LOG.info("Getting only those objects that start with " + this.prefix);
             return new GetBulkResult(restoreSome(getter));
         }
     }
@@ -139,7 +142,7 @@ public LoggingFileObjectGetter(final Ds3ClientHelpers.ObjectChannelBuilder gette
 
         @Override
         public SeekableByteChannel buildChannel(final String s) throws IOException {
-            Logging.logf("Getting object %s", s);
+            LOG.info("Getting object %s", s);
             return this.objectGetter.buildChannel(s);
         }
     }

src/main/java/com/spectralogic/ds3cli/command/GetObject.java

@@ -18,7 +18,6 @@
 import com.google.common.collect.Lists;
 import com.spectralogic.ds3cli.Arguments;
 import com.spectralogic.ds3cli.CommandException;
-import com.spectralogic.ds3cli.logging.Logging;
 import com.spectralogic.ds3cli.models.GetObjectResult;
 import com.spectralogic.ds3cli.util.Ds3Provider;
 import com.spectralogic.ds3cli.util.FileUtils;
@@ -28,12 +27,15 @@
 import com.spectralogic.ds3client.models.bulk.Ds3Object;
 import com.spectralogic.ds3client.networking.FailedRequestException;
 import org.apache.commons.cli.MissingOptionException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.nio.file.*;
 import java.util.List;
 
 public class GetObject extends CliCommand<GetObjectResult> {
 
+    private Logger LOG = LoggerFactory.getLogger(GetObject.class);
     private String bucketName;
     private String objectName;
     private String prefix;
@@ -67,7 +69,7 @@ public CliCommand init(final Arguments args) throws Exception {
     public GetObjectResult call() throws Exception {
         try {
             final Path filePath = Paths.get(prefix, objectName);
-            Logging.log("Output path: " + filePath.toString());
+            LOG.info("Output path: " + filePath.toString());
 
             getFileUtils().createDirectories(filePath.getParent());
 
@@ -82,20 +84,20 @@ public GetObjectResult call() throws Exception {
         }
         catch(final FailedRequestException e) {
             if(e.getStatusCode() == 500) {
-                Logging.log(e.getMessage());
-                if (Logging.isVerbose()) {
+                LOG.info(e.getMessage());
+                if (LOG.isInfoEnabled()) {
                     e.printStackTrace();
                 }
                 throw new CommandException( "Error: Cannot communicate with the remote DS3 appliance.", e);
             }
             else if(e.getStatusCode() == 404) {
-                if (Logging.isVerbose()) {
+                if (LOG.isInfoEnabled()) {
                     e.printStackTrace();
                 }
                 throw new CommandException( "Error: " + e.getMessage(), e);
             }
             else {
-                if (Logging.isVerbose()) {
+                if (LOG.isInfoEnabled()) {
                     e.printStackTrace();
                 }
                 throw new CommandException( "Error: Encountered an unknown error of ("+ e.getStatusCode() +") while accessing the remote DS3 appliance.", e);

src/main/java/com/spectralogic/ds3cli/command/PutBucket.java

@@ -17,21 +17,23 @@
 
 import com.spectralogic.ds3cli.Arguments;
 import com.spectralogic.ds3cli.CommandException;
-import com.spectralogic.ds3cli.logging.Logging;
 import com.spectralogic.ds3cli.models.PutBucketResult;
 import com.spectralogic.ds3cli.util.Ds3Provider;
 import com.spectralogic.ds3cli.util.FileUtils;
-import com.spectralogic.ds3client.Ds3Client;
 import com.spectralogic.ds3client.commands.PutBucketRequest;
 import com.spectralogic.ds3client.models.bulk.Priority;
 import com.spectralogic.ds3client.models.bulk.WriteOptimization;
 import com.spectralogic.ds3client.networking.FailedRequestException;
 import org.apache.commons.cli.MissingOptionException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
 
 public class PutBucket extends CliCommand<PutBucketResult> {
 
+    private static final Logger LOG = LoggerFactory.getLogger(PutBucket.class);
+
     private String bucketName;
     private Priority defaultPutPriority;
     private Priority defaultGetPriority;
@@ -61,15 +63,15 @@ public PutBucketResult call() throws Exception {
             final PutBucketRequest request = new PutBucketRequest(bucketName);
 
             if (this.defaultGetPriority != null) {
-                Logging.logf("Adding a default get priority (%s) to the create bucket", this.defaultGetPriority.toString());
+                LOG.info("Adding a default get priority (" + this.defaultGetPriority.toString() + ") to the create bucket");
                 request.withDefaultGetJobPriority(defaultGetPriority);
             }
             if (this.defaultPutPriority != null) {
-                Logging.logf("Adding a default put priority (%s) to the create bucket", this.defaultPutPriority.toString());
+                LOG.info("Adding a default put priority (" + this.defaultPutPriority.toString() + ") to the create bucket");
                 request.withDefaultPutJobPriority(defaultPutPriority);
             }
             if (this.defaultWriteOptimization != null) {
-                Logging.logf("Adding a default write optimization (%s) to the create bucket", this.defaultWriteOptimization.toString());
+                LOG.info("Adding a default write optimization (" + this.defaultWriteOptimization.toString() + ") to the create bucket");
                 request.withDefaultWriteOptimization(defaultWriteOptimization);
             }