org.filesys.server.locking.OplockOwner 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) 2018 GK Spencer
 *
 * JFileServer 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.
 *
 * JFileServer 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 JFileServer. If not, see .
 */

package org.filesys.server.locking;

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

/**
 * Oplock Owner Interface
 *
 * @author gkspencer
 */
public interface OplockOwner {

    /**
     * Check if the oplock owner matches this oplock owner for the type of oplock
     *
     * @param opType    OplockType
     * @param opOwner   OplockOwner
     * @return boolean
     */
    public boolean isOwner(OpLockType opType, OplockOwner opOwner);

    /**
     * Return the session that owns the oplock
     *
     * @return SMBSrvSession
     */
    public SMBSrvSession getSession();

    /**
     * Return a short unique id string for the oplock owner
     *
     * @return String
     */
    public String getUniqueId();

    /**
     * Return the owner node id, for cluster environment
     *
     * @return String
     */
    public String getOwnerNode();

    /**
     * Set the owner node id, for cluster environment
     *
     * @param nodeId String
     */
    public void setOwnerNode(String nodeId);
}