# 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

    /**
     * Enable or disable sensitive data masking
     *
     * @param enable true to enable masking
     */
    public void setSensitiveDataMaskingEnabled(boolean enable) {
        this.maskSensitiveData = enable;
        log.info("Sensitive data masking {}", enable ? "enabled" : "disabled");
    }

    /**
     * Enable or disable high performance mode for sensitive data masking
     *

    }

    /**
     * Creates the OpenSearch index mapping for the specified mapping name.
     * If the index doesn't exist, it will be created with the configured number of shards and replicas.
     * If the mapping doesn't exist, it will be created from the JSON file in the mapping directory.
     *
     * @param mappingName The name of the mapping to create.
     */

    /**
     * Gets the path mapping list with paging.
     *
     * @param pathMappingPager the path mapping pager
     * @return the path mapping list
     */
    public List<PathMapping> getPathMappingList(final PathMapPager pathMappingPager) {

        final PagingResultBean<PathMapping> pathMappingList = pathMappingBhv.selectPage(cb -> {

            });
        });
    }

    /**
     * Displays the form for editing an existing path mapping.
     *
     * @param form the edit form containing the path mapping ID and data
     * @return HTML response for the path mapping edit form
     */
    @Execute
    @Secured({ ROLE })
    public HtmlResponse edit(final EditForm form) {

    /** Service for managing path mapping configurations */
    @Resource
    private PathMappingService pathMappingService;

    // GET /api/admin/pathmap
    // PUT /api/admin/pathmap
    /**
     * Returns list of path mapping settings.
     * Supports both GET and PUT requests for retrieving paginated path mapping configurations.
     *

 * 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)

    /** Type identifier for character mapping dictionaries. */
    private static final String MAPPING = "mapping";

    /** List of character mapping items loaded from the mapping file. */
    List<CharMappingItem> mappingItemList;

    /**
     * Constructs a new CharMappingFile instance.
     *
     * @param id the unique identifier for this mapping file

    /**
     * Retrieve list of character mapping entries for the specified dictionary.
     *
     * @param dictId identifier of the dictionary
     * @param body search criteria and paging parameters
     * @return JSON response containing list of mapping entries
     */
    // GET /api/admin/dict/mapping/settings/{dictId}
    @Execute

    /**
     * Retrieves a specific character mapping item by its ID from the specified dictionary.
     * <p>
     * This method looks up a character mapping item using its unique identifier
     * within the context of the specified dictionary.
     * </p>
     *
     * @param dictId the dictionary ID containing the character mapping item
     * @param id the unique identifier of the character mapping item