flink-filesystems/flink-s3-fs-base/src/main/java/org/apache/flink/fs/s3/common/utils/RefCountedFile.java

/*
 * 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.flink.fs.s3.common.utils;

import org.apache.flink.annotation.Internal;
import org.apache.flink.annotation.VisibleForTesting;
import org.apache.flink.util.ExceptionUtils;
import org.apache.flink.util.IOUtils;

import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.file.Files;
import java.util.concurrent.atomic.AtomicInteger;

import static org.apache.flink.util.Preconditions.checkNotNull;

/**
 * A reference counted file which is deleted as soon as no caller
 * holds a reference to the wrapped {@link File}.
 */
@Internal
public class RefCountedFile implements RefCounted {

	private final File file;

	private final OffsetAwareOutputStream stream;

	private final AtomicInteger references;

	private boolean closed;

	private RefCountedFile(
			final File file,
			final OutputStream currentOut,
			final long bytesInCurrentPart) {
		this.file = checkNotNull(file);
		this.references = new AtomicInteger(1);
		this.stream = new OffsetAwareOutputStream(
				currentOut,
				bytesInCurrentPart);
		this.closed = false;
	}

	public File getFile() {
		return file;
	}

	public OffsetAwareOutputStream getStream() {
		return stream;
	}

	public long getLength() {
		return stream.getLength();
	}

	public void write(byte[] b, int off, int len) throws IOException {
		requireOpened();
		if (len > 0) {
			stream.write(b, off, len);
		}
	}

	public void flush() throws IOException {
		requireOpened();
		stream.flush();
	}

	public void closeStream() {
		if (!closed) {
			IOUtils.closeQuietly(stream);
			closed = true;
		}
	}

	@Override
	public void retain() {
		references.incrementAndGet();
	}

	@Override
	public boolean release() {
		if (references.decrementAndGet() == 0) {
			return tryClose();
		}
		return false;
	}

	private boolean tryClose() {
		try {
			Files.deleteIfExists(file.toPath());
			return true;
		} catch (Throwable t) {
			ExceptionUtils.rethrowIfFatalError(t);
		}
		return false;
	}

	private void requireOpened() throws IOException {
		if (closed) {
			throw new IOException("Stream closed.");
		}
	}

	@VisibleForTesting
	int getReferenceCounter() {
		return references.get();
	}

	// ------------------------------ Factory methods for initializing a temporary file ------------------------------

	public static RefCountedFile newFile(
			final File file,
			final OutputStream currentOut) throws IOException {
		return new RefCountedFile(file, currentOut, 0L);
	}

	public static RefCountedFile restoredFile(
			final File file,
			final OutputStream currentOut,
			final long bytesInCurrentPart) {
		return new RefCountedFile(file, currentOut, bytesInCurrentPart);
	}
}