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

Class AdminWebconfigAction

java.lang.Object
org.lastaflute.web.LastaAction
org.lastaflute.web.TypicalAction
org.codelibs.fess.app.web.base.FessBaseAction
org.codelibs.fess.app.web.base.FessAdminAction
org.codelibs.fess.app.web.admin.webconfig.AdminWebconfigAction
All Implemented Interfaces:
org.codelibs.fess.mylasta.action.FessHtmlPath, org.lastaflute.web.docs.LaActionDocs, org.lastaflute.web.hook.ActionHook, org.lastaflute.web.validation.LaValidatable<org.codelibs.fess.mylasta.action.FessMessages>
public class AdminWebconfigAction extends FessAdminAction
Admin action for Web Config management.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ROLE
    Role name for admin web config operations

    Fields inherited from class org.codelibs.fess.app.web.base.FessAdminAction

    crawlingConfigHelper, VIEW

    Fields inherited from class org.codelibs.fess.app.web.base.FessBaseAction

    accessTokenHelper, activityHelper, APP_TYPE, fessConfig, fessLoginAssist, requestManager, responseManager, sessionManager, systemHelper, timeManager, USER_TYPE, viewHelper

    Fields inherited from class org.lastaflute.web.TypicalAction

    GLOBAL

    Fields inherited from interface org.codelibs.fess.mylasta.action.FessHtmlPath

    path_AdminAccesstoken_AdminAccesstokenDetailsJsp, path_AdminAccesstoken_AdminAccesstokenEditJsp, path_AdminAccesstoken_AdminAccesstokenJsp, path_AdminBackup_AdminBackupJsp, path_AdminBadword_AdminBadwordDetailsJsp, path_AdminBadword_AdminBadwordDownloadJsp, path_AdminBadword_AdminBadwordEditJsp, path_AdminBadword_AdminBadwordJsp, path_AdminBadword_AdminBadwordUploadJsp, path_AdminBoostdoc_AdminBoostdocDetailsJsp, path_AdminBoostdoc_AdminBoostdocEditJsp, path_AdminBoostdoc_AdminBoostdocJsp, path_AdminCrawlinginfo_AdminCrawlinginfoDetailsJsp, path_AdminCrawlinginfo_AdminCrawlinginfoJsp, path_AdminDashboard_AdminDashboardJsp, path_AdminDataconfig_AdminDataconfigDetailsJsp, path_AdminDataconfig_AdminDataconfigEditJsp, path_AdminDataconfig_AdminDataconfigJsp, path_AdminDesign_AdminDesignEditJsp, path_AdminDesign_AdminDesignJsp, path_AdminDict_AdminDictJsp, path_AdminDictKuromoji_AdminDictKuromojiDetailsJsp, path_AdminDictKuromoji_AdminDictKuromojiDownloadJsp, path_AdminDictKuromoji_AdminDictKuromojiEditJsp, path_AdminDictKuromoji_AdminDictKuromojiJsp, path_AdminDictKuromoji_AdminDictKuromojiUploadJsp, path_AdminDictMapping_AdminDictMappingDetailsJsp, path_AdminDictMapping_AdminDictMappingDownloadJsp, path_AdminDictMapping_AdminDictMappingEditJsp, path_AdminDictMapping_AdminDictMappingJsp, path_AdminDictMapping_AdminDictMappingUploadJsp, path_AdminDictProtwords_AdminDictProtwordsDetailsJsp, path_AdminDictProtwords_AdminDictProtwordsDownloadJsp, path_AdminDictProtwords_AdminDictProtwordsEditJsp, path_AdminDictProtwords_AdminDictProtwordsJsp, path_AdminDictProtwords_AdminDictProtwordsUploadJsp, path_AdminDictStemmeroverride_AdminDictStemmeroverrideDetailsJsp, path_AdminDictStemmeroverride_AdminDictStemmeroverrideDownloadJsp, path_AdminDictStemmeroverride_AdminDictStemmeroverrideEditJsp, path_AdminDictStemmeroverride_AdminDictStemmeroverrideJsp, path_AdminDictStemmeroverride_AdminDictStemmeroverrideUploadJsp, path_AdminDictStopwords_AdminDictStopwordsDetailsJsp, path_AdminDictStopwords_AdminDictStopwordsDownloadJsp, path_AdminDictStopwords_AdminDictStopwordsEditJsp, path_AdminDictStopwords_AdminDictStopwordsJsp, path_AdminDictStopwords_AdminDictStopwordsUploadJsp, path_AdminDictSynonym_AdminDictSynonymDetailsJsp, path_AdminDictSynonym_AdminDictSynonymDownloadJsp, path_AdminDictSynonym_AdminDictSynonymEditJsp, path_AdminDictSynonym_AdminDictSynonymJsp, path_AdminDictSynonym_AdminDictSynonymUploadJsp, path_AdminDuplicatehost_AdminDuplicatehostDetailsJsp, path_AdminDuplicatehost_AdminDuplicatehostEditJsp, path_AdminDuplicatehost_AdminDuplicatehostJsp, path_AdminElevateword_AdminElevatewordDetailsJsp, path_AdminElevateword_AdminElevatewordDownloadJsp, path_AdminElevateword_AdminElevatewordEditJsp, path_AdminElevateword_AdminElevatewordJsp, path_AdminElevateword_AdminElevatewordUploadJsp, path_AdminError_AdminErrorJsp, path_AdminFailureurl_AdminFailureurlDetailsJsp, path_AdminFailureurl_AdminFailureurlJsp, path_AdminFileauth_AdminFileauthDetailsJsp, path_AdminFileauth_AdminFileauthEditJsp, path_AdminFileauth_AdminFileauthJsp, path_AdminFileconfig_AdminFileconfigDetailsJsp, path_AdminFileconfig_AdminFileconfigEditJsp, path_AdminFileconfig_AdminFileconfigJsp, path_AdminGeneral_AdminGeneralJsp, path_AdminGroup_AdminGroupDetailsJsp, path_AdminGroup_AdminGroupEditJsp, path_AdminGroup_AdminGroupJsp, path_AdminJoblog_AdminJoblogDetailsJsp, path_AdminJoblog_AdminJoblogJsp, path_AdminKeymatch_AdminKeymatchDetailsJsp, path_AdminKeymatch_AdminKeymatchEditJsp, path_AdminKeymatch_AdminKeymatchJsp, path_AdminLabeltype_AdminLabeltypeDetailsJsp, path_AdminLabeltype_AdminLabeltypeEditJsp, path_AdminLabeltype_AdminLabeltypeJsp, path_AdminLog_AdminLogJsp, path_AdminMaintenance_AdminMaintenanceJsp, path_AdminPathmap_AdminPathmapDetailsJsp, path_AdminPathmap_AdminPathmapEditJsp, path_AdminPathmap_AdminPathmapJsp, path_AdminPlugin_AdminPluginInstallpluginJsp, path_AdminPlugin_AdminPluginJsp, path_AdminRelatedcontent_AdminRelatedcontentDetailsJsp, path_AdminRelatedcontent_AdminRelatedcontentEditJsp, path_AdminRelatedcontent_AdminRelatedcontentJsp, path_AdminRelatedquery_AdminRelatedqueryDetailsJsp, path_AdminRelatedquery_AdminRelatedqueryEditJsp, path_AdminRelatedquery_AdminRelatedqueryJsp, path_AdminReqheader_AdminReqheaderDetailsJsp, path_AdminReqheader_AdminReqheaderEditJsp, path_AdminReqheader_AdminReqheaderJsp, path_AdminRole_AdminRoleDetailsJsp, path_AdminRole_AdminRoleEditJsp, path_AdminRole_AdminRoleJsp, path_AdminScheduler_AdminSchedulerDetailsJsp, path_AdminScheduler_AdminSchedulerEditJsp, path_AdminScheduler_AdminSchedulerJsp, path_AdminSearchlist_AdminSearchlistEditJsp, path_AdminSearchlist_AdminSearchlistJsp, path_AdminSearchlog_AdminSearchlogDetailsJsp, path_AdminSearchlog_AdminSearchlogJsp, path_AdminSereq_AdminSereqJsp, path_AdminStorage_AdminStorageJsp, path_AdminStorage_AdminStorageTagEditJsp, path_AdminSuggest_AdminSuggestJsp, path_AdminSysteminfo_AdminSysteminfoJsp, path_AdminTheme_AdminThemeDetailsJsp, path_AdminTheme_AdminThemeJsp, path_AdminTheme_AdminThemeUploadJsp, path_AdminUser_AdminUserDetailsJsp, path_AdminUser_AdminUserEditJsp, path_AdminUser_AdminUserJsp, path_AdminWebauth_AdminWebauthDetailsJsp, path_AdminWebauth_AdminWebauthEditJsp, path_AdminWebauth_AdminWebauthJsp, path_AdminWebconfig_AdminWebconfigDetailsJsp, path_AdminWebconfig_AdminWebconfigEditJsp, path_AdminWebconfig_AdminWebconfigJsp, path_AdminWizard_AdminWizardConfigJsp, path_AdminWizard_AdminWizardJsp, path_AdminWizard_AdminWizardStartJsp, path_AdvanceJsp, path_Chat_ChatJsp, path_Error_BadRequestJsp, path_Error_BusyJsp, path_Error_ErrorJsp, path_Error_NotFoundJsp, path_Error_RedirectJsp, path_Error_SystemJsp, path_FooterJsp, path_HeaderJsp, path_HelpJsp, path_IndexJsp, path_Login_IndexJsp, path_Login_NewpasswordJsp, path_Profile_IndexJsp, path_SearchJsp, path_SearchNoResultJsp, path_SearchOptionsJsp, path_SearchResultsJsp

  • Constructor Summary

    Constructors
    Constructor
    Description
    AdminWebconfigAction()
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.lastaflute.web.response.HtmlResponse
    create(CreateForm form)
    Creates a new web crawler configuration.
    org.lastaflute.web.response.HtmlResponse
    createnew()
    Displays the form for creating a new web crawler configuration.
    org.lastaflute.web.response.HtmlResponse
    delete(EditForm form)
    Deletes a web crawler configuration.
    org.lastaflute.web.response.HtmlResponse
    details(int crudMode, String id)
    Displays the details of a web crawler configuration.
    org.lastaflute.web.response.HtmlResponse
    duplicate(String id)
    Displays the form for duplicating an existing web crawler configuration.
    org.lastaflute.web.response.HtmlResponse
    edit(EditForm form)
    Displays the form for editing an existing web crawler configuration.
    protected String
    getActionRole()
    Get the action role.
    static org.dbflute.optional.OptionalEntity<org.codelibs.fess.opensearch.config.exentity.WebConfig>
    getEntity(CreateForm form, String username, long currentTime)
    Retrieves or creates a WebConfig entity based on the form's CRUD mode.
    static org.dbflute.optional.OptionalEntity<org.codelibs.fess.opensearch.config.exentity.WebConfig>
    getWebConfig(CreateForm form)
    Converts a form to a WebConfig entity with proper user and timestamp information.
    org.lastaflute.web.response.HtmlResponse
    index(SearchForm form)
    Displays the web config management index page.
    org.lastaflute.web.response.HtmlResponse
    list(org.dbflute.optional.OptionalThing<Integer> pageNumber, SearchForm form)
    Displays a paginated list of web crawler configurations.
    protected void
    registerRolesAndLabels(org.lastaflute.web.response.render.RenderData data)
    Registers available roles and labels for use in web config forms.
    org.lastaflute.web.response.HtmlResponse
    reset(SearchForm form)
    Resets the search criteria and displays all web crawler configurations.
    org.lastaflute.web.response.HtmlResponse
    search(SearchForm form)
    Searches for web crawler configurations based on the provided search criteria.
    protected void
    searchPaging(org.lastaflute.web.response.render.RenderData data, SearchForm form)
    Sets up pagination data for the web config search results.
    protected void
    setupHtmlData(org.lastaflute.web.ruts.process.ActionRuntime runtime)
    Sets up HTML data for admin pages.
    org.lastaflute.web.response.HtmlResponse
    update(EditForm form)
    Updates an existing web crawler configuration.

    Methods inherited from class org.codelibs.fess.app.web.base.FessAdminAction

    document1_CallableSuperMethod, encodePermissions, getServletContext, godHandPrologue, hookBefore, hookFinally, myLoginManager, superGodHandPrologue, validateFilePath, verifyCrudMode, write

    Methods inherited from class org.codelibs.fess.app.web.base.FessBaseAction

    buildThrowableMessage, copyBeanToBean, copyBeanToNewBean, copyMapToBean, createMessages, createValidator, getUserBean, godHandEpilogue, godHandMonologue, isCheckboxEnabled, myAppType, myUserType, newAccessContextArranger, saveError, saveInfo

    Methods inherited from class org.lastaflute.web.TypicalAction

    calculateSqlExecutionCountLimit, createGodHandEpilogue, createGodHandMonologue, createGodHandPrologue, createGodHandResource, createTooManySqlOption, defineSqlExecutionCountDefaultLimit, filterApplicationExceptionMessageValues, handleApplicationException, myTokenGroupType, newEmbeddedMessageKeySupplier, newGodHandEpilogue, newGodHandMonologue, newGodHandPrologue, saveToken, throwVerifiedClientError, throwVerifiedIllegalTransition, verifyOrClientError, verifyOrIllegalTransition, verifyToken, verifyTokenKeep

    Methods inherited from class org.lastaflute.web.LastaAction

    asHtml, asJson, assertArgumentNotNull, asStream, asXml, doCreateValidator, doForward, doRedirect, forward, forwardById, forwardByParam, forwardWith, hash, moreUrl, movedPermanently, myValidationGroups, newActionValidator, newHtmlResponseAsForward, newHtmlResponseAsForward, newHtmlResponseAsRedirect, newJsonResponse, newStreamResponse, newUrlChain, newXmlResponse, params, redirect, redirectById, redirectByParam, redirectWith, toActionUrl, toActionUrl

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.lastaflute.web.docs.LaActionDocs

    document0_Action, document2_OverridableSuperMethod, document3_InjectableLastaComponent, document4_InjectableQuickComponent, document8_WordDictionary

    Methods inherited from interface org.lastaflute.web.validation.LaValidatable

    throwValidationError, throwValidationErrorApi, validate, validateApi

  • Field Details

  • Constructor Details

    • AdminWebconfigAction

      public AdminWebconfigAction()
      Default constructor.

  • Method Details

    • setupHtmlData

      protected void setupHtmlData(org.lastaflute.web.ruts.process.ActionRuntime runtime)
      Description copied from class: FessAdminAction
      Sets up HTML data for admin pages.

      This method configures common data needed for admin pages including editable flags, user roles, and forum links.

      Overrides:
      setupHtmlData in class FessAdminAction
      Parameters:
      runtime - the action runtime context

    • getActionRole

      protected String getActionRole()
      Description copied from class: FessAdminAction
      Get the action role.
      Specified by:
      getActionRole in class FessAdminAction
      Returns:
      The action role.

    • index

      @Execute @Secured({"admin-webconfig","admin-webconfig-view"}) public org.lastaflute.web.response.HtmlResponse index(SearchForm form)
      Displays the web config management index page.
      Parameters:
      form - the search form for filtering
      Returns:
      HTML response for the web config list page

    • list

      @Execute @Secured({"admin-webconfig","admin-webconfig-view"}) public org.lastaflute.web.response.HtmlResponse list(org.dbflute.optional.OptionalThing<Integer> pageNumber, SearchForm form)
      Displays a paginated list of web crawler configurations.
      Parameters:
      pageNumber - the page number to display (optional)
      form - the search form containing filter criteria
      Returns:
      HTML response with the web config list

    • search

      @Execute @Secured({"admin-webconfig","admin-webconfig-view"}) public org.lastaflute.web.response.HtmlResponse search(SearchForm form)
      Searches for web crawler configurations based on the provided search criteria.
      Parameters:
      form - the search form containing search criteria
      Returns:
      HTML response with filtered web config results

    • reset

      @Execute @Secured({"admin-webconfig","admin-webconfig-view"}) public org.lastaflute.web.response.HtmlResponse reset(SearchForm form)
      Resets the search criteria and displays all web crawler configurations.
      Parameters:
      form - the search form to reset
      Returns:
      HTML response with the reset web config list

    • searchPaging

      protected void searchPaging(org.lastaflute.web.response.render.RenderData data, SearchForm form)
      Sets up pagination data for the web config search results. Registers web config items and restores search criteria from the pager.
      Parameters:
      data - the render data to populate with search results
      form - the search form containing filter criteria

    • createnew

      @Execute @Secured("admin-webconfig") public org.lastaflute.web.response.HtmlResponse createnew()
      Displays the form for creating a new web crawler configuration.
      Returns:
      HTML response for the web config creation form

    • duplicate

      @Execute @Secured("admin-webconfig") public org.lastaflute.web.response.HtmlResponse duplicate(String id)
      Displays the form for duplicating an existing web crawler configuration.
      Parameters:
      id - the ID of the web config to duplicate
      Returns:
      HTML response for the web config creation form pre-populated with duplicated values

    • edit

      @Execute @Secured("admin-webconfig") public org.lastaflute.web.response.HtmlResponse edit(EditForm form)
      Displays the form for editing an existing web crawler configuration.
      Parameters:
      form - the edit form containing web config ID
      Returns:
      HTML response for the web config edit form

    • details

      @Execute @Secured({"admin-webconfig","admin-webconfig-view"}) public org.lastaflute.web.response.HtmlResponse details(int crudMode, String id)
      Displays the details of a web crawler configuration.
      Parameters:
      crudMode - the CRUD mode for the operation
      id - the ID of the web config to display
      Returns:
      HTML response for the web config details page

    • create

      @Execute @Secured("admin-webconfig") public org.lastaflute.web.response.HtmlResponse create(CreateForm form)
      Creates a new web crawler configuration.
      Parameters:
      form - the create form containing the new web config data
      Returns:
      HTML response redirecting to the list page after creation

    • update

      @Execute @Secured("admin-webconfig") public org.lastaflute.web.response.HtmlResponse update(EditForm form)
      Updates an existing web crawler configuration.
      Parameters:
      form - the edit form containing the updated web config data
      Returns:
      HTML response redirecting to the list page after update

    • delete

      @Execute @Secured("admin-webconfig") public org.lastaflute.web.response.HtmlResponse delete(EditForm form)
      Deletes a web crawler configuration.
      Parameters:
      form - the edit form containing the ID of the web config to delete
      Returns:
      HTML response redirecting to the list page after deletion

    • getEntity

      public static org.dbflute.optional.OptionalEntity<org.codelibs.fess.opensearch.config.exentity.WebConfig> getEntity(CreateForm form, String username, long currentTime)
      Retrieves or creates a WebConfig entity based on the form's CRUD mode.
      Parameters:
      form - the form containing the web config data
      username - the username of the current user
      currentTime - the current timestamp
      Returns:
      an optional WebConfig entity

    • getWebConfig

      public static org.dbflute.optional.OptionalEntity<org.codelibs.fess.opensearch.config.exentity.WebConfig> getWebConfig(CreateForm form)
      Converts a form to a WebConfig entity with proper user and timestamp information. Also processes permissions and virtual hosts from form fields.
      Parameters:
      form - the form containing the web config data
      Returns:
      an optional WebConfig entity with updated metadata

    • registerRolesAndLabels

      protected void registerRolesAndLabels(org.lastaflute.web.response.render.RenderData data)
      Registers available roles and labels for use in web config forms. Includes role types, label types, and label setting configuration.
      Parameters:
      data - the render data to register the roles and labels with