All Classes and Interfaces
Class
Description
The abstract helper for configuration.
The abstract class for DataStore.
The abstract transformer for Fess.
Abstract base class for LLM client implementations.
The abstract class for ScriptEngine.
The logic for access context.
The supplier of application type.
The supplier of user bean.
The supplier of user type.
The helper for access token.
The pager for access token.
The service for access token.
The form for maintenance actions.
The credential for action response.
The helper for user activities.
The action.
Admin action for Access Token management.
The action for admin pages.
Admin action for Backup management.
Admin action for Bad Word management.
Admin action for Boost Document management.
Admin action for Crawling Info management.
Admin action for Dashboard.
Admin action for Data Config management.
Admin action for Design management.
Admin action for Dictionary management.
Admin action for Kuromoji dictionary management.
Admin action for Mapping management.
Admin action for Protected Words management.
Admin action for Stemmer Override management.
Admin action for Stopwords management.
Admin action for Synonym management.
Admin action for Duplicate Host management.
Admin action for Elevate Word management.
Admin action for Failure URL management.
Admin action for File Authentication management.
Admin action for File Config management.
Admin action for General settings.
Admin action for Group management.
Admin action for Job Log.
Admin action for Key Match management.
Admin action for Label Type management.
Admin action for Log.
Admin action for maintenance operations including reindexing, log management,
and system diagnostics.
Admin action for Path Map management.
Admin action for Plugin management.
Admin action for Related Content management.
Admin action for Related Query management.
Admin action for Request Header management.
Admin action for Role management.
Admin action for Scheduler management.
Admin action for Search List.
Web-specific implementation of SearchRenderData for rendering search results in the admin interface.
Admin action for Search Log.
Admin action for Search Request.
Admin action for Storage management.
Container class for path information containing separate path and name components.
Admin action for suggest management.
Admin action for System Info.
Admin action for theme management (spec §8).
Admin action for User management.
Admin action for Web Authentication management.
Admin action for Web Config management.
Admin action for configuration wizard.
Job for aggregating and storing search logs.
Job scheduler for managing all scheduled jobs in Fess.
API action for admin access token.
API action for admin backup.
API action for admin bad word management.
API action for admin boost doc.
API action for admin crawling info.
API action for admin data config.
API action for admin dictionary management.
API action for admin Kuromoji dictionary management.
API action for CRUD and file operations on dictionary character mappings.
API action for CRUD and file operations on dictionary protected words (protwords).
API action for admin Stemmer Override dictionary management.
API action for admin Stopwords dictionary management.
API action for admin Synonym dictionary management.
API action for admin document management.
API action for admin duplicate host management.
API action for admin elevate word management.
API action for admin failure URL.
API action for admin file authentication management.
API action for admin file configuration management.
API action for admin general settings management.
API action for admin group management.
API action for admin job log management.
API action for admin key match management.
API action for admin label type management.
API action for admin log management.
API action for admin path mapping management.
API action for admin plugin management.
API action for admin related content management.
API action for admin related query management.
API action for admin request header management.
API action for admin role management.
API action for admin scheduler management.
API action for admin search list management.
API action for admin statistics management.
Data transfer object representing search engine cluster statistics.
Data transfer object representing filesystem statistics.
Data transfer object representing JVM class loading statistics.
Data transfer object representing JVM garbage collection statistics.
Data transfer object representing JVM heap memory statistics.
Data transfer object representing JVM non-heap memory statistics.
Data transfer object representing JVM memory statistics.
Data transfer object representing JVM statistics.
Data transfer object representing JVM buffer pool statistics.
Data transfer object representing JVM thread statistics.
Data transfer object representing OS CPU statistics.
Data transfer object representing OS memory statistics.
Data transfer object representing OS physical memory statistics.
Data transfer object representing OS swap space statistics.
Data transfer object representing operating system statistics.
Data transfer object representing process CPU statistics.
Data transfer object representing process file descriptor statistics.
Data transfer object representing process statistics.
Data transfer object representing process virtual memory statistics.
Handles API requests for storage management in the Fess application.
API action for admin suggest management.
API action for admin system information management.
API action for admin user management.
API action for admin web authentication management.
API action for admin web configuration management.
This class represents the base response structure for API results.
Represents an API response containing a list of backup files.
Represents an API response for bulk operations, containing a list of processed items.
Represents an API response for configuration settings.
Represents an API response for a list of configuration settings.
Represents an API response for a delete operation.
Represents an API response for a single document.
Represents an API response for search results, including document list, pagination, and facet information.
Represents an API response for an error.
Represents an API response containing a list of log files.
Represents an API response for a log entry.
Represents an API response for a list of logs.
Represents an API response for plugin information.
Represents the base API response structure.
Represents an API response for a start job operation.
Represents an API response containing statistical information.
Represents an API response for storage-related operations, typically containing a list of items.
Represents an API response containing system information.
Represents an API response for an update operation.
Represents the status of an API response.
Interface for authentication chain operations.
Manages authentication operations across multiple authentication chains.
Pager class for bad word management with pagination support.
Service class for bad word management operations.
Base implementation for API managers providing common functionality.
Enumeration of supported API format types.
Base class for search request body objects in admin API.
Base class for dictionary search request body objects in admin API.
Abstract base class for thumbnail generators.
BCrypt implements OpenBSD-style Blowfish password hashing using
the scheme described in "A Future-Adaptable Password Scheme" by
Niels Provos and David Mazieres.
Functional interface for boolean functions.
Query command implementation for handling Boolean queries.
Pager class for boost document management with pagination support.
Service class for boost document rule management operations.
Query command implementation for handling Boost queries.
Request body for bulk document operations containing a list of documents.
Action class for handling cached document content requests.
Form class for cache-related operations.
Handles
GET /api/v2/cache/{docId}.Creator for character mapping dictionary files.
Character mapping file handler for managing character mapping dictionaries.
Represents a single character mapping rule that defines how input characters are mapped to output characters
for text analysis and search processing.
Pager class for character mapping management with pagination support.
Service class for managing character mapping operations.
Action class for the RAG chat page.
Shared utilities for v2 chat API handlers.
Client class for RAG (Retrieval-Augmented Generation) chat functionality.
Result of a chat request.
Search request parameters for RAG chat context retrieval.
Result of a search operation, including queryId and requestedTime.
Resolves the content of relevant documents for the LLM answer context.
Request object for
ChatContentFetcher.Form class for chat requests.
Handles
POST /api/v2/chat — non-streaming RAG chat.Represents the intent type detected from a user's chat message.
Represents a message in a chat conversation.
Represents a source document referenced in the chat response.
Callback interface for receiving notifications about chat processing phases.
Parsed view of a chat request body shared by
ChatHandler and
ChatStreamHandler.Base for chat request body validation errors that map to HTTP 400.
Thrown when session_id exceeds the maximum length or contains invalid characters.
Thrown when the request
message exceeds rag.chat.message.max.length.Thrown when an array parameter (extra_queries, fields.label) exceeds the count or per-element length limit.
Represents a chat session containing conversation history.
Handles
DELETE /api/v2/chat/sessions/{session_id} — clears the
conversation history for a specific chat session.Manager class for chat sessions.
Handles
POST /api/v2/chat/stream — Server-Sent Events streaming RAG chat.Handles
POST /api/v2/click.Authentication chain implementation that executes external commands for user operations.
Thread that reads input stream data and buffers it for later retrieval.
Monitor thread that handles process timeout and termination.
Exception thrown when command execution fails.
Command-based thumbnail generator that executes external commands to create thumbnails.
Timer task for destroying processes that exceed their timeout.
Utility class for accessing system components and dependencies.
Constants class that extends CoreLibConstants and contains application-wide constant values for the Fess search engine.
Exception thrown when a dependency injection container or component is not available.
Exception thrown when requested content cannot be found.
Helper for inter-instance coordination via OpenSearch.
Represents an inter-instance event notification.
Represents an active Fess instance discovered via heartbeat.
Represents the state of a distributed operation lock.
Filter for handling Cross-Origin Resource Sharing (CORS) requests.
Abstract base class for handling CORS (Cross-Origin Resource Sharing) requests.
Factory for managing CORS handlers based on origin.
Describes how a request
Origin matched the configured CORS allow list.Result of resolving a request
Origin against the CORS allow list.Main executable class for running crawling operations in the Fess search engine.
Command-line options container for the crawler application.
OpenSearch client implementation specifically for crawler operations.
Helper class for crawler logging operations.
Helper class for managing crawler statistics and performance metrics.
Enumeration of predefined statistics actions that can be recorded
during crawler operations.
Key object for statistics tracking that contains an identifier and optional URL.
Statistics data object that stores timestamped events and maintains reference counting.
Form class for crawling configuration wizard in the admin interface.
Helper class for managing crawling configurations.
Helper class for managing crawling information and statistics.
Pager implementation for crawling information pagination.
Service class that manages crawling information and parameters.
CrawlJob is responsible for executing the crawling process in Fess.
Request body for creating access token via REST API.
Request body for creating bad word via REST API.
Request body for creating boost document via REST API.
Request body for creating data config via REST API.
Request body for creating kuromoji dictionary via REST API.
Request body for creating mapping dictionary via REST API.
Request body for creating protected words dictionary via REST API.
Request body for creating stemmer override dictionary via REST API.
Request body for creating stop words dictionary via REST API.
Request body for creating synonym dictionary via REST API.
Request body for creating duplicate host via REST API.
Request body for creating elevate word via REST API.
Request body for creating file authentication via REST API.
Request body for creating file configuration via REST API.
Request body for creating group via REST API.
Request body for creating key match via REST API.
Request body for creating label type via REST API.
Request body for creating path mapping via REST API.
Request body for creating related content via REST API.
Request body for creating related query via REST API.
Request body for creating request header via REST API.
Request body for creating role via REST API.
Request body for creating scheduler via REST API.
Request body for creating search list via REST API.
Request body for creating user via REST API.
Request body for creating web authentication via REST API.
Request body for creating web configuration via REST API.
Form class for creating access tokens in the admin interface.
The create form for Bad Word.
Form class for creating boost document configurations.
Form class for creating data store configurations.
Form class for creating Kuromoji dictionary entries.
Form class for creating mapping dictionary entries.
Form class for creating protected words dictionary entries.
Form class for creating new stemmer override dictionary entries.
Form class for creating new stopwords dictionary entries.
Form class for creating new synonym dictionary entries.
Form class for creating new duplicate host configuration entries.
Form class for creating new elevate word configuration entries.
The create form for File Authentication.
The create form for File Config.
The create form for Group.
The create form for Key Match.
The create form for Label Type.
The create form for Path Map.
The create form for managing related content.
The create form for managing related queries.
The create form for Request Header.
The create form for Role.
The create form for Scheduler.
The create form for Search List.
The create form for User.
The create form for Web Authentication.
The create form for Web Config.
Validation constraint to ensure that a string is a valid cron expression.
Validator implementation for the CronExpression constraint.
Constants for CRUD operation modes.
Static decision table for spec §7.3 CSRF rules.
Helper class for managing HTTP requests using cURL-like operations.
Validation constraint for custom size limits based on configuration keys.
Validator implementation for the CustomSize constraint.
Pager for data configuration management with standard paging functionality.
Service class for managing data configuration CRUD operations.
Helper class for managing data crawling operations in Fess.
Inner thread class for executing data store crawling operations.
A serializer class for handling object serialization and deserialization.
The interface for DataStore.
Exception thrown when an error occurs during data store crawling operations.
Exception thrown when an error occurs during data store operations.
Factory class responsible for managing and providing access to data store instances.
Parameter container class for data store configurations and runtime parameters.
Default
ChatContentFetcher.Chat search params restricted to specific doc ids, using the answer-specific
highlight settings (
rag.chat.answer.highlight.*) instead of the
display-oriented rag.chat.highlight.*.Per-document content resolution strategy.
Default implementation of CORS (Cross-Origin Resource Sharing) handler.
Default implementation of QueryBuilder that wraps other QueryBuilder instances
and provides additional functionality for adding inner queries dynamically.
Default implementation of RankFusionSearcher that performs standard OpenSearch queries.
Request body class for plugin deletion API endpoint.
Form class for plugin deletion operations in the admin interface.
Form class for deleting documents from search results in the admin interface.
Form class for design file management in the admin interface.
Abstract base class for creating dictionary files from file paths.
Exception thrown when dictionary operations encounter errors.
Exception thrown when a dictionary has expired and is no longer valid.
Abstract base class for dictionary files that manage dictionary items.
A paginated list implementation that wraps another list and provides
pagination metadata and functionality.
Abstract base class for all dictionary items in the Fess search system.
Manager class for handling dictionary files in the Fess search system.
A matcher class for applying document boost values based on configurable expressions.
Shared validation for the
doc_id parameter used by the document-keyed v2
handlers (CacheHandler, ClickHandler, FavoriteGetHandler,
FavoritePostHandler).A specialized ArrayList for storing document data with additional metadata.
A wrapper implementation of Map<String, Object> that provides special handling
for document data.
Helper class for document processing and manipulation in the Fess search system.
Utility class for document data manipulation and type conversion.
Download body for Bad Word API operations.
Download body for Kuromoji dictionary API operations.
Download body for mapping dictionary API operations.
Download body for protected words dictionary API operations.
Download body for stemmer override dictionary API operations.
Download body for stop words dictionary API operations.
Download body for synonym dictionary API operations.
Download body for elevate word API operations.
The download form for Bad Word.
The download form for Kuromoji dictionary.
The download form for mapping dictionary.
The download form for protected words dictionary.
The download form for stemmer override dictionary.
The download form for stop words dictionary.
The download form for synonym dictionary.
The download form for Elevate Word.
Helper class for managing duplicate host configurations in the Fess search system.
Pager for duplicate host management with standard paging functionality.
Service class for managing duplicate host configuration CRUD operations.
Request body class for access token edit operations in the admin REST API.
Request body class for bad word edit operations in the admin REST API.
Request body class for boost document edit operations in the admin REST API.
Request body class for crawling info edit operations in the admin REST API.
Request body class for data config edit operations in the admin REST API.
Request body class for Kuromoji dictionary edit operations in the admin REST API.
Request body class for mapping dictionary edit operations in the admin REST API.
Request body class for protected words dictionary edit operations in the admin REST API.
Request body class for stemmer override dictionary edit operations in the admin REST API.
Request body class for stop words dictionary edit operations in the admin REST API.
Request body class for synonym dictionary edit operations in the admin REST API.
Request body class for duplicate host edit operations in the admin REST API.
Request body class for elevate word edit operations in the admin REST API.
Request body class for failure URL edit operations in the admin REST API.
Request body class for file authentication edit operations in the admin REST API.
Request body class for file config edit operations in the admin REST API.
Request body class for general settings edit operations in the admin REST API.
Request body class for group edit operations in the admin REST API.
Request body class for job log edit operations in the admin REST API.
Request body class for key match edit operations in the admin REST API.
Request body class for label type edit operations in the admin REST API.
Request body class for path mapping edit operations in the admin REST API.
Request body class for related content edit operations in the admin REST API.
Request body class for related query edit operations in the admin REST API.
Request body class for request header edit operations in the admin REST API.
Request body class for role edit operations in the admin REST API.
Request body class for scheduler edit operations in the admin REST API.
Request body class for search list edit operations in the admin REST API.
Request body class for user edit operations in the admin REST API.
Request body class for web authentication edit operations in the admin REST API.
Request body class for web config edit operations in the admin REST API.
Form class for editing access tokens in the admin interface.
Form class for editing bad words in the admin interface.
Form class for editing boost document configurations in the admin interface.
Form class for editing crawling information in the admin interface.
Form class for editing data crawling configurations in the admin interface.
Form class for editing design files in the admin interface.
Form class for editing Kuromoji dictionary entries in the admin interface.
Form class for editing mapping dictionary entries in the admin interface.
Form class for editing protected words dictionary entries in the admin interface.
Form class for editing stemmer override dictionary entries in the admin interface.
Form class for editing stopwords dictionary entries in the admin interface.
Form class for editing synonym dictionary entries in the admin interface.
Form class for editing duplicate host configurations in the admin interface.
Form class for editing elevate word configurations in the admin interface.
Form class for editing failure URL records in the admin interface.
Form class for editing file authentication configurations in the admin interface.
Form class for editing file crawling configurations in the admin interface.
Form class for editing general system settings in the admin interface.
Form class for editing user groups in the admin interface.
Form class for editing job log entries in the admin interface.
Form class for editing key match configurations in the admin interface.
Form class for editing label types in the admin interface.
Form class for editing path mapping configurations in the admin interface.
Form class for editing related content configurations in the admin interface.
The edit form for Related Query.
Form class for editing request header configurations in the admin interface.
Form class for editing user roles in the admin interface.
Form class for editing scheduled job configurations in the admin interface.
The edit form for Search List.
The edit form for Search Log.
Form class for editing users in the admin interface.
Form class for editing web authentication configurations in the admin interface.
Form class for editing web crawling configurations in the admin interface.
Pagination support class for ElevateWord entities.
Service class for managing elevate words functionality.
Empty implementation of thumbnail generator that does not generate any thumbnails.
Servlet filter for handling character encoding conversion and URL redirection.
Microsoft Entra ID SSO authenticator implementation.
Represents state data stored during the OAuth2 authentication flow.
Microsoft Entra ID credential implementation for Fess authentication.
Entra ID user implementation providing user information and permissions.
Action class for handling general error pages.
Action class for handling HTTP 400 Bad Request error pages.
Action class for handling HTTP 429 Too Many Requests error pages.
Form class for handling error page data and search parameters.
Action class for handling HTTP 404 Not Found error pages.
Action class for handling HTTP 500 Internal Server Error pages.
Log4j rewrite policy that converts ERROR level log events to WARN level for specified loggers.
Abstract base class for executable jobs in the Fess search engine.
Entity class representing facet configuration information for search results.
View class for managing facet query configurations and their display.
Response object for faceted search results containing query counts and field facets.
Represents a field facet with its name and value counts.
A pager class for managing pagination of failure URL records.
Service class for managing failure URLs that occur during web crawling.
Handles
GET /api/v2/documents/{docId}/favorite.Service class for managing favorite log operations.
Handles
POST /api/v2/documents/{docId}/favorite.Handles
GET /api/v2/favorites.Fess-specific action validator that extends the LastaFlute ActionValidator.
Base action class for admin pages in Fess.
Abstract base class for Fess API actions that provides common functionality
for API endpoints including authentication, message handling, and access control.
Abstract base class for admin API actions in Fess.
Abstract base class for Fess application services.
The base action class for Fess web application.
Main boot class for the Fess search engine application.
Fess-specific crawler configuration that extends OpenSearchCrawlerConfig.
FessCrawlerThread is a specialized crawler thread implementation for the Fess search engine.
Interface for Fess credential management.
File transformer implementation for the Fess search engine.
Utility class providing static functions for Fess JSP/JSTL expressions and tag libraries.
FessIntervalController extends DefaultIntervalController to provide
Fess-specific interval control functionality for web crawling operations.
Abstract base action class for handling login functionality in Fess.
The assist for login handling in the Fess application.
A resolver for login credentials that wraps the standard credential resolver
to provide SSO authentication support.
FessMimeTypeHelper extends MimeTypeHelperImpl to provide Fess-specific
MIME type detection configuration.
Response processor implementation for the Fess search engine.
Abstract base class for search-related actions in the Fess search application.
Standard transformer implementation for the Fess search engine.
System exception class for the Fess search engine.
Interface for transforming and processing crawled documents in Fess.
Fess-specific URL queue service that extends OpenSearch URL queue functionality.
Interface representing a Fess user with authentication and authorization information.
Exception thrown when a user is not found in the Fess system.
Fess-specific web resource root implementation for Tomcat.
A transformer implementation for processing HTML documents using XPath expressions.
Utility class for managing field configurations with parameter mappings.
Configuration class that holds parsed configuration values for a field.
Form class for file access operations in the admin design interface.
Service class for managing file authentication configurations.
A pager class for file authentication entries, providing pagination functionality
for file authentication configurations with search and display capabilities.
Pager class for file crawler configuration management.
Service class for managing file configuration operations.
Implementation of IndexUpdateCallback that handles file list index updates with concurrent processing.
Helper class for managing file type mappings based on MIME types.
Query command implementation for handling fuzzy search queries.
Google Cloud Storage client implementation.
Job class for generating thumbnails for documents in the search engine.
Entity class that handles geographic information for search queries.
Action class for handling document redirection requests.
Form class for handling "go" requests that redirect users to specific documents
or search results.
Groovy script engine implementation that extends AbstractScriptEngine.
GroupPager provides pagination functionality for group management operations in Fess.
Service class for managing group operations in the Fess application.
Exception thrown when GSA (Google Search Appliance) configuration errors occur.
Parser for Google Search Appliance (GSA) configuration files.
Handles the
/api/v2/health endpoint.Action class for handling help page requests in the Fess search application.
Entity class containing highlighting configuration for search result text highlighting.
Monitor target for tracking hot threads in the OpenSearch cluster.
Formatter that outputs index documents as HTML files.
HTML tag-based thumbnail generator that creates thumbnails from image content
referenced in HTML documents.
Enumeration representing the possible results of thumbnail image processing.
Implementation of DBFlute's InvokerAssistant interface for OpenSearch integration.
Strategy interface for formatting exported index documents.
Job for exporting indexed search documents to the filesystem.
Form class for the admin wizard index page.
Helper class for indexing operations in the Fess search engine.
Callback interface for handling index update operations during data store processing.
Implementation of IndexUpdateCallback for handling document indexing operations.
IndexUpdater is responsible for updating the search index with crawled document data.
Abstract base class for document ingesters that process and transform documents
before they are indexed.
Factory class for managing and organizing document ingesters.
A thread that reads from an input stream line by line and maintains a buffer of recent lines.
Request body for plugin installation API.
Form for plugin installation through the admin web interface.
Represents the result of intent detection from user input.
Helper class for controlling crawler execution intervals and timing.
Represents a rule for controlling crawler intervals.
Exception thrown when an invalid access token is encountered.
Exception thrown when an invalid query is encountered.
Thrown when a v2 API request parameter violates a length, item-count, or
format constraint.
Utility class for handling IP addresses, particularly IPv6 addresses in URLs.
Form class for storage item operations in the admin interface.
Abstract base class for job executors that handle script execution within the job system.
Interface for listening to shutdown events.
Helper class for managing scheduled jobs within the Fess system.
Pager class for managing job log pagination in the admin interface.
Service class for managing job logs in the Fess application.
Exception thrown when a scheduled job cannot be found.
A wrapper class that manages a system process for job execution.
Exception thrown when an error occurs during job processing.
Formatter that outputs index documents as JSON files.
Utility class for JVM-related operations.
KeyMatchHelper is a helper class for KeyMatch feature.
Pager for KeyMatch.
Service class for KeyMatch.
A dictionary creator for Kuromoji.
Utility class for parsing CSV text
A dictionary file for Kuromoji.
An item in a Kuromoji dictionary.
Pager for Kuromoji.
Service class for Kuromoji.
Handles the
/api/v2/labels endpoint.Helper class for label types.
An item of a label type.
A pattern of a label type.
Pager for label types.
Service class for label types.
Helper class for language detection.
An authentication chain for LDAP.
An exception thrown when LDAP configuration is invalid.
Manages LDAP connections and operations.
An exception thrown when an LDAP operation fails.
An LDAP user.
Utility class for LDAP operations.
The request body for listing dictionaries.
The list form for Dictionary.
The list form for Search List.
Request object for LLM chat completion.
Response object for LLM chat completion.
Interface for LLM (Large Language Model) clients.
Manager class for coordinating LLM (Large Language Model) client operations.
Exception thrown when an error occurs during LLM operations.
Represents a message in a chat conversation.
Callback interface for receiving streaming chat responses from LLM.
Filter for CPU load-based request control.
Timeout target that periodically monitors search engine CPU usage.
The credential for a local user.
The login action.
The login form.
Handles
POST /api/v2/auth/login.In-memory, per-instance rate limiter for /api/v2/auth/login (and /auth/password).
Rate-limit scope: distinguishes the bucket namespace so the same
key value (e.g.Custom Log4j2 Appender that captures log events into a buffer for notification purposes.
Helper that manages the lifecycle of the log notification timer and
buffers log notification events for periodic flushing to OpenSearch.
Represents a captured log event for notification.
Job for sending log notifications.
A timer target that periodically flushes buffered log notification events
to an OpenSearch index for downstream processing.
The logout action.
Handles
POST /api/v2/auth/logout.Learning to Rank query rescorer implementation.
The mail form for General settings.
Renders markdown to sanitized HTML for safe display in the chat interface.
Query command for match all documents query.
Handles
GET /api/v2/auth/me.Utility class for memory operations and size calculations.
Abstract base class for monitor targets that implement timeout functionality.
Helper class for sending notifications to various platforms.
OpenID Connect authenticator for SSO integration.
OpenID Connect credential implementation.
OpenID Connect user implementation.
Utility class for Optional operations.
Single source of truth for origin canonicalization used by the v2 CSRF Origin
check.
Baseline same-origin / allow-listed-origin decision for the v2 CSRF Origin
check.
OSDD (OpenSearch Description Document) action.
Helper class for Open Search Description Document.
Utility class for parameter operations.
Parameter map that converts between camelCase and snake_case.
Handles
POST /api/v2/auth/password.Form for password change.
Facade for password hashing and verification.
Internal encoder abstraction.
Pager for path mapping.
Helper class for path mapping configuration.
Service for path mapping operations.
Helper class for handling permission-related operations in Fess.
Bridges
LlmStreamCallback events from the LLM layer to a phase-aware
ChatPhaseCallback.Query command for phrase queries.
Response entity for ping operations.
Job for pinging search engine.
Exception for plugin-related errors.
Helper class for managing Fess plugins and artifacts.
Represents a plugin artifact with name, version, and URL information.
Enumeration of different artifact types supported by Fess.
Helper class for managing popular words and suggestions.
Handles the
/api/v2/popular-words endpoint.Query command for prefix queries.
Helper class for managing system processes in Fess.
Action for user profile operations.
Form for user profile operations.
Helper class for managing and validating URL protocols in Fess crawling system.
Creator for protected words dictionary files.
Dictionary file for protected words.
Dictionary item for protected words.
Pager for protected words dictionary management.
Service for managing protected words dictionary.
Represents a tag configuration for pruning HTML content during document processing.
Job for purging expired documents from the search index.
Job for purging old log entries from the system.
Job for purging expired thumbnail files from the system.
Job for executing Python scripts within the Fess search engine environment.
Abstract base class for query command implementations.
Functional interface for building query builders with field and boost parameters.
Functional interface for building field-specific query builders.
Context object that holds query-related information and state during search processing.
Configuration class for query field mappings in the Fess search engine.
QueryHelper is responsible for building and managing OpenSearch queries for Fess search functionality.
Exception thrown when a query parsing error occurs.
A query parser that processes search queries and converts them to Lucene Query objects.
Interface for query filters that can modify or transform queries.
Interface for the filter chain that processes queries.
Custom Lucene query parser that extends the standard QueryParser
to provide additional functionality for quoted queries.
Query processor component that handles query filters and commands.
Interface for query processing filters.
Interface for filter chains that process queries through a sequence of filters.
Interface for query rescoring implementations.
A response list that extends List functionality and includes pagination and search metadata.
A utility class for building query strings with proper escaping and parameters.
RankFusionProcessor manages multiple search engines and combines their results using rank fusion algorithms.
Wrapper class for SearchRequestParams that allows overriding specific parameters.
Abstract base class for rank fusion searchers in the Fess search system.
Filter for rate limiting to protect against bot attacks and excessive requests.
Helper class for rate limiting functionality.
Handles
GET /api/v2/related-content.Helper class for managing related content configurations.
Pager for related content management that provides pagination functionality
for displaying related content items in the admin interface.
Service class for managing related content entities.
Handles
GET /api/v2/related-queries.Helper class for managing related query configurations.
Pager class for related query management functionality.
Service class for managing related query entities.
Result of relevance evaluation for search results.
Utility class for managing render data in web responses.
Pager class for request header management in the Fess search engine.
Service class for managing request headers used in web crawling configurations.
Entity class representing a request parameter with a name and associated values.
Utility class for accessing various resource paths and files in the Fess application.
This exception is thrown when the requested result offset exceeds the limit.
Pager for role management.
This class returns a list of a role from a request parameter,
a request header and a cookie.
Service class for managing roles.
Pager for role type management.
Service class for managing role types.
The action for the root of the application.
S3-compatible storage client implementation using AWS SDK v2.
Helper class for Samba-related operations.
Authenticator for SAML 2.0.
Credential for SAML authentication.
Represents a SAML user.
This exception is thrown when a scheduled job fails.
Service class for managing scheduled jobs.
Pager for scheduler management.
This class is a base class for score boosters.
This class updates scores of documents.
Interface for script engines that can evaluate templates with parameters.
This exception is thrown when a script engine error occurs.
This class is a factory for script engines.
This class executes a script.
This job executes a script.
Handles the
/api/v2/documents/all endpoint — streaming scroll search.The action for search operations.
The render data for the search page.
Web API manager for the
/api/v2 surface.Search request body for access token administration.
Search request body for bad word administration.
Search request body for boost document administration.
Search request body for crawling information administration.
Search request body for data configuration administration.
Search request body for Kuromoji dictionary administration.
Search request body for mapping dictionary administration.
Search request body for protected words dictionary administration.
Search request body for stemmer override dictionary administration.
Search request body for stop words dictionary administration.
Search request body for synonym dictionary administration.
Search request body for duplicate host administration.
Search request body for elevate word administration.
Search request body for failure URL administration API.
Search request body for file authentication administration API.
Search request body for file crawling configuration administration API.
Search request body for group administration API.
Search request body for job log administration API.
Search request body for key match administration API.
Search request body for label type administration API.
Search request body for path mapping administration API.
Search request body for related content administration API.
Search request body for related query administration API.
Search request body for request header administration API.
Search request body for role administration API.
Search request body for scheduler administration API.
Search request body for search list administration API.
Search request body for user administration API.
Search request body for web authentication administration API.
Search request body for web crawling configuration administration API.
API manager for search engine administrative operations.
Client for interacting with OpenSearch search engine.
Interface for creating entities from search response hits.
Interface for defining search condition logic.
Builder class for constructing search conditions and parameters.
Interface for building search results from response data.
Exception thrown when search engine client operations fail.
Utility class for search engine operations and content formatting.
Functional interface for building XContent with custom logic.
The search form for Access Token.
The search form for Bad Word.
The search form for Boost Document.
The search form for Crawling Info.
The search form for Data Config.
The search form for Kuromoji.
The search form for Mapping.
The search form for Protected Words.
The search form for Stemmer Override.
The search form for Stopwords.
The search form for Synonym.
The search form for Duplicate Host.
The search form for Elevate Word.
The search form for Failure URL.
The search form for File Authentication.
The search form for File Config.
The search form for Group.
The search form for Job Log.
The search form for Key Match.
The search form for Label Type.
The search form for Path Map.
The search form for Related Content.
The search form for Related Query.
The search form for Request Header.
The search form for Role.
The search form for Scheduler.
The search form for Search Log.
The search form for User.
The search form for Web Authentication.
The search form for Web Config.
Base search form class that extends SearchRequestParams.
Handles the
/api/v2/search endpoint.Helper class for handling search operations in Fess.
Interface for rewriting search request parameters.
Interface for search log events in the Fess search system.
Helper class for managing search logs.
Holds resolved dependencies for search log creation, decoupled from ComponentUtil.
Pager class for search log pagination and filtering.
Service class for managing search logs and related analytics.
Exception thrown when there are issues with search query processing.
Data container for search results rendering.
The search request parameters.
The search request type.
Represents the result of a search operation in the rank fusion system.
Java 5 annotation for describing service layer security attributes.
Runtime exception wrapper for ServletException.
Helper that issues, verifies, and rotates per-session CSRF tokens.
SPNEGO (Security Provider Negotiation Protocol) authenticator implementation.
SPNEGO filter configuration implementation.
SPNEGO authentication credential implementation.
Common helper for Server-Sent Events (SSE) response headers.
SSO (Single Sign-On) action controller.
Interface for SSO (Single Sign-On) authenticator implementations.
Exception thrown when SSO (Single Sign-On) login operations fail.
Manager class for coordinating SSO (Single Sign-On) authentication operations.
Exception thrown during SSO (Single Sign-On) processing with message code support.
Exception thrown during SSO (Single Sign-On) processing operations.
Represents the type of SSO (Single Sign-On) response being requested.
Form class for starting crawling operations in the admin wizard.
Servlet filter that serves a static theme's files directly when a static theme is
active for the current virtual host.
Installs static themes from uploaded ZIP archives.
Raised on any failure during ZIP validation or extraction.
Structured error codes for callers that need to dispatch on the cause.
Serves the HTML entry file and asset files of a resolved static theme directly to the
servlet response.
A dictionary creator for stemmer override files.
Manages a dictionary file for stemmer overrides.
Represents an item in a stemmer override dictionary.
Pager class for stemmer override dictionary management.
Service class for managing stemmer override dictionary operations.
A dictionary creator for stopwords files.
Manages a dictionary file for stopwords.
Represents an item in a stopwords dictionary.
Pager for managing stopwords pagination.
Service for managing stopwords.
Interface for cloud storage operations.
Factory for creating appropriate StorageClient based on configuration.
This exception is thrown when a storage-related error occurs.
Represents a storage item (file or directory).
Enum for supported storage types.
A query builder for a stored LTR (Learning to Rank) query.
Represents the request body for suggest API operations.
This class is a command-line application for creating and managing the suggest index.
A nested class for parsing command-line options.
This class is a form for suggest settings.
Helper class for managing the suggest feature.
This job is responsible for executing the suggest creator process.
Handles the
/api/v2/suggest-words endpoint.This class is a valve to suppress error reports.
A dictionary creator for synonym files.
Manages a dictionary file for synonyms.
Represents an item in a synonym dictionary.
Pager for managing synonym pagination.
Service for managing synonyms.
Helper class for system-level operations and utilities.
This class is a timer target for monitoring system-level statistics.
This class provides system-related utility methods.
Form class for handling tag operations in storage management.
Builds the canonical self-origin set (
trustedSameOrigins) for the v2
CSRF Origin check.Command class for handling term query execution and conversion.
Command class for handling term range query execution and conversion.
Immutable value object describing a registered static theme.
Form posted from the delete-confirm modal.
Form for the details inspector.
Exception thrown when theme-related operations fail.
Helper class for managing theme installation and uninstallation.
Form for the theme list page.
Parsed representation of a static theme's
theme.yml manifest.Thrown when theme.yml fails parsing or validation.
Structured error codes for theme.yml failures.
Registry of static themes available to the running Fess instance.
Multipart form for the theme upload page.
Utility class for generating and writing thread dumps.
Action class for handling thumbnail image requests.
Form class for thumbnail request parameters.
Exception thrown when thumbnail generation fails.
Executable class for generating thumbnails for indexed documents.
Interface for thumbnail generation implementations.
Command-line options for the thumbnail generator.
Manager class for handling thumbnail generation and management.
File visitor for purging old thumbnail files.
Handles
GET /api/v2/ui/config.Exception thrown when an unsupported search operation is requested.
Job class for updating label information in the search index.
Form class for backup file upload.
Form for uploading bad word files to the Fess search engine.
Form for uploading design files to customize the appearance of the Fess search interface.
Form for uploading Kuromoji dictionary files to the Fess search engine.
Form for uploading character mapping files to the Fess search engine.
Form for uploading protected words files to the Fess search engine.
Form for uploading stemmer override files to the Fess search engine.
Form for uploading stopwords files to the Fess search engine.
Form for uploading synonym files to the Fess search engine.
Form for uploading elevate word files to the Fess search engine.
Form for uploading search request files to the Fess search engine.
Form for uploading files to the storage system via the admin API.
Validation annotation for URI type constraints.
Validator implementation for URI type constraints.
Enumeration of supported protocol types for URI validation.
Helper class for detecting and categorizing user agent types from HTTP requests.
Enumeration of supported browser types for user agent detection.
Helper class for managing user information and session tracking in Fess search system.
Service class for managing user information data.
Pager class for handling user list pagination.
Shared helper that produces the canonical v2 user JSON shape.
Exception thrown when user role authentication fails during login attempts.
Service class for managing user operations in the Fess search system.
Writes the unified
/api/v2 response envelope.Canonical error codes for the /api/v2 response envelope.
Reads a JSON-encoded request body into a Map and returns it.
Thrown when the request body is not parseable as JSON.
Thrown when the request body exceeds the configured maximum byte size.
Thrown when the request
Content-Type is not application/json.Search request parameters for the
/api/v2 surface.Thrown by
V2JsonRequestParams.getOffset() or V2JsonRequestParams.getStartPosition() when the
offset / start parameter is present but negative.Stateless helpers that enforce length/item-count bounds on v2 request
parameters, throwing
InvalidRequestParameterException on violation.Helper class for handling view-related operations in the Fess search system.
Hook class for customizing action processing.
Represents a text fragment for URL-based text highlighting.
Helper class for managing virtual host configurations and routing.
Exception thrown when web API operations encounter errors.
Servlet filter for processing web API requests.
Interface for managing web API request processing.
Factory class for managing and retrieving web API managers.
Wrapper for HTTP servlet requests in web API context.
Wrapper for HTTP servlet responses in web API context.
Utility class for web API operations.
Service class for managing web authentication configurations.
Pager class for web authentication configurations.
Pager class for web configuration settings.
Service class for managing web crawling configurations.
Helper class for web and file system crawling and indexing operations.
Query command for handling wildcard queries.