Package org.codelibs.fess.app.service

Class WebConfigService

java.lang.Object
org.codelibs.fess.app.service.FessAppService
org.codelibs.fess.app.service.WebConfigService
public class WebConfigService extends FessAppService
Service class for managing web crawling configurations. Provides CRUD operations for web configuration settings including listing, retrieving, storing, and deleting web crawling configurations.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.codelibs.fess.mylasta.direction.FessConfig
    fessConfig
    Fess configuration settings.
    protected org.codelibs.fess.opensearch.config.exbhv.RequestHeaderBhv
    requestHeaderBhv
    Behavior class for request header operations.
    protected org.codelibs.fess.opensearch.config.exbhv.WebAuthenticationBhv
    webAuthenticationBhv
    Behavior class for web authentication operations.
    protected org.codelibs.fess.opensearch.config.exbhv.WebConfigBhv
    webConfigBhv
    Behavior class for web configuration operations.

  • Constructor Summary

    Constructors
    Constructor
    Description
    WebConfigService()
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete(org.codelibs.fess.opensearch.config.exentity.WebConfig webConfig)
    Deletes a web configuration and all its related data.
    org.dbflute.optional.OptionalEntity<org.codelibs.fess.opensearch.config.exentity.WebConfig>
    getWebConfig(String id)
    Gets a web configuration by its ID.
    org.dbflute.optional.OptionalEntity<org.codelibs.fess.opensearch.config.exentity.WebConfig>
    getWebConfigByName(String name)
    Gets a web configuration by its name.
    List<org.codelibs.fess.opensearch.config.exentity.WebConfig>
    getWebConfigList(WebConfigPager webConfigPager)
    Gets a paginated list of web configurations based on the provided pager.
    protected void
    setupListCondition(org.codelibs.fess.opensearch.config.cbean.WebConfigCB cb, WebConfigPager webConfigPager)
    Sets up the list condition for querying web configurations.
    void
    store(org.codelibs.fess.opensearch.config.exentity.WebConfig webConfig)
    Stores a web configuration.

    Methods inherited from class org.codelibs.fess.app.service.FessAppService

    wrapQuery

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • webConfigBhv

      protected org.codelibs.fess.opensearch.config.exbhv.WebConfigBhv webConfigBhv
      Behavior class for web configuration operations.

    • webAuthenticationBhv

      protected org.codelibs.fess.opensearch.config.exbhv.WebAuthenticationBhv webAuthenticationBhv
      Behavior class for web authentication operations.

    • requestHeaderBhv

      protected org.codelibs.fess.opensearch.config.exbhv.RequestHeaderBhv requestHeaderBhv
      Behavior class for request header operations.

    • fessConfig

      protected org.codelibs.fess.mylasta.direction.FessConfig fessConfig
      Fess configuration settings.

  • Constructor Details

    • WebConfigService

      public WebConfigService()
      Default constructor.

  • Method Details

    • getWebConfigList

      public List<org.codelibs.fess.opensearch.config.exentity.WebConfig> getWebConfigList(WebConfigPager webConfigPager)
      Gets a paginated list of web configurations based on the provided pager.
      Parameters:
      webConfigPager - The pager containing pagination and search criteria
      Returns:
      List of web configuration objects

    • delete

      public void delete(org.codelibs.fess.opensearch.config.exentity.WebConfig webConfig)
      Deletes a web configuration and all its related data. This includes removing associated web authentications and request headers.
      Parameters:
      webConfig - The web configuration to delete

    • getWebConfig

      public org.dbflute.optional.OptionalEntity<org.codelibs.fess.opensearch.config.exentity.WebConfig> getWebConfig(String id)
      Gets a web configuration by its ID.
      Parameters:
      id - The ID of the web configuration
      Returns:
      Optional containing the web configuration if found

    • getWebConfigByName

      public org.dbflute.optional.OptionalEntity<org.codelibs.fess.opensearch.config.exentity.WebConfig> getWebConfigByName(String name)
      Gets a web configuration by its name. If multiple configurations have the same name, returns the first one ordered by sort order.
      Parameters:
      name - The name of the web configuration
      Returns:
      Optional containing the web configuration if found

    • store

      public void store(org.codelibs.fess.opensearch.config.exentity.WebConfig webConfig)
      Stores a web configuration. Configuration parameters are encrypted before storage.
      Parameters:
      webConfig - The web configuration to store

    • setupListCondition

      protected void setupListCondition(org.codelibs.fess.opensearch.config.cbean.WebConfigCB cb, WebConfigPager webConfigPager)
      Sets up the list condition for querying web configurations. Applies search filters based on pager criteria such as name, URLs, and description.
      Parameters:
      cb - The condition bean for the query
      webConfigPager - The pager containing search criteria