NfsRenameResponse.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.RpcException;
import com.emc.ecs.nfsclient.rpc.Xdr;

/**
 * The response, 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 NfsRenameResponse extends NfsResponseBase {

  /** The weak consistency data for the from directory. */
  private NfsWccData _fromDirectoryWccData = new NfsWccData();

  /** The weak consistency data for the to directory. */
  private NfsWccData _toDirectoryWccData = new NfsWccData();

  /**
   * Creates the response, 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 nfsVersion The NFS version number. This is ignored for now, as only NFSv3 is supported,
   *     but is included to allow future support for other versions.
   */
  public NfsRenameResponse(int nfsVersion) {
    super();
  }

  /** {@inheritDoc} */
  @Override
  public void unmarshalling(Xdr xdr) throws RpcException {
    super.unmarshalling(xdr);
    _fromDirectoryWccData = new NfsWccData(xdr);
    _toDirectoryWccData = new NfsWccData(xdr);
  }

  /** Returns the weak consistency data for the from directory. */
  public NfsWccData getFromDirectoryWccData() {
    return _fromDirectoryWccData;
  }

  /** Returns the weak consistency data for the to directory. */
  public NfsWccData getToDirectoryWccData() {
    return _toDirectoryWccData;
  }
}