If options are specified later then they override the defaults. + * Methods that take a whole CloudStorageConfiguration (eg. + * CloudStorageFileSystem.forBucket) will completely override the defaults. + * Methods that take individual options (eg. + * CloudStorageFileSystemProvier.newFileSystem) will override only these options; + * the rest will be taken from the defaults specified here. + * + *
This is meant to be done only once, at the beginning of some main program, + * in order to force all libraries to use some settings we like. + * + *
Libraries should never call this. If you're a library then, instead, create your own + * filesystem object with the right configuration and pass it along. + * + * @param newDefault new default CloudStorageConfiguration + */ + public static void setDefaultCloudStorageConfiguration(CloudStorageConfiguration newDefault) { + CloudStorageFileSystem.setDefaultCloudStorageConfiguration(newDefault); + } + /** * Default constructor which should only be called by Java SPI. * @@ -200,7 +224,11 @@ && isNullOrEmpty(uri.getUserInfo()), uri); CloudStorageUtil.checkBucket(uri.getHost()); initStorage(); - return new CloudStorageFileSystem(this, uri.getHost(), CloudStorageConfiguration.fromMap(env)); + return new CloudStorageFileSystem( + this, + uri.getHost(), + CloudStorageConfiguration.fromMap( + CloudStorageFileSystem.getDefaultCloudStorageConfiguration(), env)); } @Override diff --git a/google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageOptions.java b/google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageOptions.java index 9a568883e3a4..282c1b0d810a 100644 --- a/google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageOptions.java +++ b/google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageOptions.java @@ -92,7 +92,7 @@ public static CloudStorageOption.OpenCopy withBlockSize(int size) { } /** - * Sets the max number of times that the channel can be reopen if reading + * Sets the max number of times that the channel can be reopened if reading * fails because the channel unexpectedly closes. * *
The default is 0. diff --git a/google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageReadChannel.java b/google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageReadChannel.java index 8fa65f475be5..515871ea61d6 100644 --- a/google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageReadChannel.java +++ b/google-cloud-contrib/google-cloud-nio/src/main/java/com/google/cloud/storage/contrib/nio/CloudStorageReadChannel.java @@ -21,6 +21,7 @@ import com.google.cloud.storage.BlobInfo; import com.google.cloud.storage.Storage; import com.google.cloud.storage.StorageException; +import com.google.common.annotations.VisibleForTesting; import javax.annotation.CheckReturnValue; import javax.annotation.concurrent.ThreadSafe; @@ -49,7 +50,8 @@ final class CloudStorageReadChannel implements SeekableByteChannel { private final Storage gcsStorage; private final BlobId file; // max # of times we may reopen the file - private final int maxChannelReopens; + @VisibleForTesting + final int maxChannelReopens; // how many times we re-opened the file private int reopens; private ReadChannel channel; diff --git a/google-cloud-contrib/google-cloud-nio/src/test/java/com/google/cloud/storage/contrib/nio/CloudStorageFileSystemTest.java b/google-cloud-contrib/google-cloud-nio/src/test/java/com/google/cloud/storage/contrib/nio/CloudStorageFileSystemTest.java index 9d9e864968ab..a4e231bb0cbd 100644 --- a/google-cloud-contrib/google-cloud-nio/src/test/java/com/google/cloud/storage/contrib/nio/CloudStorageFileSystemTest.java +++ b/google-cloud-contrib/google-cloud-nio/src/test/java/com/google/cloud/storage/contrib/nio/CloudStorageFileSystemTest.java @@ -33,6 +33,7 @@ import java.io.IOException; import java.net.URI; +import java.nio.channels.SeekableByteChannel; import java.nio.file.FileSystem; import java.nio.file.FileSystems; import java.nio.file.Files; @@ -69,6 +70,57 @@ public void before() { CloudStorageFileSystemProvider.setStorageOptions(LocalStorageHelper.getOptions()); } + @Test + public void checkDefaultOptions() throws IOException { + // 1. We get the normal default if we don't do anything special. + Path path = Paths.get(URI.create("gs://bucket/file")); + CloudStorageFileSystem gcs = (CloudStorageFileSystem)path.getFileSystem(); + assertThat(gcs.config().maxChannelReopens()).isEqualTo(0); + + // 2(a). Override the default, and see it reflected. + CloudStorageFileSystemProvider.setDefaultCloudStorageConfiguration( + CloudStorageConfiguration.builder() + .maxChannelReopens(123).build()); + Path path2 = Paths.get(URI.create("gs://newbucket/file")); + CloudStorageFileSystem gcs2 = (CloudStorageFileSystem)path2.getFileSystem(); + assertThat(gcs2.config().maxChannelReopens()).isEqualTo(123); + + // 2(b) ...even reflected if we try to open a file. + try (FileSystem fs = CloudStorageFileSystem.forBucket("bucket")) { + CloudStorageFileSystem csfs = (CloudStorageFileSystem)fs; + assertThat(csfs.config().maxChannelReopens()).isEqualTo(123); + Files.write(fs.getPath("/angel"), ALONE.getBytes(UTF_8)); + path2 = Paths.get(URI.create("gs://bucket/angel")); + try (SeekableByteChannel seekableByteChannel = Files.newByteChannel(path2)) { + CloudStorageReadChannel cloudChannel = (CloudStorageReadChannel) seekableByteChannel; + assertThat(cloudChannel.maxChannelReopens).isEqualTo(123); + } + } + + // 4. Clean up. + CloudStorageFileSystemProvider.setDefaultCloudStorageConfiguration(null); + Path path3 = Paths.get(URI.create("gs://newbucket/file")); + CloudStorageFileSystem gcs3 = (CloudStorageFileSystem)path3.getFileSystem(); + assertThat(gcs3.config().maxChannelReopens()).isEqualTo(0); + } + + @Test + public void canOverrideDefaultOptions() throws IOException { + // Set a new default. + CloudStorageFileSystemProvider.setDefaultCloudStorageConfiguration( + CloudStorageConfiguration.builder() + .maxChannelReopens(123).build()); + + // This code wants its own value. + try (FileSystem fs = CloudStorageFileSystem.forBucket("bucket", CloudStorageConfiguration.builder().maxChannelReopens(7).build())) { + CloudStorageFileSystem csfs = (CloudStorageFileSystem)fs; + assertThat(csfs.config().maxChannelReopens()).isEqualTo(7); + } + + // Clean up. + CloudStorageFileSystemProvider.setDefaultCloudStorageConfiguration(null); + } + @Test public void testGetPath() throws IOException { try (FileSystem fs = CloudStorageFileSystem.forBucket("bucket")) {