* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package jcifs.internal.smb2.lease;

/**
 * Defines the scope of directory caching for SMB3 directory leasing
 */
public enum DirectoryCacheScope {
    /**
     * Cache only direct children of the directory
     */
    IMMEDIATE_CHILDREN,

    /**
     * Cache entire subtree recursively (if supported by server)
     */
    RECURSIVE_TREE,

    private volatile boolean isComplete;  // True if full enumeration cached
    private volatile boolean hasChanges;  // True if changes detected
    private DirectoryCacheScope scope;
    private long maxAge;
    
    public DirectoryCacheEntry(String path, Smb2LeaseKey key, DirectoryCacheScope scope) {
        this.directoryPath = path;
        this.leaseKey = key;
        this.scope = scope;

    @Test
    public void testConstructor() {
        Smb2LeaseKey key = new Smb2LeaseKey();
        int leaseState = DirectoryLeaseState.DIRECTORY_READ_HANDLE;
        DirectoryCacheScope scope = DirectoryCacheScope.IMMEDIATE_CHILDREN;

        DirectoryLeaseContext context = new DirectoryLeaseContext(key, leaseState, scope);

        assertEquals(key, context.getLeaseKey());

                return cachedFiles.toArray(new SmbFile[0]);
            }
        }

        // Request directory lease if not already present
        DirectoryCacheScope scope = DirectoryCacheScope.valueOf(smbFile.getContext().getConfig().getDirectoryCacheScope());
        Smb2LeaseKey leaseKey = dirManager.requestDirectoryLease(directoryPath,

     * @return the cache scope
     */
    public DirectoryCacheScope getCacheScope() {
        return cacheScope;
    }

    /**
     * Sets the cache scope for directory enumeration caching
     * @param cacheScope the cache scope to set
     */
    public void setCacheScope(DirectoryCacheScope cacheScope) {
        this.cacheScope = cacheScope;
    }

    /**

     * Gets the cache scope (ALL or IMMEDIATE_CHILDREN)
     * @return the cache scope
     */
    public DirectoryCacheScope getScope() {
        return scope;
    }

    /**
     * Sets the cache scope for this directory cache
     * @param scope the cache scope to set
     */
    public void setScope(DirectoryCacheScope scope) {
        this.scope = scope;
    }

    /**

                DirectoryCacheScope.IMMEDIATE_CHILDREN);
        directoryLeaseManager.requestDirectoryLease(dir2, DirectoryLeaseState.DIRECTORY_READ_HANDLE, DirectoryCacheScope.METADATA_ONLY);
        directoryLeaseManager.requestDirectoryLease(dir3, DirectoryLeaseState.DIRECTORY_FULL, DirectoryCacheScope.RECURSIVE_TREE);

        // Verify all cache entries exist

     * @param requestedState requested lease state
     * @param scope cache scope
     * @return lease key
     */
    public Smb2LeaseKey requestDirectoryLease(String directoryPath, int requestedState, DirectoryCacheScope scope) {
        // Directory leasing requires SMB 3.0 or higher
        // MS-SMB2: Level 2 leasing (which includes directory leasing) is only supported in SMB 3.0+

        Smb2LeaseKey key1 = directoryLeaseManager.requestDirectoryLease(dir1, DirectoryLeaseState.DIRECTORY_READ_HANDLE,
                DirectoryCacheScope.IMMEDIATE_CHILDREN);

        Smb2LeaseKey key2 =
                directoryLeaseManager.requestDirectoryLease(dir2, DirectoryLeaseState.DIRECTORY_FULL, DirectoryCacheScope.RECURSIVE_TREE);

        assertNotNull(key1);
        assertNotNull(key2);
        assertNotEquals(key1, key2);

     */
    protected boolean useDirectoryLeasing = true;
    /**
     * The scope of directory caching: ALL (entire subtree) or IMMEDIATE_CHILDREN (direct children only)
     */
    protected String directoryCacheScope = "IMMEDIATE_CHILDREN";
    /**
     * Directory cache timeout in milliseconds
     */
    protected long directoryCacheTimeout = 30000L;
    /**