Merge pull request #395 from rpmoore/io_debug_logging

Adding a ObjectChannelBuilder and a SeekableByteChannel to add extra …

Author: RachelTucker

build.gradle

@@ -15,7 +15,7 @@
 
 allprojects {
     group = 'com.spectralogic.ds3'
-    version = '3.2.9-RC1'
+    version = '3.2.9-RC2'
 }
 
 subprojects {

ds3-sdk/src/main/java/com/spectralogic/ds3client/helpers/channelbuilders/IoLoggingChannelBuilder.java

@@ -0,0 +1,53 @@
+/*
+ * ****************************************************************************
+ *    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.helpers.channelbuilders;
+
+import com.spectralogic.ds3client.helpers.Ds3ClientHelpers;
+import com.spectralogic.ds3client.utils.LoggingSeekableByteChannel;
+
+import java.io.IOException;
+import java.nio.channels.SeekableByteChannel;
+
+
+/**
+ * This ObjectChannelBuilder is used to wrap an existing ObjectChannelBuilder and wrap all the channels it creates
+ * in a logging channel to log how many bytes were read or written on each call.  This should only be used
+ * for debugging and should not be used in a production deployment.
+ */
+public class IoLoggingChannelBuilder implements Ds3ClientHelpers.ObjectChannelBuilder {
+
+    public static final String IO_CHANNEL_DEFAULT_NAME = "IoChannel";
+
+    private final Ds3ClientHelpers.ObjectChannelBuilder wrappedObjectChannelBuilder;
+    private final String streamName;
+
+    public IoLoggingChannelBuilder(final Ds3ClientHelpers.ObjectChannelBuilder wrappedObjectChannelBuilder, final String streamName) {
+        this.wrappedObjectChannelBuilder = wrappedObjectChannelBuilder;
+        this.streamName = streamName;
+    }
+
+    public IoLoggingChannelBuilder(final Ds3ClientHelpers.ObjectChannelBuilder wrappedObjectChannelBuilder) {
+        this(wrappedObjectChannelBuilder, IO_CHANNEL_DEFAULT_NAME);
+    }
+
+    @Override
+    public SeekableByteChannel buildChannel(final String key) throws IOException {
+
+        final SeekableByteChannel seekableByteChannel = wrappedObjectChannelBuilder.buildChannel(key);
+
+        return new LoggingSeekableByteChannel(seekableByteChannel, streamName);
+    }
+}

ds3-sdk/src/main/java/com/spectralogic/ds3client/utils/LoggingSeekableByteChannel.java

@@ -0,0 +1,80 @@
+/*
+ * ****************************************************************************
+ *    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.utils;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+import java.nio.ByteBuffer;
+import java.nio.channels.SeekableByteChannel;
+
+public class LoggingSeekableByteChannel implements SeekableByteChannel {
+
+    private static final Logger LOG = LoggerFactory.getLogger(LoggingSeekableByteChannel.class);
+
+    private final SeekableByteChannel wrappedChannel;
+    private final String channelName;
+
+    public LoggingSeekableByteChannel(final SeekableByteChannel wrappedChannel, final String channelName) {
+        this.wrappedChannel = wrappedChannel;
+        this.channelName = channelName;
+    }
+
+    @Override
+    public int read(final ByteBuffer dst) throws IOException {
+        final int readCount = wrappedChannel.read(dst);
+        LOG.info("Read {} bytes from {}", readCount, channelName);
+        return readCount;
+    }
+
+    @Override
+    public int write(final ByteBuffer src) throws IOException {
+        final int writeCount = wrappedChannel.write(src);
+        LOG.info("Wrote {} bytes to {}", writeCount, channelName);
+        return writeCount;
+    }
+
+    @Override
+    public long position() throws IOException {
+        return wrappedChannel.position();
+    }
+
+    @Override
+    public SeekableByteChannel position(final long newPosition) throws IOException {
+        return wrappedChannel.position(newPosition);
+    }
+
+    @Override
+    public long size() throws IOException {
+        return wrappedChannel.size();
+    }
+
+    @Override
+    public SeekableByteChannel truncate(final long size) throws IOException {
+        return wrappedChannel.truncate(size);
+    }
+
+    @Override
+    public boolean isOpen() {
+        return wrappedChannel.isOpen();
+    }
+
+    @Override
+    public void close() throws IOException {
+        wrappedChannel.close();
+    }
+}