org.apache.sshd.sftp.client.fs.SftpPath Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sshd-sftp Show documentation

There is a newer version: 2.14.0

/*
 * 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.sshd.sftp.client.fs;

import java.io.IOException;
import java.nio.file.FileSystem;
import java.nio.file.LinkOption;
import java.nio.file.spi.FileSystemProvider;
import java.util.List;

import org.apache.sshd.common.file.util.BasePath;
import org.apache.sshd.sftp.client.SftpClient;

/**
 * A {@link java.nio.file.Path} on an {@link SftpFileSystem}.
 */
public class SftpPath extends BasePath {

    public SftpPath(SftpFileSystem fileSystem, String root, List names) {
        super(fileSystem, root, names);
    }

    /**
     * Retrieves the cached {@link SftpClient.Attributes} of this {@link SftpPath}, if it has any.
     *
     * @return the cached {@link SftpClient.Attributes} or {@code null} if there are none cached
     */
    @SuppressWarnings("javadoc")
    public SftpClient.Attributes getAttributes() {
        // Subclasses may override
        return null;
    }

    @Override
    public SftpPath toRealPath(LinkOption... options) throws IOException {
        // TODO: handle links
        SftpPath absolute = toAbsolutePath();
        FileSystem fs = getFileSystem();
        FileSystemProvider provider = fs.provider();
        provider.checkAccess(absolute);
        return absolute;
    }
}