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

Class AdminUserAction

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.user.AdminUserAction
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 AdminUserAction extends FessAdminAction
Admin action for User management.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ROLE
    Role name for admin user 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
    AdminUserAction()
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    addPasswordValidationError(org.codelibs.fess.mylasta.action.FessMessages messages, String errorKey)
    Adds a password validation error message to the messages object based on the error key.
    org.lastaflute.web.response.HtmlResponse
    create(CreateForm form)
    Creates a new user.
    protected Map<String,String>
    createItem(String label, String value)
    Creates a label/value map item for dropdowns or list displays.
    org.lastaflute.web.response.HtmlResponse
    createnew()
    Displays the form for creating a new user.
    org.lastaflute.web.response.HtmlResponse
    delete(EditForm form)
    Deletes a user.
    org.lastaflute.web.response.HtmlResponse
    details(int crudMode, String id)
    Displays the details of a user.
    org.lastaflute.web.response.HtmlResponse
    edit(EditForm form)
    Displays the form for editing an existing user.
    protected String
    getActionRole()
    Get the action role.
    static org.dbflute.optional.OptionalEntity<org.codelibs.fess.opensearch.user.exentity.User>
    getUser(CreateForm form)
    Returns the user entity based on the provided form data, applying any necessary transformations.
    org.lastaflute.web.response.HtmlResponse
    index()
    Displays the user management index page.
    org.lastaflute.web.response.HtmlResponse
    list(org.dbflute.optional.OptionalThing<Integer> pageNumber, SearchForm form)
    Displays a paginated list of users.
    org.lastaflute.web.response.HtmlResponse
    reset(SearchForm form)
    Resets the search criteria and displays all users.
    static void
    resetPassword(CreateForm form)
    Resets the password and confirmation fields in the user form.
    org.lastaflute.web.response.HtmlResponse
    search(SearchForm form)
    Searches for users based on the provided search criteria.
    protected void
    searchPaging(org.lastaflute.web.response.render.RenderData data, SearchForm form)
    Registers pagination and user list data for rendering the user 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 user.
    static void
    validateAttributes(Map<String,String> attributes, Consumer<org.lastaflute.web.validation.VaMessenger<org.codelibs.fess.mylasta.action.FessMessages>> throwError)
    Validates LDAP user attribute types using the configured LDAP manager.
    protected void
    verifyPassword(CreateForm form, org.lastaflute.web.validation.VaErrorHook validationErrorLambda)
    Validates the password and confirmation fields in the form for user creation and update.

    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

    • AdminUserAction

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

    • list

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

    • search

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

    • reset

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

    • searchPaging

      protected void searchPaging(org.lastaflute.web.response.render.RenderData data, SearchForm form)
      Registers pagination and user list data for rendering the user search results.
      Parameters:
      data - the render data container to populate
      form - the search form containing pagination parameters

    • createnew

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

    • edit

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

    • details

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

    • create

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

    • update

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

    • delete

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

    • getUser

      public static org.dbflute.optional.OptionalEntity<org.codelibs.fess.opensearch.user.exentity.User> getUser(CreateForm form)
      Returns the user entity based on the provided form data, applying any necessary transformations.
      Parameters:
      form - the form containing user data for retrieval and update
      Returns:
      optional user entity populated from the form

    • createItem

      protected Map<String,String> createItem(String label, String value)
      Creates a label/value map item for dropdowns or list displays.
      Parameters:
      label - the display label for the item
      value - the value associated with the item
      Returns:
      a map containing the label and value entries

    • verifyPassword

      protected void verifyPassword(CreateForm form, org.lastaflute.web.validation.VaErrorHook validationErrorLambda)
      Validates the password and confirmation fields in the form for user creation and update.
      Parameters:
      form - the form containing password and confirmation fields
      validationErrorLambda - callback to report validation errors

    • addPasswordValidationError

      protected void addPasswordValidationError(org.codelibs.fess.mylasta.action.FessMessages messages, String errorKey)
      Adds a password validation error message to the messages object based on the error key.
      Parameters:
      messages - the FessMessages object to add the error to
      errorKey - the error key identifying the type of password validation error

    • resetPassword

      public static void resetPassword(CreateForm form)
      Resets the password and confirmation fields in the user form.
      Parameters:
      form - the form whose password fields should be reset

    • validateAttributes

      public static void validateAttributes(Map<String,String> attributes, Consumer<org.lastaflute.web.validation.VaMessenger<org.codelibs.fess.mylasta.action.FessMessages>> throwError)
      Validates LDAP user attribute types using the configured LDAP manager.
      Parameters:
      attributes - the map of attributes to validate
      throwError - callback to report any validation errors