Package org.codelibs.fess.app.web.admin.general

Class EditForm

java.lang.Object
org.codelibs.fess.app.web.admin.general.EditForm
Direct Known Subclasses:
EditBody
public class EditForm extends Object
Form class for editing general system settings in the admin interface. This form handles global configuration settings that affect the entire Fess system, including crawling behavior, authentication, logging, and various system parameters.

  • Field Details

    • incrementalCrawling

      @Size(max=10) public @Size(max=10) String incrementalCrawling
      Enable or disable incremental crawling. When enabled, only new or modified documents are crawled.

    • dayForCleanup

      @Required @Min(-1L) @Max(1000L) @ValidateTypeFailure public @Required @Min(-1L) @Max(1000L) Integer dayForCleanup
      Number of days to keep crawled documents before cleanup. Set to -1 to disable automatic cleanup.

    • crawlingThreadCount

      @Required @Min(0L) @Max(100L) @ValidateTypeFailure public @Required @Min(0L) @Max(100L) Integer crawlingThreadCount
      Number of threads to use for crawling operations. Higher values increase crawling speed but consume more resources.

    • searchLog

      @Size(max=10) public @Size(max=10) String searchLog
      Enable or disable search query logging. When enabled, user search queries are logged for analysis.

    • userInfo

      @Size(max=10) public @Size(max=10) String userInfo
      Enable or disable user information tracking. When enabled, user information is stored and tracked.

    • userFavorite

      @Size(max=10) public @Size(max=10) String userFavorite
      Enable or disable user favorite functionality. When enabled, users can save favorite search results.

    • webApiJson

      @Size(max=10) public @Size(max=10) String webApiJson
      Enable or disable JSON Web API. When enabled, search results can be retrieved via JSON API.

    • appValue

      @Size(max=10000) public @Size(max=10000) String appValue
      Application-specific value for custom configurations. This field can be used to store custom application settings.

    • defaultLabelValue

      @Size(max=1000) public @Size(max=1000) String defaultLabelValue
      Default label value to use when no specific label is selected. This affects which documents are included in search results by default.

    • defaultSortValue

      @Size(max=1000) public @Size(max=1000) String defaultSortValue
      Default sort order for search results. Defines how search results are ordered when no specific sort is requested.

    • virtualHostValue

      @Size(max=10000) public @Size(max=10000) String virtualHostValue
      Virtual host configuration for multi-tenant setups. Allows different search configurations based on the request host.

    • appendQueryParameter

      @Size(max=10) public @Size(max=10) String appendQueryParameter
      Enable or disable appending query parameters to search URLs. When enabled, additional parameters are added to search result URLs.

    • loginRequired

      @Size(max=10) public @Size(max=10) String loginRequired
      Enable or disable login requirement for search access. When enabled, users must authenticate before performing searches.

    • resultCollapsed

      @Size(max=10) public @Size(max=10) String resultCollapsed
      Enable or disable result collapsing for similar documents. When enabled, similar search results are grouped together.

    • thumbnail

      @Size(max=10) public @Size(max=10) String thumbnail
      Enable or disable thumbnail generation for documents. When enabled, thumbnails are generated for supported file types.

    • ignoreFailureType

      @Size(max=1000) public @Size(max=1000) String ignoreFailureType
      Types of crawling failures to ignore during crawling operations. Specified failure types will not be logged or counted as errors.

    • failureCountThreshold

      @Required @Min(-1L) @Max(10000L) @ValidateTypeFailure public @Required @Min(-1L) @Max(10000L) Integer failureCountThreshold
      Threshold for failure count before stopping crawling of a URL. Set to -1 to disable the threshold check.

    • popularWord

      @Size(max=10) public @Size(max=10) String popularWord
      Enable or disable popular word tracking and display. When enabled, frequently searched terms are tracked and displayed.

    • csvFileEncoding

      @Required @Size(max=20) public @Required @Size(max=20) String csvFileEncoding
      Character encoding to use for CSV file exports. This setting affects the encoding of downloaded CSV files.

    • purgeSearchLogDay

      @Min(-1L) @Max(100000L) @ValidateTypeFailure public @Min(-1L) @Max(100000L) Integer purgeSearchLogDay
      Number of days to keep search logs before purging. Set to -1 to disable automatic purging of search logs.

    • purgeJobLogDay

      @Min(-1L) @Max(100000L) @ValidateTypeFailure public @Min(-1L) @Max(100000L) Integer purgeJobLogDay
      Number of days to keep job logs before purging. Set to -1 to disable automatic purging of job logs.

    • purgeUserInfoDay

      @Min(-1L) @Max(100000L) @ValidateTypeFailure public @Min(-1L) @Max(100000L) Integer purgeUserInfoDay
      Number of days to keep user information before purging. Set to -1 to disable automatic purging of user information.

    • purgeByBots

      @Size(max=10000) public @Size(max=10000) String purgeByBots
      Bot user agents whose search logs should be purged. Search logs from these bots will be automatically removed.

    • notificationTo

      @Size(max=1000) public @Size(max=1000) String notificationTo
      Email addresses to receive system notifications. Multiple addresses can be specified, separated by commas.

    • suggestSearchLog

      @Size(max=10) public @Size(max=10) String suggestSearchLog
      Enable or disable search suggestions based on search logs. When enabled, suggestions are generated from previous searches.

    • suggestDocuments

      @Size(max=10) public @Size(max=10) String suggestDocuments
      Enable or disable search suggestions based on document content. When enabled, suggestions are generated from indexed documents.

    • purgeSuggestSearchLogDay

      @Min(0L) @Max(100000L) @ValidateTypeFailure public @Min(0L) @Max(100000L) Integer purgeSuggestSearchLogDay
      Number of days to keep suggestion search logs before purging. Set to 0 to disable purging of suggestion search logs.

    • ldapProviderUrl

      @Size(max=1000) public @Size(max=1000) String ldapProviderUrl
      LDAP server URL for authentication. Used when LDAP authentication is enabled.

    • ldapSecurityPrincipal

      @Size(max=1000) public @Size(max=1000) String ldapSecurityPrincipal
      LDAP security principal for binding to the LDAP server. Used for authenticating with the LDAP server.

    • ldapAdminSecurityPrincipal

      @Size(max=1000) public @Size(max=1000) String ldapAdminSecurityPrincipal
      LDAP admin security principal for administrative operations. Used for admin-level operations on the LDAP server.

    • ldapAdminSecurityCredentials

      @Size(max=1000) public @Size(max=1000) String ldapAdminSecurityCredentials
      LDAP admin security credentials (password) for administrative operations. Used in conjunction with the admin security principal.

    • ldapBaseDn

      @Size(max=1000) public @Size(max=1000) String ldapBaseDn
      LDAP base DN (Distinguished Name) for user searches. Defines the root of the LDAP directory tree for user lookups.

    • ldapAccountFilter

      @Size(max=1000) public @Size(max=1000) String ldapAccountFilter
      LDAP filter for finding user accounts. Defines the search filter used to locate user accounts in LDAP.

    • ldapGroupFilter

      @Size(max=1000) public @Size(max=1000) String ldapGroupFilter
      LDAP filter for finding groups. Defines the search filter used to locate groups in LDAP.

    • ldapMemberofAttribute

      @Size(max=100) public @Size(max=100) String ldapMemberofAttribute
      LDAP attribute name for group membership. Specifies which LDAP attribute contains group membership information.

    • notificationLogin

      @Size(max=3000) public @Size(max=3000) String notificationLogin
      Notification message displayed on the login page. This message is shown to users on the authentication page.

    • notificationSearchTop

      @Size(max=3000) public @Size(max=3000) String notificationSearchTop
      Notification message displayed on the search top page. This message is shown to users on the main search page.

    • logLevel

      @Size(max=10) public @Size(max=10) String logLevel
      System log level for controlling log verbosity. Controls the level of detail in system log messages.

    • storageEndpoint

      @Size(max=1000) public @Size(max=1000) String storageEndpoint
      Storage service endpoint URL for cloud storage integration. Used for storing files in cloud storage services like S3.

    • storageAccessKey

      @Size(max=1000) public @Size(max=1000) String storageAccessKey
      Access key for cloud storage authentication. Used to authenticate with cloud storage services.

    • storageSecretKey

      @Size(max=1000) public @Size(max=1000) String storageSecretKey
      Secret key for cloud storage authentication. Used in conjunction with the access key for cloud storage.

    • storageBucket

      @Size(max=1000) public @Size(max=1000) String storageBucket
      Storage bucket name for cloud storage operations. Specifies which bucket to use for storing files in cloud storage.

    • storageType

      @Size(max=20) public @Size(max=20) String storageType
      Storage type for cloud storage (s3, gcs, auto). Determines which storage client to use.

    • storageRegion

      @Size(max=100) public @Size(max=100) String storageRegion
      Storage region for S3. AWS region where the S3 bucket is located.

    • storageProjectId

      @Size(max=200) public @Size(max=200) String storageProjectId
      GCS project ID. Google Cloud project ID for GCS storage.

    • storageCredentialsPath

      @Size(max=1000) public @Size(max=1000) String storageCredentialsPath
      Storage credentials file path for GCS. Path to the service account credentials JSON file.

    • ragLlmName

      @Size(max=100) public @Size(max=100) String ragLlmName
      RAG LLM provider name. Selects which LLM client to use for RAG operations.

    • llmLogLevel

      @Size(max=10) public @Size(max=10) String llmLogLevel
      LLM log level. Controls the logging level for LLM-related packages.

    • searchFileProxy

      @Size(max=10) public @Size(max=10) String searchFileProxy
      Enable or disable search file proxy.

    • searchUseBrowserLocale

      @Size(max=10) public @Size(max=10) String searchUseBrowserLocale
      Enable or disable using browser locale for search.

    • ssoType

      @Size(max=100) public @Size(max=100) String ssoType
      SSO type (none, oic, saml, spnego, entraid).

    • crawlingUserAgent

      @Size(max=1000) public @Size(max=1000) String crawlingUserAgent
      User agent string for crawling operations.

    • notificationAdvanceSearch

      @Size(max=3000) public @Size(max=3000) String notificationAdvanceSearch
      Notification message displayed on the advanced search page.

    • slackWebhookUrls

      @Size(max=10000) public @Size(max=10000) String slackWebhookUrls
      Slack webhook URLs for notifications.

    • googleChatWebhookUrls

      @Size(max=10000) public @Size(max=10000) String googleChatWebhookUrls
      Google Chat webhook URLs for notifications.

    • logNotificationEnabled

      @Size(max=10) public @Size(max=10) String logNotificationEnabled
      Enable or disable log notification for ERROR/WARN logs.

    • logNotificationLevel

      @Size(max=10) public @Size(max=10) String logNotificationLevel
      Log notification level (e.g. ERROR, WARN, INFO).

    • ldapSecurityAuthentication

      @Size(max=1000) public @Size(max=1000) String ldapSecurityAuthentication
      LDAP security authentication type.

    • ldapInitialContextFactory

      @Size(max=1000) public @Size(max=1000) String ldapInitialContextFactory
      LDAP initial context factory class name.

    • oicClientId

      @Size(max=1000) public @Size(max=1000) String oicClientId
      OpenID Connect client ID.

    • oicClientSecret

      @Size(max=1000) public @Size(max=1000) String oicClientSecret
      OpenID Connect client secret.

    • oicAuthServerUrl

      @Size(max=1000) public @Size(max=1000) String oicAuthServerUrl
      OpenID Connect authorization server URL.

    • oicTokenServerUrl

      @Size(max=1000) public @Size(max=1000) String oicTokenServerUrl
      OpenID Connect token server URL.

    • oicRedirectUrl

      @Size(max=1000) public @Size(max=1000) String oicRedirectUrl
      OpenID Connect redirect URL.

    • oicScope

      @Size(max=1000) public @Size(max=1000) String oicScope
      OpenID Connect scope.

    • oicBaseUrl

      @Size(max=1000) public @Size(max=1000) String oicBaseUrl
      OpenID Connect base URL.

    • oicDefaultGroups

      @Size(max=1000) public @Size(max=1000) String oicDefaultGroups
      OpenID Connect default groups.

    • oicDefaultRoles

      @Size(max=1000) public @Size(max=1000) String oicDefaultRoles
      OpenID Connect default roles.

    • samlIdpEntityid

      @Size(max=1000) public @Size(max=1000) String samlIdpEntityid
      SAML Identity Provider Entity ID.

    • samlIdpSingleSignOnServiceUrl

      @Size(max=1000) public @Size(max=1000) String samlIdpSingleSignOnServiceUrl
      SAML Identity Provider Single Sign-On Service URL.

    • samlIdpSingleLogoutServiceUrl

      @Size(max=1000) public @Size(max=1000) String samlIdpSingleLogoutServiceUrl
      SAML Identity Provider Single Logout Service URL.

    • samlIdpX509cert

      @Size(max=10000) public @Size(max=10000) String samlIdpX509cert
      SAML Identity Provider X.509 Certificate.

    • samlSpBaseUrl

      @Size(max=1000) public @Size(max=1000) String samlSpBaseUrl
      SAML service provider base URL.

    • samlSpEntityid

      @Size(max=1000) public @Size(max=1000) String samlSpEntityid
      SAML Service Provider Entity ID.

    • samlSpAssertionConsumerServiceUrl

      @Size(max=1000) public @Size(max=1000) String samlSpAssertionConsumerServiceUrl
      SAML Assertion Consumer Service URL.

    • samlSpSingleLogoutServiceUrl

      @Size(max=1000) public @Size(max=1000) String samlSpSingleLogoutServiceUrl
      SAML Service Provider Single Logout Service URL.

    • samlSpNameidformat

      @Size(max=1000) public @Size(max=1000) String samlSpNameidformat
      SAML Service Provider NameID Format.

    • samlAttributeGroupName

      @Size(max=1000) public @Size(max=1000) String samlAttributeGroupName
      SAML attribute name for group membership.

    • samlAttributeRoleName

      @Size(max=1000) public @Size(max=1000) String samlAttributeRoleName
      SAML attribute name for role membership.

    • samlDefaultGroups

      @Size(max=1000) public @Size(max=1000) String samlDefaultGroups
      SAML default groups.

    • samlDefaultRoles

      @Size(max=1000) public @Size(max=1000) String samlDefaultRoles
      SAML default roles.

    • spnegoKrb5Conf

      @Size(max=1000) public @Size(max=1000) String spnegoKrb5Conf
      SPNEGO Kerberos 5 configuration file path.

    • spnegoLoginConf

      @Size(max=1000) public @Size(max=1000) String spnegoLoginConf
      SPNEGO JAAS login configuration file path.

    • spnegoLoginClientModule

      @Size(max=1000) public @Size(max=1000) String spnegoLoginClientModule
      SPNEGO JAAS login client module name.

    • spnegoLoginServerModule

      @Size(max=1000) public @Size(max=1000) String spnegoLoginServerModule
      SPNEGO JAAS login server module name.

    • spnegoPreauthUsername

      @Size(max=1000) public @Size(max=1000) String spnegoPreauthUsername
      SPNEGO pre-authentication username.

    • spnegoPreauthPassword

      @Size(max=1000) public @Size(max=1000) String spnegoPreauthPassword
      SPNEGO pre-authentication password.

    • spnegoAllowBasic

      @Size(max=10) public @Size(max=10) String spnegoAllowBasic
      Enable or disable SPNEGO basic authentication.

    • spnegoAllowUnsecureBasic

      @Size(max=10) public @Size(max=10) String spnegoAllowUnsecureBasic
      Enable or disable SPNEGO unsecure basic authentication.

    • spnegoPromptNtlm

      @Size(max=10) public @Size(max=10) String spnegoPromptNtlm
      Enable or disable SPNEGO NTLM prompt.

    • spnegoAllowLocalhost

      @Size(max=10) public @Size(max=10) String spnegoAllowLocalhost
      Enable or disable SPNEGO localhost authentication.

    • spnegoAllowDelegation

      @Size(max=10) public @Size(max=10) String spnegoAllowDelegation
      Enable or disable SPNEGO credential delegation.

    • spnegoLoggerLevel

      @Size(max=10) public @Size(max=10) String spnegoLoggerLevel
      SPNEGO logger level (0-7, auto-detected if empty).

    • entraidClientId

      @Size(max=1000) public @Size(max=1000) String entraidClientId
      Entra ID application client ID.

    • entraidClientSecret

      @Size(max=1000) public @Size(max=1000) String entraidClientSecret
      Entra ID application client secret.

    • entraidTenant

      @Size(max=1000) public @Size(max=1000) String entraidTenant
      Entra ID tenant ID.

    • entraidAuthority

      @Size(max=1000) public @Size(max=1000) String entraidAuthority
      Entra ID authority URL.

    • entraidReplyUrl

      @Size(max=1000) public @Size(max=1000) String entraidReplyUrl
      Entra ID OAuth2 reply URL.

    • entraidStateTtl

      @Size(max=100) public @Size(max=100) String entraidStateTtl
      Entra ID state parameter TTL in seconds.

    • entraidDefaultGroups

      @Size(max=1000) public @Size(max=1000) String entraidDefaultGroups
      Entra ID default groups.

    • entraidDefaultRoles

      @Size(max=1000) public @Size(max=1000) String entraidDefaultRoles
      Entra ID default roles.

    • entraidPermissionFields

      @Size(max=1000) public @Size(max=1000) String entraidPermissionFields
      Entra ID permission field names.

    • entraidUseDs

      @Size(max=10) public @Size(max=10) String entraidUseDs
      Enable or disable Entra ID domain services.

  • Constructor Details

    • EditForm

      public EditForm()
      Creates a new EditForm instance.