Nfs3LinkRequest.java

/**
 * Copyright 2016-2018 Dell Inc. or its subsidiaries. All rights reserved.
 *
 * <p>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
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 * <p>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.nfs3;

import com.emc.ecs.nfsclient.nfs.NfsLinkRequest;
import com.emc.ecs.nfsclient.rpc.Credential;
import java.io.FileNotFoundException;

/**
 * The request, as specified by RFC 1813 (https://tools.ietf.org/html/rfc1813).
 *
 * <p>Procedure LINK creates a hard link from <code>fileHandle</code> to <code>name</code>, in the
 * directory, <code>parentDirectoryFileHandle</code>. <code>fileHandle</code> and <code>
 * parentDirectoryFileHandle</code> must reside on the same file system and server.
 *
 * @author seibed
 */
public class Nfs3LinkRequest extends NfsLinkRequest {

  /**
   * Convenience method for creating the request, as specified by RFC 1813
   * (https://tools.ietf.org/html/rfc1813).
   *
   * <p>Procedure LINK creates a hard link from <code>fileHandle</code> to <code>name</code>, in the
   * directory, <code>parentDirectoryFileHandle</code>. <code>fileHandle</code> and <code>
   * parentDirectoryFileHandle</code> must reside on the same file system and server.
   *
   * @param fileHandle The file handle for the existing file system object.
   * @param parentDirectoryFileHandle The file handle for the directory in which the link is to be
   *     created.
   * @param name The name that is to be associated with the created link.
   * @param credential The credential used for RPC authentication.
   */
  Nfs3LinkRequest(
      byte[] fileHandle, byte[] parentDirectoryFileHandle, String name, Credential credential)
      throws FileNotFoundException {
    super(fileHandle, parentDirectoryFileHandle, name, credential, Nfs3.VERSION);
  }
}