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

Class AdminWizardAction

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.wizard.AdminWizardAction
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 AdminWizardAction extends FessAdminAction
Admin action for configuration wizard.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected FileConfigService
    fileConfigService
    Service for managing file crawler configurations
    protected ProcessHelper
    processHelper
    Helper for managing crawler processes
    static final String
    ROLE
    Role name for admin wizard operations
    protected ScheduledJobService
    scheduledJobService
    Service for managing scheduled jobs
    protected org.codelibs.core.misc.DynamicProperties
    systemProperties
    System properties for configuration management
    protected WebConfigService
    webConfigService
    Service for managing web crawler configurations

    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
    AdminWizardAction()
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected String
    convertCrawlingPath(String path)
    Converts a crawling path to the appropriate protocol format.
    org.lastaflute.web.response.HtmlResponse
    crawlingConfig(CrawlingConfigForm form)
    Creates a crawling configuration and returns to the config form.
    org.lastaflute.web.response.HtmlResponse
    crawlingConfigForm()
    Displays the crawling configuration form.
    protected String
    crawlingConfigInternal(CrawlingConfigForm form)
    Internal method to create crawling configuration based on form data.
    org.lastaflute.web.response.HtmlResponse
    crawlingConfigNext(CrawlingConfigForm form)
    Creates a crawling configuration and proceeds to the start crawling form.
    protected String
    getActionRole()
    Get the action role.
    protected Integer
    getDefaultInteger(String key, Integer defaultValue)
    Retrieves an integer value from system properties with a default fallback.
    protected Long
    getDefaultLong(String key, Long defaultValue)
    Retrieves a long value from system properties with a default fallback.
    protected String
    getDefaultString(String key, String defaultValue)
    Retrieves a string value from system properties with a default fallback.
    org.lastaflute.web.response.HtmlResponse
    index()
    Displays the wizard index page.
    protected boolean
    isWebCrawlingPath(String path)
    Determines if the given path represents a web crawling target.
    protected void
    setupHtmlData(org.lastaflute.web.ruts.process.ActionRuntime runtime)
    Sets up HTML data for admin pages.
    org.lastaflute.web.response.HtmlResponse
    startCrawling(StartCrawlingForm form)
    Starts the crawling process for all configured crawlers.
    org.lastaflute.web.response.HtmlResponse
    startCrawlingForm()
    Displays the start crawling form.

    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

    • ROLE

      public static final String ROLE
      Role name for admin wizard operations
      See Also:

    • systemProperties

      protected org.codelibs.core.misc.DynamicProperties systemProperties
      System properties for configuration management

    • webConfigService

      protected WebConfigService webConfigService
      Service for managing web crawler configurations

    • fileConfigService

      protected FileConfigService fileConfigService
      Service for managing file crawler configurations

    • processHelper

      protected ProcessHelper processHelper
      Helper for managing crawler processes

    • scheduledJobService

      protected ScheduledJobService scheduledJobService
      Service for managing scheduled jobs

  • Constructor Details

    • AdminWizardAction

      public AdminWizardAction()
      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-wizard","admin-wizard-view"}) public org.lastaflute.web.response.HtmlResponse index()
      Displays the wizard index page.
      Returns:
      HTML response for the wizard main page

    • crawlingConfigForm

      @Execute @Secured("admin-wizard") public org.lastaflute.web.response.HtmlResponse crawlingConfigForm()
      Displays the crawling configuration form.
      Returns:
      HTML response for the crawling config form

    • crawlingConfig

      @Execute @Secured("admin-wizard") public org.lastaflute.web.response.HtmlResponse crawlingConfig(CrawlingConfigForm form)
      Creates a crawling configuration and returns to the config form.
      Parameters:
      form - the form containing crawling configuration data
      Returns:
      HTML response redirecting to the config form

    • crawlingConfigNext

      @Execute @Secured("admin-wizard") public org.lastaflute.web.response.HtmlResponse crawlingConfigNext(CrawlingConfigForm form)
      Creates a crawling configuration and proceeds to the start crawling form.
      Parameters:
      form - the form containing crawling configuration data
      Returns:
      HTML response redirecting to the start crawling form

    • crawlingConfigInternal

      protected String crawlingConfigInternal(CrawlingConfigForm form)
      Internal method to create crawling configuration based on form data. Determines whether to create a web or file crawler configuration.
      Parameters:
      form - the form containing crawling configuration data
      Returns:
      the name of the created configuration

    • getDefaultInteger

      protected Integer getDefaultInteger(String key, Integer defaultValue)
      Retrieves an integer value from system properties with a default fallback.
      Parameters:
      key - the property key to look up
      defaultValue - the default value if the property is not found or invalid
      Returns:
      the integer value or default value

    • getDefaultLong

      protected Long getDefaultLong(String key, Long defaultValue)
      Retrieves a long value from system properties with a default fallback.
      Parameters:
      key - the property key to look up
      defaultValue - the default value if the property is not found or invalid
      Returns:
      the long value or default value

    • getDefaultString

      protected String getDefaultString(String key, String defaultValue)
      Retrieves a string value from system properties with a default fallback.
      Parameters:
      key - the property key to look up
      defaultValue - the default value if the property is not found
      Returns:
      the string value or default value

    • isWebCrawlingPath

      protected boolean isWebCrawlingPath(String path)
      Determines if the given path represents a web crawling target. Checks if the path starts with HTTP or HTTPS protocols.
      Parameters:
      path - the path to check
      Returns:
      true if the path is a web crawling path, false otherwise

    • convertCrawlingPath

      protected String convertCrawlingPath(String path)
      Converts a crawling path to the appropriate protocol format. Handles various path formats and adds proper protocol prefixes.
      Parameters:
      path - the original path to convert
      Returns:
      the converted path with appropriate protocol prefix

    • startCrawlingForm

      @Execute @Secured("admin-wizard") public org.lastaflute.web.response.HtmlResponse startCrawlingForm()
      Displays the start crawling form.
      Returns:
      HTML response for the start crawling form

    • startCrawling

      @Execute @Secured("admin-wizard") public org.lastaflute.web.response.HtmlResponse startCrawling(StartCrawlingForm form)
      Starts the crawling process for all configured crawlers.
      Parameters:
      form - the start crawling form
      Returns:
      HTML response redirecting to the wizard index