Package org.codelibs.fess.app.web.api.admin.dict.stopwords

Class ApiAdminDictStopwordsAction

java.lang.Object
org.lastaflute.web.LastaAction
org.lastaflute.web.TypicalAction
org.codelibs.fess.app.web.base.FessBaseAction
org.codelibs.fess.app.web.api.FessApiAction
org.codelibs.fess.app.web.api.admin.FessApiAdminAction
org.codelibs.fess.app.web.api.admin.dict.stopwords.ApiAdminDictStopwordsAction
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 ApiAdminDictStopwordsAction extends FessApiAdminAction
API action for admin Stopwords dictionary management. Provides REST endpoints for managing stopwords dictionary items in the Fess search engine.

  • Field Summary

    Fields inherited from class org.codelibs.fess.app.web.api.FessApiAction

    accessTokenService, messageManager, request

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

  • Method Summary

    Modifier and Type
    Method
    Description
    protected EditBody
    createEditBody(StopwordsItem entity, String dictId)
    Creates an EditBody from a StopwordsItem entity for API responses.
    org.lastaflute.web.response.JsonResponse<ApiResult>
    delete$setting(String dictId, long id)
    Deletes a stopwords dictionary item by ID.
    org.lastaflute.web.response.StreamResponse
    get$download(String dictId, DownloadBody body)
    Downloads stopwords dictionary file.
    org.lastaflute.web.response.JsonResponse<ApiResult>
    get$setting(String dictId, long id)
    Retrieves a specific stopwords dictionary item by ID.
    org.lastaflute.web.response.JsonResponse<ApiResult>
    get$settings(String dictId, SearchBody body)
    Retrieves stopwords dictionary settings with pagination support.
    org.lastaflute.web.response.JsonResponse<ApiResult>
    post$setting(String dictId, CreateBody body)
    Creates a new stopwords dictionary item.
    org.lastaflute.web.response.JsonResponse<ApiResult>
    put$setting(String dictId, EditBody body)
    Updates an existing stopwords dictionary item.
    org.lastaflute.web.response.JsonResponse<ApiResult>
    put$upload(String dictId, UploadForm form)
    Uploads stopwords dictionary file.

    Methods inherited from class org.codelibs.fess.app.web.api.admin.FessApiAdminAction

    isAccessAllowed

    Methods inherited from class org.codelibs.fess.app.web.api.FessApiAction

    getMessage, godHandPrologue, myLoginManager

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

    buildThrowableMessage, copyBeanToBean, copyBeanToNewBean, copyMapToBean, createMessages, createValidator, getUserBean, godHandEpilogue, godHandMonologue, hookBefore, hookFinally, 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, setupHtmlData, 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, document1_CallableSuperMethod, document2_OverridableSuperMethod, document3_InjectableLastaComponent, document4_InjectableQuickComponent, document8_WordDictionary

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

    throwValidationError, throwValidationErrorApi, validate, validateApi

  • Constructor Details

    • ApiAdminDictStopwordsAction

      public ApiAdminDictStopwordsAction()
      Default constructor.

  • Method Details

    • get$settings

      @Execute public org.lastaflute.web.response.JsonResponse<ApiResult> get$settings(String dictId, SearchBody body)
      Retrieves stopwords dictionary settings with pagination support.
      Parameters:
      dictId - the dictionary ID
      body - the search body containing pagination and filter parameters
      Returns:
      JSON response containing list of stopwords dictionary items

    • get$setting

      @Execute public org.lastaflute.web.response.JsonResponse<ApiResult> get$setting(String dictId, long id)
      Retrieves a specific stopwords dictionary item by ID.
      Parameters:
      dictId - the dictionary ID
      id - the ID of the stopwords item to retrieve
      Returns:
      JSON response containing the stopwords dictionary item

    • post$setting

      @Execute public org.lastaflute.web.response.JsonResponse<ApiResult> post$setting(String dictId, CreateBody body)
      Creates a new stopwords dictionary item.
      Parameters:
      dictId - the dictionary ID
      body - the request body containing stopwords item information
      Returns:
      JSON response with result status

    • put$setting

      @Execute public org.lastaflute.web.response.JsonResponse<ApiResult> put$setting(String dictId, EditBody body)
      Updates an existing stopwords dictionary item.
      Parameters:
      dictId - the dictionary ID
      body - the request body containing updated stopwords item information
      Returns:
      JSON response with result status

    • delete$setting

      @Execute public org.lastaflute.web.response.JsonResponse<ApiResult> delete$setting(String dictId, long id)
      Deletes a stopwords dictionary item by ID.
      Parameters:
      dictId - the dictionary ID
      id - the ID of the stopwords item to delete
      Returns:
      JSON response indicating the deletion status

    • put$upload

      @Execute public org.lastaflute.web.response.JsonResponse<ApiResult> put$upload(String dictId, UploadForm form)
      Uploads stopwords dictionary file.
      Parameters:
      dictId - the dictionary ID
      form - the upload form containing the dictionary file
      Returns:
      JSON response with result status

    • get$download

      @Execute public org.lastaflute.web.response.StreamResponse get$download(String dictId, DownloadBody body)
      Downloads stopwords dictionary file.
      Parameters:
      dictId - the dictionary ID
      body - the download request body
      Returns:
      stream response containing the dictionary file data

    • createEditBody

      protected EditBody createEditBody(StopwordsItem entity, String dictId)
      Creates an EditBody from a StopwordsItem entity for API responses.
      Parameters:
      entity - the StopwordsItem entity to convert
      dictId - the dictionary ID
      Returns:
      the converted EditBody object