com.emc.ecs.nfsclient.nfs.io.Nfs3File Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nfs-client Show documentation

NFS Client for Java - provides read/write access to data on NFS servers. The current implementation supports only NFS version 3.

There is a newer version: 1.1.0

Show newest version

/**
 * Copyright 2016 EMC Corporation. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 * http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 * or in the "license" file accompanying this file. This file 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 com.emc.ecs.nfsclient.nfs.io;

import java.io.IOException;

import com.emc.ecs.nfsclient.nfs.nfs3.Nfs3;

/**
 * Nfs3 specialization of NfsFile. Almost all functionality is implemented in
 * the parent class.
 * 
 * @author seibed
 */
public class Nfs3File extends NfsFileBase {

    /**
     * The basic constructor.
     * 
     * @param nfs
     *            The supporting NFS client.
     * @param path
     *            The full path of the file, starting with the mount point.
     * @throws IOException 
     */
    public Nfs3File(Nfs3 nfs, String path) throws IOException {
        super(nfs, path, null);
    }

    /**
     * The basic constructor plus link tracking.
     * 
     * @param nfs
     *            The supporting NFS client.
     * @param path
     *            The full path of the file, starting with the mount point.
     * @param linkTracker
     *            The tracker to use. This must be passed so that monitoring is
     *            continued until the link resolves to a file that is not a
     *            symbolic link.
     * @throws IOException
     */
    public Nfs3File(Nfs3 nfs, String path, LinkTracker linkTracker) throws IOException {
        super(nfs, path, linkTracker);
    }

    /**
     * The most efficient constructor if the parent file already exists.
     * 
     * @param parent
     *            The parent file, stored to reduce lookup overhead
     * @param child
     *            The short name of the file, starting from the parent path.
     * @throws IOException 
     */
    public Nfs3File(Nfs3File parent, String child) throws IOException {
        super(parent, child);
    }

    /*
     * (non-Javadoc)
     * 
     * @see com.emc.ecs.nfsclient.nfs.NfsFile#newChildFile(java.lang.String)
     */
    public Nfs3File newChildFile(String childName) throws IOException {
        return new Nfs3File(this, childName);
    }

    /*
     * (non-Javadoc)
     * 
     * @see com.emc.ecs.nfsclient.nfs.NfsFileBase#newFile(java.lang.String)
     */
    protected Nfs3File newFile(String path, LinkTracker linkTracker) throws IOException {
        return new Nfs3File(getNfs(), path, linkTracker);
    }

}