org.filesys.smb.server.VirtualCircuitList 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

There is a newer version: 1.4.0

/*
 * 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.smb.server;

import org.filesys.server.SrvSession;
import org.filesys.server.auth.ClientInfo;

import java.util.Iterator;


/**
 * Virtual Circuit List Class
 *
 * Contains a list of virtual circuits that belong to a session.
 *
 * @author gkspencer
 */
public interface VirtualCircuitList {

    /**
     * Create a virtual circuit object
     *
     * @param vcNum int
     * @param client ClientInfo
     * @return VirtualCircuit
     */
    public VirtualCircuit createVirtualCircuit(int vcNum, ClientInfo client);

    /**
     * Return the maximum virtual circuits allowed
     *
     * @return int
     */
    public int getMaximumVirtualCircuits();

    /**
     * Add a new virtual circuit to this session. Return the allocated id for the new circuit.
     *
     * @param vcircuit VirtualCircuit
     * @return int   Allocated id
     */
    public int addCircuit(VirtualCircuit vcircuit);

    /**
     * Return the virtual circuit details for the specified id.
     *
     * @param id int
     * @return VirtualCircuit
     */
    public VirtualCircuit findCircuit(int id);

    /**
     * Remove the specified virtual circuit from the active circuit list.
     *
     * @param id  int
     * @param sess SrvSession
     */
    public void removeCircuit(int id, SrvSession sess);

    /**
     * Return the virtual circuit count
     *
     * @return int
     */
    public int getCircuitCount();

    /**
     * Clear the virtual circuit list
     *
     * @param sess SMBSrvSession
     */
    public void clearCircuitList(SMBSrvSession sess);

    /**
     * Iterate the virtual circuits
     *
     * @return Iterator<VirtualCircuit>
     */
    public Iterator iterator();
}