org.filesys.locking.FileLock Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfileserver Show documentation
Java file server with SMB, FTP/FTPS and NFS support, virtual filesystems, database filesystems
The newest version!
/*
 * Copyright (C) 2006-2010 Alfresco Software Limited.
 *
 * This file is part of Alfresco
 *
 * Alfresco is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Alfresco is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see .
 */

package org.filesys.locking;

import org.filesys.server.locking.LockParams;

import java.io.Serializable;

/**
 * File Lock Class
 *
 * 
 * Contains the details of a single file lock.
 *
 * @author gkspencer
 */
public class FileLock implements Serializable {

    // Serialization id
    private static final long serialVersionUID = 1L;

    // Constants
    public static final long LockWholeFile = 0xFFFFFFFFFFFFFFFFL;

    // Start lock offset and length
    private long m_offset;
    private long m_length;

    // Owner process id
    private int m_pid;

    // Lock flags
    private int m_flags;

    /**
     * Default constructor
     */
    protected FileLock() {
    }

    /**
     * Class constructor
     *
     * @param offset long
     * @param len    long
     * @param pid    int
     */
    public FileLock(long offset, long len, int pid) {
        setOffset(offset);
        setLength(len);
        setProcessId(pid);
    }

    /**
     * Class constructor
     *
     * @param params LockParams
     */
    public FileLock(LockParams params) {
        setOffset( params.getOffset());
        setLength( params.getLength());

        setProcessId( params.getOwner());
        setFlags( params.getFlags());
    }

    /**
     * Get the starting lock offset
     *
     * @return long Starting lock offset.
     */
    public final long getOffset() {
        return m_offset;
    }

    /**
     * Set the starting lock offset.
     *
     * @param offset Starting lock offset
     */
    public final void setOffset(long offset) {
        m_offset = offset;
    }

    /**
     * Get the locked section length
     *
     * @return long Locked section length
     */
    public final long getLength() {
        return m_length;
    }

    /**
     * Set the locked section length
     *
     * @param len Locked section length
     */
    public final void setLength(long len) {
        if (len < 0)
            m_length = LockWholeFile;
        else
            m_length = len;
    }

    /**
     * Get the owner process id for the lock
     *
     * @return int
     */
    public final int getProcessId() {
        return m_pid;
    }

    /**
     * Return the lock flags
     *
     * @return int
     */
    public final int getFlags() {
        return m_flags;
    }

    /**
     * Deterine if the lock is locking the whole file
     *
     * @return boolean
     */
    public final boolean isWholeFile() {
        return m_length == LockWholeFile ? true : false;
    }

    /**
     * Set the process id of the owner of this lock
     *
     * @param pid int
     */
    public final void setProcessId(int pid) {
        m_pid = pid;
    }

    /**
     * Set the lock flags
     *
     * @param flags int
     */
    public final void setFlags(int flags) {
        m_flags = flags;
    }

    /**
     * Check if the specified locks byte range overlaps this locks byte range.
     *
     * @param lock FileLock
     * @return boolean
     */
    public final boolean hasOverlap(FileLock lock) {
        return hasOverlap(lock.getOffset(), lock.getLength());
    }

    /**
     * Check if the specified locks byte range overlaps this locks byte range.
     *
     * @param offset long
     * @param len    long
     * @return boolean
     */
    public final boolean hasOverlap(long offset, long len) {

        // Check if the lock is for the whole file
        if (isWholeFile())
            return true;

        // Check if the locks overlap
        long endOff = getOffset() + (getLength() - 1);

        if (getOffset() < offset && endOff < offset)
            return false;

        endOff = offset + (len - 1);

        if (getOffset() > endOff)
            return false;

        // Locks overlap
        return true;
    }

    /**
     * Return the lock details as a string
     *
     * @return String
     */
    public String toString() {
        StringBuilder str = new StringBuilder();

        str.append("[Owner=");
        str.append(getProcessId());
        str.append(",Offset=");
        str.append(getOffset());
        str.append(",Len=");
        str.append(getLength());
        str.append(",flags=0x");
        str.append(Integer.toHexString( getFlags()));
        str.append("]");

        return str.toString();
    }
}