NfsRemoveRequest.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;

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

/**
 * The request, as specified by RFC 1813 (https://tools.ietf.org/html/rfc1813).
 *
 * <p>Procedure REMOVE removes (deletes) an entry from a directory. If the entry in the directory
 * was the last reference to the corresponding file system object, the object may be destroyed.
 *
 * @author seibed
 */
public class NfsRemoveRequest extends NfsRequestBase {

  /** The name of the entry to be removed. */
  private final String _name;

  /**
   * Creates the request, as specified by RFC 1813 (https://tools.ietf.org/html/rfc1813).
   *
   * <p>Procedure REMOVE removes (deletes) an entry from a directory. If the entry in the directory
   * was the last reference to the corresponding file system object, the object may be destroyed.
   *
   * @param fileHandle The file handle for the directory from which the entry is to be removed.
   * @param name The name of the entry to be removed.
   * @param credential The credential used for RPC authentication.
   * @param nfsVersion The NFS version number
   */
  public NfsRemoveRequest(byte[] fileHandle, String name, Credential credential, int nfsVersion)
      throws FileNotFoundException {
    super(Nfs.RPC_PROGRAM, nfsVersion, Nfs.NFSPROC3_REMOVE, credential, fileHandle);
    _name = trimFileName(name);
  }

  /** {@inheritDoc} */
  @Override
  public void marshalling(Xdr xdr) {
    super.marshalling(xdr);
    xdr.putString(_name);
  }

  /** {@inheritDoc} */
  @Override
  public String toString() {
    return startToString("NfsRemoveFileRequest").append(" name").append(_name).toString();
  }
}