org.filesys.server.locking.OpLockDetails 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.server.locking;

import java.io.IOException;

import org.filesys.smb.OpLockType;
import org.filesys.smb.server.SMBSrvPacket;
import org.filesys.smb.server.SMBSrvSession;
import org.filesys.server.filesys.DeferFailedException;

/**
 * OpLock Details Interface
 *
 * Contains the main oplock details and type, and is also used to store a deferred file open
 * request from another session during an oplock break.
 *
 * @author gkspencer
 */
public interface OpLockDetails {

    /**
     * Return the oplock type
     *
     * @return OpLockType
     */
    public OpLockType getLockType();

    /**
     * Check if the oplock is a batch oplock
     *
     * @return boolean
     */
    public boolean isBatchOplock();

    /**
     * Check if the oplock is a level II oplock
     *
     * @return boolean
     */
    public boolean isLevelIIOplock();

    /**
     * Return the share relative path of the locked file
     *
     * @return String
     */
    public String getPath();

    /**
     * Check if the oplock is on a file or folder
     *
     * @return boolean
     */
    public boolean isFolder();

    /**
     * Check if there is a deferred session attached to the oplock, this indicates an oplock break is
     * in progress for this oplock.
     *
     * @return boolean
     */
    public boolean hasDeferredSessions();

    /**
     * Return the count of deferred requests
     *
     * @return int
     */
    public int numberOfDeferredSessions();

    /**
     * Requeue deferred requests to the thread pool for processing, oplock has been released
     *
     * @return int Number of deferred requests requeued
     */
    public int requeueDeferredRequests();

    /**
     * Fail any deferred requests that are attached to this oplock, and clear the deferred list
     *
     * @return int Number of deferred requests that were failed
     */
    public int failDeferredRequests();

    /**
     * Return the time that the oplock break was sent to the client
     *
     * @return long
     */
    public long getOplockBreakTime();

    /**
     * Check if this oplock is still valid, or an oplock break has failed
     *
     * @return boolean
     */
    public boolean hasOplockBreakFailed();

    /**
     * Check if this is a remote oplock
     *
     * @return boolean
     */
    public boolean isRemoteLock();

    /**
     * Add a deferred session/packet, whilst an oplock break is in progress
     *
     * @param deferredSess SMBSrvSession
     * @param deferredPkt  SMBSrvPacket
     * @throws DeferFailedException If the session/packet cannot be deferred
     */
    public void addDeferredSession(SMBSrvSession deferredSess, SMBSrvPacket deferredPkt)
            throws DeferFailedException;

    /**
     * Update the deferred packet lease time(s) as we wait for an oplock break or timeout
     */
    public void updateDeferredPacketLease();

    /**
     * Set the failed oplock break flag, to indicate the client did not respond to the oplock break
     * request within a reasonable time.
     */
    public void setOplockBreakFailed();

    /**
     * For a shared level II oplock there can be multiple owners, return the number of owners
     *
     * @return int
     */
    public int numberOfOwners();

    /**
     * Add an oplock owner, LevelII oplock may have multiple owners
     *
     * @param owner OplockOwner
     * @exception InvalidOplockStateException Invalid oplock state, does not allow multiple owners
     */
    public void addOplockOwner(OplockOwner owner)
        throws InvalidOplockStateException;

    /**
     * Remove an oplock owner
     *
     * @param owner OplockOwner
     * @return OplockOwner
     * @throws InvalidOplockStateException Not a level II oplock, or empty owner list
     */
    public OplockOwner removeOplockOwner(OplockOwner owner)
        throws InvalidOplockStateException;

    /**
     * Set the owner file id
     *
     * @param fileId int
     */
    public void setOwnerFileId(int fileId);

    /**
     * Update the oplock path when the file is renamed
     *
     * @param path String
     */
    public void updatePath(String path);

    /**
     * Request an oplock break
     *
     * @throws IOException I/O error
     */
    public void requestOpLockBreak()
            throws IOException;

    /**
     * Set the lock type
     *
     * @param lockTyp OpLockType
     */
    public void setLockType(OpLockType lockTyp);

    /**
     * Check if there is an oplock break in progress for this oplock
     *
     * @return boolean
     */
    public boolean hasBreakInProgress();

    /**
     * Clear the oplock break in progress flag
     */
    public void clearBreakInProgress();

    /**
     * Validate an oplock break level
     *
     * @param toLevel int
     * @return boolean
     */
    public boolean isValidBreakLevel(int toLevel);
}