Package org.codelibs.fess.app.web.base

Class FessAdminAction

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
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>
Direct Known Subclasses:
AdminAccesstokenAction, AdminAction, AdminBackupAction, AdminBadwordAction, AdminBoostdocAction, AdminCrawlinginfoAction, AdminDashboardAction, AdminDataconfigAction, AdminDesignAction, AdminDictAction, AdminDictKuromojiAction, AdminDictMappingAction, AdminDictProtwordsAction, AdminDictStemmeroverrideAction, AdminDictStopwordsAction, AdminDictSynonymAction, AdminDuplicatehostAction, AdminElevatewordAction, AdminFailureurlAction, AdminFileauthAction, AdminFileconfigAction, AdminGeneralAction, AdminGroupAction, AdminJoblogAction, AdminKeymatchAction, AdminLabeltypeAction, AdminLogAction, AdminMaintenanceAction, AdminPathmapAction, AdminPluginAction, AdminRelatedcontentAction, AdminRelatedqueryAction, AdminReqheaderAction, AdminRoleAction, AdminSchedulerAction, AdminSearchlistAction, AdminSearchlogAction, AdminSereqAction, AdminStorageAction, AdminSuggestAction, AdminSysteminfoAction, AdminThemeAction, AdminUserAction, AdminWebauthAction, AdminWebconfigAction, AdminWizardAction
public abstract class FessAdminAction extends FessBaseAction
Base action class for admin pages in Fess.

This abstract class provides common functionality for all admin actions, including authentication, authorization, and HTML data setup.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected CrawlingConfigHelper
    crawlingConfigHelper
    Helper for crawling configuration management.
    static final String
    VIEW
    Constant suffix for view names.

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

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    document1_CallableSuperMethod()

    Application Origin Methods:
    protected static String[]
    encodePermissions(String permissionsText)
    Encodes permission strings into an array.
    protected abstract String
    getActionRole()
    Get the action role.
    protected jakarta.servlet.ServletContext
    getServletContext()
    Gets the servlet context.
    org.lastaflute.web.response.ActionResponse
    godHandPrologue(org.lastaflute.web.ruts.process.ActionRuntime runtime)
    Handles the prologue phase of action execution.
    org.lastaflute.web.response.ActionResponse
    hookBefore(org.lastaflute.web.ruts.process.ActionRuntime runtime)
    Hook method called before action execution.
    void
    hookFinally(org.lastaflute.web.ruts.process.ActionRuntime runtime)
    Hook method called after action execution completes.
    protected org.dbflute.optional.OptionalThing<org.lastaflute.web.login.LoginManager>
    myLoginManager()
    Gets the login manager for this admin action.
    protected void
    setupHtmlData(org.lastaflute.web.ruts.process.ActionRuntime runtime)
    Sets up HTML data for admin pages.
    protected org.lastaflute.web.response.ActionResponse
    superGodHandPrologue(org.lastaflute.web.ruts.process.ActionRuntime runtime)
    Calls the parent's godHandPrologue method.
    protected void
    validateFilePath(String path)
    Validates the file path.
    protected void
    verifyCrudMode(int crudMode, int expectedMode, org.lastaflute.web.validation.VaErrorHook errorHook)
    Verifies that the CRUD mode matches the expected mode.
    protected void
    write(String path, byte[] data)
    Writes data to the specified file path.

    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

    • FessAdminAction

      public FessAdminAction()
      Default constructor.

  • Method Details

    • setupHtmlData

      protected void setupHtmlData(org.lastaflute.web.ruts.process.ActionRuntime runtime)
      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 org.lastaflute.web.TypicalAction
      Parameters:
      runtime - the action runtime context

    • getActionRole

      protected abstract String getActionRole()
      Get the action role.
      Returns:
      The action role.

    • write

      protected void write(String path, byte[] data)
      Writes data to the specified file path.
      Parameters:
      path - the file path to write to
      data - the data to write

    • validateFilePath

      protected void validateFilePath(String path)
      Validates the file path.
      Parameters:
      path - the file path to validate

    • getServletContext

      protected jakarta.servlet.ServletContext getServletContext()
      Gets the servlet context.
      Returns:
      the servlet context

    • verifyCrudMode

      protected void verifyCrudMode(int crudMode, int expectedMode, org.lastaflute.web.validation.VaErrorHook errorHook)
      Verifies that the CRUD mode matches the expected mode.
      Parameters:
      crudMode - the actual CRUD mode
      expectedMode - the expected CRUD mode
      errorHook - the error hook to call if verification fails

    • encodePermissions

      protected static String[] encodePermissions(String permissionsText)
      Encodes permission strings into an array.
      Parameters:
      permissionsText - the permissions text (newline-separated)
      Returns:
      encoded permission array

    • document1_CallableSuperMethod

      public void document1_CallableSuperMethod()

      Application Origin Methods: 
       [Small Helper]
 o saveInfo() // save messages to session
 o write() // write text to specified file
 o copyBeanToBean() // copy bean to bean by BeanUtil
 o getServletContext() // get servlet context

    • myLoginManager

      protected org.dbflute.optional.OptionalThing<org.lastaflute.web.login.LoginManager> myLoginManager()
      Gets the login manager for this admin action.
      Specified by:
      myLoginManager in class org.lastaflute.web.TypicalAction
      Returns:
      the login manager wrapped in OptionalThing

    • godHandPrologue

      public org.lastaflute.web.response.ActionResponse godHandPrologue(org.lastaflute.web.ruts.process.ActionRuntime runtime)
      Handles the prologue phase of action execution.

      This method catches UserRoleLoginException and redirects to the appropriate action class.

      Specified by:
      godHandPrologue in interface org.lastaflute.web.hook.ActionHook
      Overrides:
      godHandPrologue in class FessBaseAction
      Parameters:
      runtime - the action runtime context
      Returns:
      the action response, or redirect response if login exception occurs

    • superGodHandPrologue

      protected org.lastaflute.web.response.ActionResponse superGodHandPrologue(org.lastaflute.web.ruts.process.ActionRuntime runtime)
      Calls the parent's godHandPrologue method.

      This method exists to allow subclasses or tests to override the behavior of the parent class invocation.

      Parameters:
      runtime - the action runtime context
      Returns:
      the action response from the parent

    • hookBefore

      public org.lastaflute.web.response.ActionResponse hookBefore(org.lastaflute.web.ruts.process.ActionRuntime runtime)
      Hook method called before action execution.

      This method logs user access activity for the current request.

      Specified by:
      hookBefore in interface org.lastaflute.web.hook.ActionHook
      Overrides:
      hookBefore in class FessBaseAction
      Parameters:
      runtime - the action runtime context
      Returns:
      the action response from the parent hook

    • hookFinally

      public void hookFinally(org.lastaflute.web.ruts.process.ActionRuntime runtime)
      Hook method called after action execution completes.

      This method performs cleanup operations by calling the parent hook.

      Specified by:
      hookFinally in interface org.lastaflute.web.hook.ActionHook
      Overrides:
      hookFinally in class FessBaseAction
      Parameters:
      runtime - the action runtime context