1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.compress.archivers.zip;
19
20 import java.io.IOException;
21 import java.nio.file.Files;
22 import java.nio.file.Path;
23 import java.util.concurrent.atomic.AtomicInteger;
24
25 import org.apache.commons.compress.parallel.FileBasedScatterGatherBackingStore;
26 import org.apache.commons.compress.parallel.ScatterGatherBackingStore;
27 import org.apache.commons.compress.parallel.ScatterGatherBackingStoreSupplier;
28
29 /**
30 * Implements {@link ScatterGatherBackingStoreSupplier} using a temporary folder.
31 * <p>
32 * For example:
33 * </p>
34 *
35 * <pre>
36 * final Path dir = Paths.get("target/custom-temp-dir");
37 * Files.createDirectories(dir);
38 * final ParallelScatterZipCreator zipCreator = new ParallelScatterZipCreator(Executors.newFixedThreadPool(Runtime.getRuntime().availableProcessors()),
39 * new DefaultBackingStoreSupplier(dir));
40 * </pre>
41 *
42 * @since 1.23
43 */
44 public class DefaultBackingStoreSupplier implements ScatterGatherBackingStoreSupplier {
45
46 private static final String PREFIX = "parallelscatter";
47
48 private final AtomicInteger storeNum = new AtomicInteger();
49
50 private final Path dir;
51
52 /**
53 * Constructs a new instance. If {@code dir} is null, then use the default temporary-file directory.
54 *
55 * @param dir temporary folder, may be null, must exist if non-null.
56 */
57 public DefaultBackingStoreSupplier(final Path dir) {
58 this.dir = dir;
59 }
60
61 @Override
62 public ScatterGatherBackingStore get() throws IOException {
63 final String suffix = "n" + storeNum.incrementAndGet();
64 final Path tempFile = dir == null ? Files.createTempFile(PREFIX, suffix) : Files.createTempFile(dir, PREFIX, suffix);
65 return new FileBasedScatterGatherBackingStore(tempFile);
66 }
67 }