# CLAUDE.md

This file provides guidance to Claude Code when working with this repository.

## Project Overview

Fess is an Enterprise Search Server built on OpenSearch. It's a Java-based web application that crawls and indexes documents from various sources and provides full-text search capabilities. Licensed under Apache License 2.0.

**Key Capabilities:**
- Full-text search with OpenSearch backend
- Web, file system, and data store crawling

     */
    protected HtmlResponse doSearch(final ListForm form) {
        validate(form, messages -> {}, this::asListHtml);

        if (StringUtil.isBlank(form.q)) {
            // query matches on all documents.
            form.q = Constants.MATCHES_ALL_QUERY;
        }
        final WebRenderData renderData = new WebRenderData();
        form.initialize();

    var $favorite = $(this);
    var values = $favorite.attr("href").split("#");

    if (values.length === 2 && $queryId.length > 0) {
      var docId = values[1];
      var actionUrl = contextPath + "/api/v1/documents/" + docId + "/favorite";

      $.ajax({
        dataType: "json",
        cache: false,
        type: "post",
        timeout: AJAX_TIMEOUT,
        url: actionUrl,
        data: {

     *
     * @param query the search query string
     * @param params the search request parameters
     * @param userBean the optional user bean for access control
     * @return the search result containing documents and metadata
     */
    @Override
    protected SearchResult search(final String query, final SearchRequestParams params, final OptionalThing<FessUserBean> userBean) {
        final int pageSize = params.getPageSize();

import org.codelibs.fess.util.ComponentUtil;
import org.codelibs.fess.util.DocumentUtil;

/**
 * HTML tag-based thumbnail generator that creates thumbnails from image content
 * referenced in HTML documents. This generator extracts images from HTML content
 * and processes them to create thumbnail images based on configured dimensions
 * and format settings.
 *

import org.codelibs.fess.util.JobProcess;
import org.codelibs.fess.util.ResourceUtil;
import org.codelibs.fess.util.SystemUtil;

import jakarta.servlet.ServletContext;

/**
 * Job class for generating thumbnails for documents in the search engine.
 * This job executes the ThumbnailGenerator process as a separate JVM process
 * to create thumbnail images for supported document types.
 */
public class GenerateThumbnailJob extends ExecJob {

Fess also contains a Crawler, which can crawl documents on a [web server](https://fess.codelibs.org/15.5/admin/webconfig-guide.html), [file system](https://fess.codelibs.org/15.5/admin/fileconfig-guide.html), or [Data Store](https://fess.codelibs.org/15.5/admin/dataconfig-guide.html) (such as a CSV or...

                executor.shutdown();
                executor.awaitTermination(5, TimeUnit.SECONDS);
            }
        }
    }

    /**
     * Test searcher that returns configurable number of documents.
     */
    static class TestSearcher extends RankFusionSearcher {
        private final long allRecordCount;

        TestSearcher(long allRecordCount) {
            this.allRecordCount = allRecordCount;

 * This class defines tag patterns that match HTML elements based on tag name, CSS class, ID, or custom attributes.
 * It is used to identify and remove unwanted HTML elements from crawled documents.
 */
public class PrunedTag {
    /** The HTML tag name to match (e.g., "div", "span", "p") */
    private final String tag;
    /** The ID attribute value to match */
    private String id;

        dataStore = new DataStore() {
            @Override
            public void store(DataConfig config, IndexUpdateCallback callback, DataStoreParams initParamMap) {
                // Simulate storing documents
                Map<String, Object> doc1 = new HashMap<>();
                doc1.put("id", "1");
                doc1.put("title", "Document 1");
                callback.store(initParamMap, doc1);