org.filesys.oncrpc.nfs.ShareDetails 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.oncrpc.nfs;

/**
 * Share Details Class
 *
 * Contains the file id cache, active search cache and tree connection details of a shared
 * filesystem.
 *
 * @author gkspencer
 */
public class ShareDetails {

    //	Share name
    private String m_name;

    //	File id to path conversion cache
    private FileIdCache m_idCache;

    //	Flag to indicate if the filesystem driver for this share supports file id lookups
    //	via the FileIdInterface
    private boolean m_fileIdLookup;

    /**
     * Class constructor
     *
     * @param name          String
     * @param fileIdSupport boolean
     */
    public ShareDetails(String name, boolean fileIdSupport) {

        //	Save the share name
        m_name = name;

        //	Set the file id support flag
        m_fileIdLookup = fileIdSupport;

        //	Create the file id and search caches
        m_idCache = new FileIdCache();
    }

    /**
     * Return the share name
     *
     * @return String
     */
    public final String getName() {
        return m_name;
    }

    /**
     * Return the file id cache
     *
     * @return FileIdCache
     */
    public final FileIdCache getFileIdCache() {
        return m_idCache;
    }

    /**
     * Determine if the filesystem driver for this share has file id support
     *
     * @return boolean
     */
    public final boolean hasFileIdSupport() {
        return m_fileIdLookup;
    }
}