Package org.codelibs.fess.app.service

Class FileAuthenticationService

java.lang.Object
org.codelibs.fess.app.service.FileAuthenticationService
public class FileAuthenticationService extends Object
Service class for managing file authentication configurations. This service provides operations for retrieving, storing, and deleting file authentication settings used by the Fess search engine.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.codelibs.fess.mylasta.direction.FessConfig
    fessConfig
    Configuration settings for the Fess application.
    protected org.codelibs.fess.opensearch.config.exbhv.FileAuthenticationBhv
    fileAuthenticationBhv
    Behavior class for file authentication database operations.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FileAuthenticationService()
    Default constructor for file authentication service.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete(org.codelibs.fess.opensearch.config.exentity.FileAuthentication fileAuthentication)
    Deletes a file authentication configuration from the system.
    org.dbflute.optional.OptionalEntity<org.codelibs.fess.opensearch.config.exentity.FileAuthentication>
    getFileAuthentication(String id)
    Retrieves a specific file authentication configuration by its ID.
    List<org.codelibs.fess.opensearch.config.exentity.FileAuthentication>
    getFileAuthenticationList(String fileConfigId)
    Retrieves all file authentication configurations associated with a specific file configuration.
    List<org.codelibs.fess.opensearch.config.exentity.FileAuthentication>
    getFileAuthenticationList(FileAuthPager fileAuthenticationPager)
    Retrieves a paginated list of file authentication configurations.
    protected void
    setupListCondition(org.codelibs.fess.opensearch.config.cbean.FileAuthenticationCB cb, FileAuthPager fileAuthenticationPager)
    Sets up the search conditions for retrieving file authentication configurations.
    void
    store(org.codelibs.fess.opensearch.config.exentity.FileAuthentication fileAuthentication)
    Stores a file authentication configuration.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • fileAuthenticationBhv

      protected org.codelibs.fess.opensearch.config.exbhv.FileAuthenticationBhv fileAuthenticationBhv
      Behavior class for file authentication database operations.

    • fessConfig

      protected org.codelibs.fess.mylasta.direction.FessConfig fessConfig
      Configuration settings for the Fess application.

  • Constructor Details

    • FileAuthenticationService

      public FileAuthenticationService()
      Default constructor for file authentication service. Creates a new instance with default values.

  • Method Details

    • getFileAuthenticationList

      public List<org.codelibs.fess.opensearch.config.exentity.FileAuthentication> getFileAuthenticationList(FileAuthPager fileAuthenticationPager)
      Retrieves a paginated list of file authentication configurations.
      Parameters:
      fileAuthenticationPager - the pager containing pagination settings and search criteria
      Returns:
      a list of file authentication configurations for the current page

    • getFileAuthentication

      public org.dbflute.optional.OptionalEntity<org.codelibs.fess.opensearch.config.exentity.FileAuthentication> getFileAuthentication(String id)
      Retrieves a specific file authentication configuration by its ID.
      Parameters:
      id - the unique identifier of the file authentication configuration
      Returns:
      an OptionalEntity containing the file authentication if found, empty otherwise

    • store

      public void store(org.codelibs.fess.opensearch.config.exentity.FileAuthentication fileAuthentication)
      Stores a file authentication configuration. The parameters are encrypted before storage for security.
      Parameters:
      fileAuthentication - the file authentication configuration to store

    • delete

      public void delete(org.codelibs.fess.opensearch.config.exentity.FileAuthentication fileAuthentication)
      Deletes a file authentication configuration from the system.
      Parameters:
      fileAuthentication - the file authentication configuration to delete

    • setupListCondition

      protected void setupListCondition(org.codelibs.fess.opensearch.config.cbean.FileAuthenticationCB cb, FileAuthPager fileAuthenticationPager)
      Sets up the search conditions for retrieving file authentication configurations. This method configures the query conditions and ordering for the database query.
      Parameters:
      cb - the condition bean for building the query
      fileAuthenticationPager - the pager containing search criteria

    • getFileAuthenticationList

      public List<org.codelibs.fess.opensearch.config.exentity.FileAuthentication> getFileAuthenticationList(String fileConfigId)
      Retrieves all file authentication configurations associated with a specific file configuration.
      Parameters:
      fileConfigId - the ID of the file configuration to retrieve authentications for
      Returns:
      a list of file authentication configurations for the specified file configuration