Repository: incubator-beam Updated Branches: refs/heads/master 249dbc045 -> e53d6d458
[BEAM-59] Create IOChannelFactoryRegistrar interface and its gcs/file implementations. Project: http://git-wip-us.apache.org/repos/asf/incubator-beam/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-beam/commit/cd1a5e7e Tree: http://git-wip-us.apache.org/repos/asf/incubator-beam/tree/cd1a5e7e Diff: http://git-wip-us.apache.org/repos/asf/incubator-beam/diff/cd1a5e7e Branch: refs/heads/master Commit: cd1a5e7e30a3bd46f822d371333afa975fc7e4af Parents: e6fa2ff Author: Pei He <pe...@google.com> Authored: Mon Oct 31 18:01:41 2016 -0700 Committer: Luke Cwik <lc...@google.com> Committed: Tue Nov 22 06:18:54 2016 -0800 ---------------------------------------------------------------------- .../sdk/util/FileIOChannelFactoryRegistrar.java | 38 +++++++++++++++++ .../sdk/util/GcsIOChannelFactoryRegistrar.java | 38 +++++++++++++++++ .../sdk/util/IOChannelFactoryRegistrar.java | 43 +++++++++++++++++++ .../util/FileIOChannelFactoryRegistrarTest.java | 44 ++++++++++++++++++++ .../util/GcsIOChannelFactoryRegistrarTest.java | 44 ++++++++++++++++++++ 5 files changed, 207 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/cd1a5e7e/sdks/java/core/src/main/java/org/apache/beam/sdk/util/FileIOChannelFactoryRegistrar.java ---------------------------------------------------------------------- diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/FileIOChannelFactoryRegistrar.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/FileIOChannelFactoryRegistrar.java new file mode 100644 index 0000000..acc0222 --- /dev/null +++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/FileIOChannelFactoryRegistrar.java @@ -0,0 +1,38 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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 org.apache.beam.sdk.util; + +import com.google.auto.service.AutoService; +import org.apache.beam.sdk.options.PipelineOptions; + +/** + * {@link AutoService} registrar for the {@link FileIOChannelFactory}. + */ +@AutoService(IOChannelFactoryRegistrar.class) +public class FileIOChannelFactoryRegistrar implements IOChannelFactoryRegistrar { + + @Override + public IOChannelFactory fromOptions(PipelineOptions options) { + return FileIOChannelFactory.fromOptions(options); + } + + @Override + public String getScheme() { + return "file"; + } +} http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/cd1a5e7e/sdks/java/core/src/main/java/org/apache/beam/sdk/util/GcsIOChannelFactoryRegistrar.java ---------------------------------------------------------------------- diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/GcsIOChannelFactoryRegistrar.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/GcsIOChannelFactoryRegistrar.java new file mode 100644 index 0000000..b4c457f --- /dev/null +++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/GcsIOChannelFactoryRegistrar.java @@ -0,0 +1,38 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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 org.apache.beam.sdk.util; + +import com.google.auto.service.AutoService; +import org.apache.beam.sdk.options.PipelineOptions; + +/** + * {@link AutoService} registrar for the {@link GcsIOChannelFactory}. + */ +@AutoService(IOChannelFactoryRegistrar.class) +public class GcsIOChannelFactoryRegistrar implements IOChannelFactoryRegistrar { + + @Override + public GcsIOChannelFactory fromOptions(PipelineOptions options) { + return GcsIOChannelFactory.fromOptions(options); + } + + @Override + public String getScheme() { + return "gs"; + } +} http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/cd1a5e7e/sdks/java/core/src/main/java/org/apache/beam/sdk/util/IOChannelFactoryRegistrar.java ---------------------------------------------------------------------- diff --git a/sdks/java/core/src/main/java/org/apache/beam/sdk/util/IOChannelFactoryRegistrar.java b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/IOChannelFactoryRegistrar.java new file mode 100644 index 0000000..93752a4 --- /dev/null +++ b/sdks/java/core/src/main/java/org/apache/beam/sdk/util/IOChannelFactoryRegistrar.java @@ -0,0 +1,43 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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 org.apache.beam.sdk.util; + +import com.google.auto.service.AutoService; +import java.util.ServiceLoader; +import org.apache.beam.sdk.options.PipelineOptions; + +/** + * A registrar that creates {@link IOChannelFactory} from {@link PipelineOptions}. + * + * <p>{@link IOChannelFactory} creators have the ability to provide a registrar by creating + * a {@link ServiceLoader} entry and a concrete implementation of this interface. + * + * <p>It is optional but recommended to use one of the many build time tools such as + * {@link AutoService} to generate the necessary META-INF files automatically. + */ +public interface IOChannelFactoryRegistrar { + /** + * Create a {@link IOChannelFactory} with the given {@link PipelineOptions}. + */ + IOChannelFactory fromOptions(PipelineOptions options); + + /** + * Get the scheme. + */ + String getScheme(); +} http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/cd1a5e7e/sdks/java/core/src/test/java/org/apache/beam/sdk/util/FileIOChannelFactoryRegistrarTest.java ---------------------------------------------------------------------- diff --git a/sdks/java/core/src/test/java/org/apache/beam/sdk/util/FileIOChannelFactoryRegistrarTest.java b/sdks/java/core/src/test/java/org/apache/beam/sdk/util/FileIOChannelFactoryRegistrarTest.java new file mode 100644 index 0000000..4600d81 --- /dev/null +++ b/sdks/java/core/src/test/java/org/apache/beam/sdk/util/FileIOChannelFactoryRegistrarTest.java @@ -0,0 +1,44 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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 org.apache.beam.sdk.util; + +import static org.junit.Assert.fail; + +import com.google.common.collect.Lists; +import java.util.ServiceLoader; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.JUnit4; + +/** + * Tests for {@link FileIOChannelFactoryRegistrar}. + */ +@RunWith(JUnit4.class) +public class FileIOChannelFactoryRegistrarTest { + + @Test + public void testServiceLoader() { + for (IOChannelFactoryRegistrar registrar : + Lists.newArrayList(ServiceLoader.load(IOChannelFactoryRegistrar.class).iterator())) { + if (registrar instanceof FileIOChannelFactoryRegistrar) { + return; + } + } + fail("Expected to find " + FileIOChannelFactoryRegistrar.class); + } +} http://git-wip-us.apache.org/repos/asf/incubator-beam/blob/cd1a5e7e/sdks/java/core/src/test/java/org/apache/beam/sdk/util/GcsIOChannelFactoryRegistrarTest.java ---------------------------------------------------------------------- diff --git a/sdks/java/core/src/test/java/org/apache/beam/sdk/util/GcsIOChannelFactoryRegistrarTest.java b/sdks/java/core/src/test/java/org/apache/beam/sdk/util/GcsIOChannelFactoryRegistrarTest.java new file mode 100644 index 0000000..32bd4fc --- /dev/null +++ b/sdks/java/core/src/test/java/org/apache/beam/sdk/util/GcsIOChannelFactoryRegistrarTest.java @@ -0,0 +1,44 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License 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 org.apache.beam.sdk.util; + +import static org.junit.Assert.fail; + +import com.google.common.collect.Lists; +import java.util.ServiceLoader; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.JUnit4; + +/** + * Tests for {@link GcsIOChannelFactoryRegistrar}. + */ +@RunWith(JUnit4.class) +public class GcsIOChannelFactoryRegistrarTest { + + @Test + public void testServiceLoader() { + for (IOChannelFactoryRegistrar registrar : + Lists.newArrayList(ServiceLoader.load(IOChannelFactoryRegistrar.class).iterator())) { + if (registrar instanceof GcsIOChannelFactoryRegistrar) { + return; + } + } + fail("Expected to find " + GcsIOChannelFactoryRegistrar.class); + } +}