# Directory Leasing Feature - Detailed Design Document

## 1. Overview

Directory leasing extends the SMB3 lease concept to directories, enabling client-side caching of directory metadata and change notifications. This significantly improves performance for applications that frequently enumerate directories or monitor directory changes.

## 2. Protocol Specification Reference

- **MS-SMB2 Section 2.2.13.2.12**: SMB2_CREATE_REQUEST_LEASE_V2 for directories

     * @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+
        // We'll validate this when we actually need to use the session

        // Request base lease

                    } else if (StringUtil.isBlank(reading) && StringUtil.isBlank(boost)) {
                        elevateWordBhv.delete(elevateWord);
                        final String id = elevateWord.getId();
                        elevateWordToLabelBhv.queryDelete(cb -> cb.query().setElevateWordId_Equal(id));
                    } else {
                        elevateWord.setReading(reading);

 *       normalization, contents, and contents reading) for a specific field.</li>
 * </ul>
 *
 * @see SuggestAnalyzer
 * @see FieldAnalyzerMapping
 */
public class AnalyzerSettings {
    /** Analyzer name for reading. */
    public static final String READING_ANALYZER = "reading_analyzer";
    /** Analyzer name for reading term. */

        assertEquals("\\server\\share", normalizedPath);

        // To properly test UNC rejection, we would need to fix the normalization logic
        // to preserve the leading double backslash for UNC paths
    }

    @Test
    public void testInvalidUncPath() throws Exception {
        // Due to normalization removing duplicate backslashes, true UNC validation doesn't work

 * <li>{@link #langFieldName} - Language field name.
 * <li>{@link #badWords} - List of bad words.
 * <li>{@link #parallel} - Flag for parallel processing.
 * <li>{@link #readingConverter} - Reading converter.
 * <li>{@link #contentsReadingConverter} - Contents reading converter.
 * <li>{@link #normalizer} - Normalizer.
 * <li>{@link #analyzer} - Suggest analyzer.
 * <li>{@link #contentsParser} - Contents parser.

/**
 * <p>
 * {@link ESSourceReader} reads documents from Elasticsearch using the scroll API.
 * It implements the {@link DocumentReader} interface to provide a way to iterate over documents
 * in a large index without loading all of them into memory at once.
 * </p>
 *
 * <p>
 * The reader supports limiting the number of documents read based on a percentage of the total documents

            assertEquals(0x1, Smb2Constants.SMB2_GLOBAL_CAP_DFS, "DFS capability must be 0x1");
        }

        @Test
        @DisplayName("Leasing capability should be 0x2")
        void testGlobalCapLeasing() {
            assertEquals(0x2, Smb2Constants.SMB2_GLOBAL_CAP_LEASING, "Leasing capability must be 0x2");
        }

        @Test
        @DisplayName("Large MTU capability should be 0x4")

                        final String reading = readingList.get(readingCount);
                        if (i + 1 == queries.length && prefixQuery) {
                            readingQueryBuilder.should(QueryBuilders.prefixQuery(fieldName, reading));
                        } else {
                            readingQueryBuilder.should(QueryBuilders.termQuery(fieldName, reading));
                        }
                    }

                if (readings != null && readings.length > i && readings[i].length > 0) {
                    for (final String reading : readings[i]) {
                        if (!l.contains(reading)) {
                            l.add(reading);
                        }
                    }
                }

                wordsList.add(word);