Class RequestHeaderService

java.lang.Object
org.codelibs.fess.app.service.RequestHeaderService

public class RequestHeaderService extends Object
Service class for managing request headers used in web crawling configurations. This service provides CRUD operations for request headers that are applied during web crawling to configure HTTP request behavior.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.codelibs.fess.mylasta.direction.FessConfig
    Fess configuration settings.
    protected org.codelibs.fess.opensearch.config.exbhv.RequestHeaderBhv
    Behavior for request header database operations.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Default constructor for RequestHeaderService.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete(org.codelibs.fess.opensearch.config.exentity.RequestHeader requestHeader)
    Deletes a request header configuration from the database.
    org.dbflute.optional.OptionalEntity<org.codelibs.fess.opensearch.config.exentity.RequestHeader>
    Retrieves a specific request header by its ID.
    List<org.codelibs.fess.opensearch.config.exentity.RequestHeader>
    Retrieves all request headers associated with a specific web configuration.
    List<org.codelibs.fess.opensearch.config.exentity.RequestHeader>
    Retrieves a paginated list of request headers based on the provided pager criteria.
    protected void
    setupListCondition(org.codelibs.fess.opensearch.config.cbean.RequestHeaderCB cb, ReqHeaderPager requestHeaderPager)
    Sets up the database query conditions for retrieving request headers based on pager criteria.
    void
    store(org.codelibs.fess.opensearch.config.exentity.RequestHeader requestHeader)
    Stores a request header configuration to the database.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • requestHeaderBhv

      protected org.codelibs.fess.opensearch.config.exbhv.RequestHeaderBhv requestHeaderBhv
      Behavior for request header database operations.
    • fessConfig

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

    • RequestHeaderService

      public RequestHeaderService()
      Default constructor for RequestHeaderService. Initializes the service with dependency injection.
  • Method Details

    • getRequestHeaderList

      public List<org.codelibs.fess.opensearch.config.exentity.RequestHeader> getRequestHeaderList(ReqHeaderPager requestHeaderPager)
      Retrieves a paginated list of request headers based on the provided pager criteria.
      Parameters:
      requestHeaderPager - the pager containing pagination and search criteria
      Returns:
      a list of request headers matching the specified criteria
    • getRequestHeader

      public org.dbflute.optional.OptionalEntity<org.codelibs.fess.opensearch.config.exentity.RequestHeader> getRequestHeader(String id)
      Retrieves a specific request header by its ID.
      Parameters:
      id - the unique identifier of the request header
      Returns:
      an OptionalEntity containing the request header if found, empty otherwise
    • store

      public void store(org.codelibs.fess.opensearch.config.exentity.RequestHeader requestHeader)
      Stores a request header configuration to the database. This method performs either insert or update based on whether the request header already exists.
      Parameters:
      requestHeader - the request header configuration to store
    • delete

      public void delete(org.codelibs.fess.opensearch.config.exentity.RequestHeader requestHeader)
      Deletes a request header configuration from the database.
      Parameters:
      requestHeader - the request header configuration to delete
    • setupListCondition

      protected void setupListCondition(org.codelibs.fess.opensearch.config.cbean.RequestHeaderCB cb, ReqHeaderPager requestHeaderPager)
      Sets up the database query conditions for retrieving request headers based on pager criteria.
      Parameters:
      cb - the condition bean for building the database query
      requestHeaderPager - the pager containing search and filter criteria
    • getRequestHeaderList

      public List<org.codelibs.fess.opensearch.config.exentity.RequestHeader> getRequestHeaderList(String webConfigId)
      Retrieves all request headers associated with a specific web configuration.
      Parameters:
      webConfigId - the unique identifier of the web configuration
      Returns:
      a list of request headers associated with the specified web configuration