Nfs3RenameRequest.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.NfsRenameRequest;
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 RENAME renames the file identified by <code>name</code> in the directory, <code>
 * fileHandle</code>, to <code>toName</code> in the directory, <code>toFileHandle</code>. The
 * operation is required to be atomic to the client. <code>toFileHandle</code> and <code>fileHandle
 * </code> must reside on the same file system and server.
 *
 * @author seibed
 */
public class Nfs3RenameRequest extends NfsRenameRequest {

  /**
   * Creates the request, as specified by RFC 1813 (https://tools.ietf.org/html/rfc1813).
   *
   * <p>Procedure RENAME renames the file identified by <code>name</code> in the directory, <code>
   * fileHandle</code>, to <code>toName</code> in the directory, <code>toFileHandle</code>. The
   * operation is required to be atomic to the client. <code>toFileHandle</code> and <code>
   * fileHandle</code> must reside on the same file system and server.
   *
   * @param fileHandle The file handle for the directory from which the entry is to be renamed
   * @param name The name of the entry that identifies the object to be renamed
   * @param toFileHandle The file handle for the directory to which the object is to be renamed.
   * @param toName The new name for the object.
   * @param credential The credential used for RPC authentication.
   */
  public Nfs3RenameRequest(
      byte[] fileHandle, String name, byte[] toFileHandle, String toName, Credential credential)
      throws FileNotFoundException {
    super(fileHandle, name, toFileHandle, toName, credential, Nfs3.VERSION);
  }
}