com.emc.ecs.nfsclient.nfs.NfsCommitRequest 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;

import java.io.FileNotFoundException;

import com.emc.ecs.nfsclient.rpc.Credential;
import com.emc.ecs.nfsclient.rpc.Xdr;

/**
 * The request, as specified by RFC 1813 (https://tools.ietf.org/html/rfc1813).
 * 
 * 
 * Procedure COMMIT forces or flushes data to stable storage that was previously
 * written with a WRITE procedure call with the stable field set to UNSTABLE.
 * 
 * 
 * @author seibed
 */
public class NfsCommitRequest extends NfsRequestBase {

    /**
     * The position within the file at which the flush is to begin. An offset of
     * 0 means to flush data starting at the beginning of the file.
     */
    private final long _offsetToCommit;

    /**
     * The number of bytes of data to flush. If count is 0, a flush from offset
     * to the end of file is done.
     */
    private final int _dataSizeToCommit;

    /**
     * Creates the request, as specified by RFC 1813
     * (https://tools.ietf.org/html/rfc1813).
     * 
     * 
     * Procedure COMMIT forces or flushes data to stable storage that was
     * previously written with a WRITE procedure call with the stable field set
     * to UNSTABLE.
     * 
     * 
     * @param fileHandle
     *            The file handle for the file to which data is to be flushed
     *            (committed). This must identify a file system object of type,
     *            NF3REG.
     * @param offsetToCommit
     *            The position within the file at which the flush is to begin.
     *            An offset of 0 means to flush data starting at the beginning
     *            of the file.
     * @param dataSizeToCommit
     *            The number of bytes of data to flush. If count is 0, a flush
     *            from offset to the end of file is done.
     * @param credential
     *            The credential used for RPC authentication.
     * @param nfsVersion
     *            The NFS version number
     * @throws FileNotFoundException
     */
    public NfsCommitRequest(byte[] fileHandle, long offsetToCommit, int dataSizeToCommit, Credential credential,
            int nfsVersion) throws FileNotFoundException {
        super(Nfs.RPC_PROGRAM, nfsVersion, Nfs.NFSPROC3_COMMIT, credential, fileHandle);
        _offsetToCommit = offsetToCommit;
        _dataSizeToCommit = dataSizeToCommit;
    }

    /*
     * (non-Javadoc)
     * 
     * @see com.emc.ecs.nfsclient.nfs.NfsRequestBase#marshalling(com.emc.ecs.
     * nfsclient.rpc.Xdr)
     */
    public void marshalling(Xdr xdr) {
        super.marshalling(xdr);
        xdr.putLong(_offsetToCommit);
        xdr.putUnsignedInt(_dataSizeToCommit);
    }

    /*
     * (non-Javadoc)
     * 
     * @see java.lang.Object#toString()
     */
    public String toString() {
        return startToString("NfsCommitRequest").append(" offsetToCommit:").append(_offsetToCommit)
                .append(" dataSizeToCommit:").append(_dataSizeToCommit).toString();
    }

}