software.amazon.nio.spi.s3.S3BasicFileAttributeView Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-java-nio-spi-for-s3 Show documentation

A Java NIO.2 service provider for S3, allowing Java NIO operations to be performed on paths using the `s3` scheme. This package implements the service provider interface (SPI) defined for Java NIO.2 in JDK 1.7 providing "plug-in" non-blocking access to S3 objects for Java applications using Java NIO.2 for file access.

The newest version!

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

package software.amazon.nio.spi.s3;

import java.io.IOException;
import java.nio.file.attribute.BasicFileAttributeView;
import java.nio.file.attribute.BasicFileAttributes;
import java.nio.file.attribute.FileTime;
import java.time.Duration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import software.amazon.nio.spi.s3.util.TimeOutUtils;

class S3BasicFileAttributeView implements BasicFileAttributeView {

    private final Logger logger = LoggerFactory.getLogger("S3BasicFileAttributeView");

    private final S3Path path;

    S3BasicFileAttributeView(S3Path path) {
        this.path = path;
    }

    /**
     * Returns the name of the attribute view. Attribute views of this type
     * have the name {@code "s3"}.
     */
    @Override
    public String name() {
        return "s3";
    }

    /**
     * Reads the basic file attributes as a bulk operation.
     *
     *  It is implementation specific if all file attributes are read as an
     * atomic operation with respect to other file system operations.
     *
     * @return the file attributes
     */
    @Override
    public BasicFileAttributes readAttributes() throws IOException {
        return S3BasicFileAttributes.get(path, Duration.ofMinutes(TimeOutUtils.TIMEOUT_TIME_LENGTH_1));
    }

    /**
     * S3 doesn't support setting of file times other than by writing the file. Therefore, this operation does
     * nothing (no-op). To support {@code Files.copy()} and {@code Files.move()} operations which call this method,
     * we don't throw an exception. The time set during those operations will be determined by S3.
     */
    @Override
    public void setTimes(FileTime lastModifiedTime, FileTime lastAccessTime, FileTime createTime) {
        // intentional no-op. S3 doesn't support setting of file times other than by writing the file.
        logger.warn("S3 doesn't support setting of file times other than by writing the file. " +
                "The time set during those operations will be determined by S3. This method call will be ignored");
    }

}