Move Streams.copy into elasticsearch-core and make a multi-release jar #29322
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch 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.elasticsearch.core.internal.io; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.io.OutputStream; | ||
| import java.util.Objects; | ||
|
|
||
| /** | ||
| * Simple utility methods for file and stream copying. | ||
| * All copy methods use a block size of 4096 bytes, | ||
| * and close all affected streams when done. | ||
| * <p> | ||
| * Mainly for use within the framework, | ||
| * but also useful for application code. | ||
| */ | ||
| public class Streams { | ||
|
|
||
| /** | ||
| * Copy the contents of the given InputStream to the given OutputStream. | ||
| * Closes both streams when done. | ||
| * | ||
| * @param in the stream to copy from | ||
| * @param out the stream to copy to | ||
| * @return the number of bytes copied | ||
| * @throws IOException in case of I/O errors | ||
| */ | ||
| public static long copy(final InputStream in, final OutputStream out) throws IOException { | ||
| Objects.requireNonNull(in, "No InputStream specified"); | ||
| Objects.requireNonNull(out, "No OutputStream specified"); | ||
| final byte[] buffer = new byte[8192]; | ||
| Exception err = null; | ||
| try { | ||
| long byteCount = 0; | ||
| int bytesRead; | ||
| while ((bytesRead = in.read(buffer)) != -1) { | ||
| out.write(buffer, 0, bytesRead); | ||
| byteCount += bytesRead; | ||
| } | ||
| out.flush(); | ||
| return byteCount; | ||
| } catch (IOException | RuntimeException e) { | ||
| err = e; | ||
| throw e; | ||
| } finally { | ||
| IOUtils.close(err, in, out); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch 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.elasticsearch.core.internal.io; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.io.OutputStream; | ||
|
|
||
| /** | ||
| * Simple utility methods for file and stream copying. | ||
| * All copy methods close all affected streams when done. | ||
| * <p> | ||
| * Mainly for use within the framework, | ||
| * but also useful for application code. | ||
| */ | ||
| public abstract class Streams { | ||
|
|
||
| /** | ||
| * Copy the contents of the given InputStream to the given OutputStream. | ||
| * Closes both streams when done. | ||
| * | ||
| * @param in the stream to copy from | ||
| * @param out the stream to copy to | ||
| * @return the number of bytes copied | ||
| * @throws IOException in case of I/O errors | ||
| */ | ||
| public static long copy(final InputStream in, final OutputStream out) throws IOException { | ||
| Exception err = null; | ||
| try { | ||
| final long byteCount = in.transferTo(out); | ||
| out.flush(); | ||
| return byteCount; | ||
| } catch (IOException | RuntimeException e) { | ||
| err = e; | ||
| throw e; | ||
| } finally { | ||
|
There was a problem hiding this comment. I think that you can simplify all of this gross exception handling with: try (in; out) {
final long byteCount = in.transferTo(out);
out.flush();
return byteCount;
}Note that this also uses a Java 9 language-level feature (a resource reference in the try-with-resources statement). There was a problem hiding this comment. See item 2 in JEP 213 for an explanation of this feature. There was a problem hiding this comment. It is also possible that try (in;
out) {
}is clearer. I am not sure. |
||
| IOUtils.close(err, in, out); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch 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.elasticsearch.core.internal.io; | ||
|
|
||
| import org.elasticsearch.test.ESTestCase; | ||
|
|
||
| import java.io.ByteArrayInputStream; | ||
| import java.io.ByteArrayOutputStream; | ||
| import java.io.IOException; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.Arrays; | ||
|
|
||
| import static org.hamcrest.Matchers.equalTo; | ||
|
|
||
| public class StreamsTests extends ESTestCase { | ||
| public void testCopyFromInputStream() throws IOException { | ||
| byte[] content = "content".getBytes(StandardCharsets.UTF_8); | ||
| ByteArrayInputStream in = new ByteArrayInputStream(content); | ||
| ByteArrayOutputStream out = new ByteArrayOutputStream(content.length); | ||
| long count = Streams.copy(in, out); | ||
|
|
||
| assertThat(count, equalTo((long) content.length)); | ||
| assertThat(Arrays.equals(content, out.toByteArray()), equalTo(true)); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would you make
exfinal please?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Certainly