| No. | URL | type | class#method | Form or Body | return | count | ||
|---|---|---|---|---|---|---|---|---|
| fields | class lines | method lines | ||||||
| 1 | / | # simple implementation for now html | RootAction#index() | HtmlResponse | 0 | 40 | 14 | |
| 2 | /admin/ | # simple implementation for now html | AdminAction#index() | HtmlResponse | 0 | 381 | 234 | |
| 3 | /admin/accesstoken/ | # simple implementation for now html | AdminAccesstokenAction#index() | HtmlResponse | 7 | 381 | 4 | |
| 4 | /admin/accesstoken/list/{pageNumber} | # simple implementation for now html | AdminAccesstokenAction#list() | SearchForm | HtmlResponse | 7 | 381 | 11 |
| 5 | /admin/accesstoken/search | # simple implementation for now html | AdminAccesstokenAction#search() | SearchForm | HtmlResponse | 7 | 381 | 7 |
| 6 | /admin/accesstoken/reset | # simple implementation for now html | AdminAccesstokenAction#reset() | SearchForm | HtmlResponse | 7 | 381 | 7 |
| 7 | /admin/accesstoken/createnew | # simple implementation for now html | AdminAccesstokenAction#createnew() | HtmlResponse | 7 | 381 | 10 | |
| 8 | /admin/accesstoken/details/{crudMode}/{id} | # simple implementation for now html | AdminAccesstokenAction#details() | HtmlResponse | 7 | 381 | 23 | |
| 9 | /admin/accesstoken/edit | # simple implementation for now html | AdminAccesstokenAction#edit() | EditForm | HtmlResponse | 7 | 381 | 24 |
| 10 | /admin/accesstoken/create | # simple implementation for now html | AdminAccesstokenAction#create() | CreateForm | HtmlResponse | 7 | 381 | 20 |
| 11 | /admin/accesstoken/update | # simple implementation for now html | AdminAccesstokenAction#update() | EditForm | HtmlResponse | 7 | 381 | 19 |
| 12 | /admin/accesstoken/delete | # simple implementation for now html | AdminAccesstokenAction#delete() | EditForm | HtmlResponse | 7 | 381 | 20 |
| 13 | /admin/backup/ | # simple implementation for now html | AdminBackupAction#index() | HtmlResponse | 8 | 7 | 5 | |
| 14 | /admin/backup/upload | # simple implementation for now html | AdminBackupAction#upload() | UploadForm | HtmlResponse | 8 | 7 | 19 |
| 15 | /admin/backup/download/{id} | # simple implementation for now api | AdminBackupAction#download() | ActionResponse | 8 | 7 | 80 | |
| 16 | /admin/badword/ | # simple implementation for now html | AdminBadwordAction#index() | HtmlResponse | 5 | 442 | 4 | |
| 17 | /admin/badword/list/{pageNumber} | # simple implementation for now html | AdminBadwordAction#list() | SearchForm | HtmlResponse | 5 | 442 | 11 |
| 18 | /admin/badword/search | # simple implementation for now html | AdminBadwordAction#search() | SearchForm | HtmlResponse | 5 | 442 | 7 |
| 19 | /admin/badword/reset | # simple implementation for now html | AdminBadwordAction#reset() | SearchForm | HtmlResponse | 5 | 442 | 7 |
| 20 | /admin/badword/createnew | # simple implementation for now html | AdminBadwordAction#createnew() | HtmlResponse | 5 | 442 | 10 | |
| 21 | /admin/badword/edit | # simple implementation for now html | AdminBadwordAction#edit() | EditForm | HtmlResponse | 5 | 442 | 18 |
| 22 | /admin/badword/details/{crudMode}/{id} | # simple implementation for now html | AdminBadwordAction#details() | HtmlResponse | 5 | 442 | 17 | |
| 23 | /admin/badword/downloadpage | # simple implementation for now html | AdminBadwordAction#downloadpage() | HtmlResponse | 5 | 442 | 5 | |
| 24 | /admin/badword/download | # simple implementation for now api | AdminBadwordAction#download() | DownloadForm | ActionResponse | 5 | 442 | 21 |
| 25 | /admin/badword/uploadpage | # simple implementation for now html | AdminBadwordAction#uploadpage() | HtmlResponse | 5 | 442 | 5 | |
| 26 | /admin/badword/create | # simple implementation for now html | AdminBadwordAction#create() | CreateForm | HtmlResponse | 5 | 442 | 20 |
| 27 | /admin/badword/update | # simple implementation for now html | AdminBadwordAction#update() | EditForm | HtmlResponse | 5 | 442 | 20 |
| 28 | /admin/badword/delete | # simple implementation for now html | AdminBadwordAction#delete() | EditForm | HtmlResponse | 5 | 442 | 21 |
| 29 | /admin/badword/upload | # simple implementation for now html | AdminBadwordAction#upload() | UploadForm | HtmlResponse | 5 | 442 | 15 |
| 30 | /admin/boostdoc/ | # simple implementation for now html | AdminBoostdocAction#index() | HtmlResponse | 4 | 343 | 4 | |
| 31 | /admin/boostdoc/list/{pageNumber} | # simple implementation for now html | AdminBoostdocAction#list() | SearchForm | HtmlResponse | 4 | 343 | 11 |
| 32 | /admin/boostdoc/search | # simple implementation for now html | AdminBoostdocAction#search() | SearchForm | HtmlResponse | 4 | 343 | 7 |
| 33 | /admin/boostdoc/reset | # simple implementation for now html | AdminBoostdocAction#reset() | SearchForm | HtmlResponse | 4 | 343 | 7 |
| 34 | /admin/boostdoc/createnew | # simple implementation for now html | AdminBoostdocAction#createnew() | HtmlResponse | 4 | 343 | 10 | |
| 35 | /admin/boostdoc/edit | # simple implementation for now html | AdminBoostdocAction#edit() | EditForm | HtmlResponse | 4 | 343 | 18 |
| 36 | /admin/boostdoc/details/{crudMode}/{id} | # simple implementation for now html | AdminBoostdocAction#details() | HtmlResponse | 4 | 343 | 17 | |
| 37 | /admin/boostdoc/create | # simple implementation for now html | AdminBoostdocAction#create() | CreateForm | HtmlResponse | 4 | 343 | 19 |
| 38 | /admin/boostdoc/update | # simple implementation for now html | AdminBoostdocAction#update() | EditForm | HtmlResponse | 4 | 343 | 19 |
| 39 | /admin/boostdoc/delete | # simple implementation for now html | AdminBoostdocAction#delete() | EditForm | HtmlResponse | 4 | 343 | 20 |
| 40 | /admin/crawlinginfo/ | # simple implementation for now html | AdminCrawlinginfoAction#index() | HtmlResponse | 5 | 260 | 5 | |
| 41 | /admin/crawlinginfo/list/{pageNumber} | # simple implementation for now html | AdminCrawlinginfoAction#list() | SearchForm | HtmlResponse | 5 | 260 | 8 |
| 42 | /admin/crawlinginfo/search | # simple implementation for now html | AdminCrawlinginfoAction#search() | SearchForm | HtmlResponse | 5 | 260 | 8 |
| 43 | /admin/crawlinginfo/reset | # simple implementation for now html | AdminCrawlinginfoAction#reset() | SearchForm | HtmlResponse | 5 | 260 | 8 |
| 44 | /admin/crawlinginfo/back | # simple implementation for now html | AdminCrawlinginfoAction#back() | SearchForm | HtmlResponse | 5 | 260 | 7 |
| 45 | /admin/crawlinginfo/details/{crudMode}/{id} | # simple implementation for now html | AdminCrawlinginfoAction#details() | HtmlResponse | 5 | 260 | 21 | |
| 46 | /admin/crawlinginfo/threaddump | # simple implementation for now html | AdminCrawlinginfoAction#threaddump() | EditForm | HtmlResponse | 5 | 260 | 19 |
| 47 | /admin/crawlinginfo/delete | # simple implementation for now html | AdminCrawlinginfoAction#delete() | EditForm | HtmlResponse | 5 | 260 | 12 |
| 48 | /admin/crawlinginfo/deleteall | # simple implementation for now html | AdminCrawlinginfoAction#deleteall() | HtmlResponse | 5 | 260 | 8 | |
| 49 | /admin/dashboard/ | # simple implementation for now html | AdminDashboardAction#index() | HtmlResponse | 2 | 50 | 7 | |
| 50 | /admin/dataconfig/ | # simple implementation for now html | AdminDataconfigAction#index() | HtmlResponse | 6 | 427 | 4 | |
| 51 | /admin/dataconfig/list/{pageNumber} | # simple implementation for now html | AdminDataconfigAction#list() | SearchForm | HtmlResponse | 6 | 427 | 11 |
| 52 | /admin/dataconfig/search | # simple implementation for now html | AdminDataconfigAction#search() | SearchForm | HtmlResponse | 6 | 427 | 7 |
| 53 | /admin/dataconfig/reset | # simple implementation for now html | AdminDataconfigAction#reset() | SearchForm | HtmlResponse | 6 | 427 | 7 |
| 54 | /admin/dataconfig/createnew | # simple implementation for now html | AdminDataconfigAction#createnew() | HtmlResponse | 6 | 427 | 25 | |
| 55 | /admin/dataconfig/edit | # simple implementation for now html | AdminDataconfigAction#edit() | EditForm | HtmlResponse | 6 | 427 | 28 |
| 56 | /admin/dataconfig/details/{crudMode}/{id} | # simple implementation for now html | AdminDataconfigAction#details() | HtmlResponse | 6 | 427 | 25 | |
| 57 | /admin/dataconfig/create | # simple implementation for now html | AdminDataconfigAction#create() | CreateForm | HtmlResponse | 6 | 427 | 19 |
| 58 | /admin/dataconfig/update | # simple implementation for now html | AdminDataconfigAction#update() | EditForm | HtmlResponse | 6 | 427 | 19 |
| 59 | /admin/dataconfig/delete | # simple implementation for now html | AdminDataconfigAction#delete() | EditForm | HtmlResponse | 6 | 427 | 18 |
| 60 | /admin/design/ | # simple implementation for now html | AdminDesignAction#index() | HtmlResponse | 4 | 378 | 5 | |
| 61 | /admin/design/back | # simple implementation for now html | AdminDesignAction#back() | HtmlResponse | 4 | 378 | 5 | |
| 62 | /admin/design/upload | # simple implementation for now html | AdminDesignAction#upload() | UploadForm | HtmlResponse | 4 | 378 | 63 |
| 63 | /admin/design/download | # simple implementation for now stream | AdminDesignAction#download() | FileAccessForm | StreamResponse | 4 | 378 | 15 |
| 64 | /admin/design/delete | # simple implementation for now html | AdminDesignAction#delete() | FileAccessForm | HtmlResponse | 4 | 378 | 15 |
| 65 | /admin/design/edit | # simple implementation for now html | AdminDesignAction#edit() | EditForm | HtmlResponse | 4 | 378 | 12 |
| 66 | /admin/design/editAsUseDefault | # simple implementation for now html | AdminDesignAction#editAsUseDefault() | EditForm | HtmlResponse | 4 | 378 | 12 |
| 67 | /admin/design/update | # simple implementation for now html | AdminDesignAction#update() | EditForm | HtmlResponse | 4 | 378 | 20 |
| 68 | /admin/dict/ | # simple implementation for now html | AdminDictAction#index() | HtmlResponse | 2 | 48 | 7 | |
| 69 | /admin/dict/kuromoji/ | # simple implementation for now html | AdminDictKuromojiAction#index() | SearchForm | HtmlResponse | 4 | 497 | 8 |
| 70 | /admin/dict/kuromoji/list/{pageNumber} | # simple implementation for now html | AdminDictKuromojiAction#list() | SearchForm | HtmlResponse | 4 | 497 | 12 |
| 71 | /admin/dict/kuromoji/search | # simple implementation for now html | AdminDictKuromojiAction#search() | SearchForm | HtmlResponse | 4 | 497 | 8 |
| 72 | /admin/dict/kuromoji/reset | # simple implementation for now html | AdminDictKuromojiAction#reset() | SearchForm | HtmlResponse | 4 | 497 | 8 |
| 73 | /admin/dict/kuromoji/createnew/{dictId} | # simple implementation for now html | AdminDictKuromojiAction#createnew() | HtmlResponse | 4 | 497 | 11 | |
| 74 | /admin/dict/kuromoji/edit | # simple implementation for now html | AdminDictKuromojiAction#edit() | EditForm | HtmlResponse | 4 | 497 | 18 |
| 75 | /admin/dict/kuromoji/details/{dictId}/{crudMode}/{id} | # simple implementation for now html | AdminDictKuromojiAction#details() | HtmlResponse | 4 | 497 | 19 | |
| 76 | /admin/dict/kuromoji/downloadpage/{dictId} | # simple implementation for now html | AdminDictKuromojiAction#downloadpage() | HtmlResponse | 4 | 497 | 15 | |
| 77 | /admin/dict/kuromoji/download | # simple implementation for now api | AdminDictKuromojiAction#download() | DownloadForm | ActionResponse | 4 | 497 | 14 |
| 78 | /admin/dict/kuromoji/uploadpage/{dictId} | # simple implementation for now html | AdminDictKuromojiAction#uploadpage() | HtmlResponse | 4 | 497 | 15 | |
| 79 | /admin/dict/kuromoji/upload | # simple implementation for now html | AdminDictKuromojiAction#upload() | UploadForm | HtmlResponse | 4 | 497 | 20 |
| 80 | /admin/dict/kuromoji/create | # simple implementation for now html | AdminDictKuromojiAction#create() | CreateForm | HtmlResponse | 4 | 497 | 20 |
| 81 | /admin/dict/kuromoji/update | # simple implementation for now html | AdminDictKuromojiAction#update() | EditForm | HtmlResponse | 4 | 497 | 20 |
| 82 | /admin/dict/kuromoji/delete | # simple implementation for now html | AdminDictKuromojiAction#delete() | EditForm | HtmlResponse | 4 | 497 | 19 |
| 83 | /admin/dict/mapping/ | # simple implementation for now html | AdminDictMappingAction#index() | SearchForm | HtmlResponse | 4 | 515 | 8 |
| 84 | /admin/dict/mapping/list/{pageNumber} | # simple implementation for now html | AdminDictMappingAction#list() | SearchForm | HtmlResponse | 4 | 515 | 12 |
| 85 | /admin/dict/mapping/search | # simple implementation for now html | AdminDictMappingAction#search() | SearchForm | HtmlResponse | 4 | 515 | 8 |
| 86 | /admin/dict/mapping/reset | # simple implementation for now html | AdminDictMappingAction#reset() | SearchForm | HtmlResponse | 4 | 515 | 8 |
| 87 | /admin/dict/mapping/createnew/{dictId} | # simple implementation for now html | AdminDictMappingAction#createnew() | HtmlResponse | 4 | 515 | 11 | |
| 88 | /admin/dict/mapping/edit | # simple implementation for now html | AdminDictMappingAction#edit() | EditForm | HtmlResponse | 4 | 515 | 19 |
| 89 | /admin/dict/mapping/details/{dictId}/{crudMode}/{id} | # simple implementation for now html | AdminDictMappingAction#details() | HtmlResponse | 4 | 515 | 19 | |
| 90 | /admin/dict/mapping/downloadpage/{dictId} | # simple implementation for now html | AdminDictMappingAction#downloadpage() | HtmlResponse | 4 | 515 | 15 | |
| 91 | /admin/dict/mapping/download | # simple implementation for now api | AdminDictMappingAction#download() | DownloadForm | ActionResponse | 4 | 515 | 14 |
| 92 | /admin/dict/mapping/uploadpage/{dictId} | # simple implementation for now html | AdminDictMappingAction#uploadpage() | HtmlResponse | 4 | 515 | 15 | |
| 93 | /admin/dict/mapping/upload | # simple implementation for now html | AdminDictMappingAction#upload() | UploadForm | HtmlResponse | 4 | 515 | 20 |
| 94 | /admin/dict/mapping/create | # simple implementation for now html | AdminDictMappingAction#create() | CreateForm | HtmlResponse | 4 | 515 | 19 |
| 95 | /admin/dict/mapping/update | # simple implementation for now html | AdminDictMappingAction#update() | EditForm | HtmlResponse | 4 | 515 | 19 |
| 96 | /admin/dict/mapping/delete | # simple implementation for now html | AdminDictMappingAction#delete() | EditForm | HtmlResponse | 4 | 515 | 19 |
| 97 | /admin/dict/protwords/ | # simple implementation for now html | AdminDictProtwordsAction#index() | SearchForm | HtmlResponse | 4 | 468 | 8 |
| 98 | /admin/dict/protwords/list/{pageNumber} | # simple implementation for now html | AdminDictProtwordsAction#list() | SearchForm | HtmlResponse | 4 | 468 | 12 |
| 99 | /admin/dict/protwords/search | # simple implementation for now html | AdminDictProtwordsAction#search() | SearchForm | HtmlResponse | 4 | 468 | 8 |
| 100 | /admin/dict/protwords/reset | # simple implementation for now html | AdminDictProtwordsAction#reset() | SearchForm | HtmlResponse | 4 | 468 | 8 |
| 101 | /admin/dict/protwords/createnew/{dictId} | # simple implementation for now html | AdminDictProtwordsAction#createnew() | HtmlResponse | 4 | 468 | 11 | |
| 102 | /admin/dict/protwords/edit | # simple implementation for now html | AdminDictProtwordsAction#edit() | EditForm | HtmlResponse | 4 | 468 | 18 |
| 103 | /admin/dict/protwords/details/{dictId}/{crudMode}/{id} | # simple implementation for now html | AdminDictProtwordsAction#details() | HtmlResponse | 4 | 468 | 18 | |
| 104 | /admin/dict/protwords/downloadpage/{dictId} | # simple implementation for now html | AdminDictProtwordsAction#downloadpage() | HtmlResponse | 4 | 468 | 15 | |
| 105 | /admin/dict/protwords/download | # simple implementation for now api | AdminDictProtwordsAction#download() | DownloadForm | ActionResponse | 4 | 468 | 14 |
| 106 | /admin/dict/protwords/uploadpage/{dictId} | # simple implementation for now html | AdminDictProtwordsAction#uploadpage() | HtmlResponse | 4 | 468 | 15 | |
| 107 | /admin/dict/protwords/upload | # simple implementation for now html | AdminDictProtwordsAction#upload() | UploadForm | HtmlResponse | 4 | 468 | 20 |
| 108 | /admin/dict/protwords/create | # simple implementation for now html | AdminDictProtwordsAction#create() | CreateForm | HtmlResponse | 4 | 468 | 11 |
| 109 | /admin/dict/protwords/update | # simple implementation for now html | AdminDictProtwordsAction#update() | EditForm | HtmlResponse | 4 | 468 | 13 |
| 110 | /admin/dict/protwords/delete | # simple implementation for now html | AdminDictProtwordsAction#delete() | EditForm | HtmlResponse | 4 | 468 | 13 |
| 111 | /admin/dict/stemmeroverride/ | # simple implementation for now html | AdminDictStemmeroverrideAction#index() | SearchForm | HtmlResponse | 4 | 510 | 8 |
| 112 | /admin/dict/stemmeroverride/list/{pageNumber} | # simple implementation for now html | AdminDictStemmeroverrideAction#list() | SearchForm | HtmlResponse | 4 | 510 | 12 |
| 113 | /admin/dict/stemmeroverride/search | # simple implementation for now html | AdminDictStemmeroverrideAction#search() | SearchForm | HtmlResponse | 4 | 510 | 8 |
| 114 | /admin/dict/stemmeroverride/reset | # simple implementation for now html | AdminDictStemmeroverrideAction#reset() | SearchForm | HtmlResponse | 4 | 510 | 8 |
| 115 | /admin/dict/stemmeroverride/createnew/{dictId} | # simple implementation for now html | AdminDictStemmeroverrideAction#createnew() | HtmlResponse | 4 | 510 | 11 | |
| 116 | /admin/dict/stemmeroverride/edit | # simple implementation for now html | AdminDictStemmeroverrideAction#edit() | EditForm | HtmlResponse | 4 | 510 | 19 |
| 117 | /admin/dict/stemmeroverride/details/{dictId}/{crudMode}/{id} | # simple implementation for now html | AdminDictStemmeroverrideAction#details() | HtmlResponse | 4 | 510 | 19 | |
| 118 | /admin/dict/stemmeroverride/downloadpage/{dictId} | # simple implementation for now html | AdminDictStemmeroverrideAction#downloadpage() | HtmlResponse | 4 | 510 | 15 | |
| 119 | /admin/dict/stemmeroverride/download | # simple implementation for now api | AdminDictStemmeroverrideAction#download() | DownloadForm | ActionResponse | 4 | 510 | 14 |
| 120 | /admin/dict/stemmeroverride/uploadpage/{dictId} | # simple implementation for now html | AdminDictStemmeroverrideAction#uploadpage() | HtmlResponse | 4 | 510 | 15 | |
| 121 | /admin/dict/stemmeroverride/upload | # simple implementation for now html | AdminDictStemmeroverrideAction#upload() | UploadForm | HtmlResponse | 4 | 510 | 20 |
| 122 | /admin/dict/stemmeroverride/create | # simple implementation for now html | AdminDictStemmeroverrideAction#create() | CreateForm | HtmlResponse | 4 | 510 | 19 |
| 123 | /admin/dict/stemmeroverride/update | # simple implementation for now html | AdminDictStemmeroverrideAction#update() | EditForm | HtmlResponse | 4 | 510 | 20 |
| 124 | /admin/dict/stemmeroverride/delete | # simple implementation for now html | AdminDictStemmeroverrideAction#delete() | EditForm | HtmlResponse | 4 | 510 | 19 |
| 125 | /admin/dict/stopwords/ | # simple implementation for now html | AdminDictStopwordsAction#index() | SearchForm | HtmlResponse | 4 | 461 | 8 |
| 126 | /admin/dict/stopwords/list/{pageNumber} | # simple implementation for now html | AdminDictStopwordsAction#list() | SearchForm | HtmlResponse | 4 | 461 | 12 |
| 127 | /admin/dict/stopwords/search | # simple implementation for now html | AdminDictStopwordsAction#search() | SearchForm | HtmlResponse | 4 | 461 | 8 |
| 128 | /admin/dict/stopwords/reset | # simple implementation for now html | AdminDictStopwordsAction#reset() | SearchForm | HtmlResponse | 4 | 461 | 8 |
| 129 | /admin/dict/stopwords/createnew/{dictId} | # simple implementation for now html | AdminDictStopwordsAction#createnew() | HtmlResponse | 4 | 461 | 11 | |
| 130 | /admin/dict/stopwords/edit | # simple implementation for now html | AdminDictStopwordsAction#edit() | EditForm | HtmlResponse | 4 | 461 | 18 |
| 131 | /admin/dict/stopwords/details/{dictId}/{crudMode}/{id} | # simple implementation for now html | AdminDictStopwordsAction#details() | HtmlResponse | 4 | 461 | 18 | |
| 132 | /admin/dict/stopwords/downloadpage/{dictId} | # simple implementation for now html | AdminDictStopwordsAction#downloadpage() | HtmlResponse | 4 | 461 | 15 | |
| 133 | /admin/dict/stopwords/download | # simple implementation for now api | AdminDictStopwordsAction#download() | DownloadForm | ActionResponse | 4 | 461 | 14 |
| 134 | /admin/dict/stopwords/uploadpage/{dictId} | # simple implementation for now html | AdminDictStopwordsAction#uploadpage() | HtmlResponse | 4 | 461 | 15 | |
| 135 | /admin/dict/stopwords/upload | # simple implementation for now html | AdminDictStopwordsAction#upload() | UploadForm | HtmlResponse | 4 | 461 | 20 |
| 136 | /admin/dict/stopwords/create | # simple implementation for now html | AdminDictStopwordsAction#create() | CreateForm | HtmlResponse | 4 | 461 | 11 |
| 137 | /admin/dict/stopwords/update | # simple implementation for now html | AdminDictStopwordsAction#update() | EditForm | HtmlResponse | 4 | 461 | 13 |
| 138 | /admin/dict/stopwords/delete | # simple implementation for now html | AdminDictStopwordsAction#delete() | EditForm | HtmlResponse | 4 | 461 | 13 |
| 139 | /admin/dict/synonym/ | # simple implementation for now html | AdminDictSynonymAction#index() | SearchForm | HtmlResponse | 4 | 536 | 8 |
| 140 | /admin/dict/synonym/list/{pageNumber} | # simple implementation for now html | AdminDictSynonymAction#list() | SearchForm | HtmlResponse | 4 | 536 | 12 |
| 141 | /admin/dict/synonym/search | # simple implementation for now html | AdminDictSynonymAction#search() | SearchForm | HtmlResponse | 4 | 536 | 8 |
| 142 | /admin/dict/synonym/reset | # simple implementation for now html | AdminDictSynonymAction#reset() | SearchForm | HtmlResponse | 4 | 536 | 8 |
| 143 | /admin/dict/synonym/createnew/{dictId} | # simple implementation for now html | AdminDictSynonymAction#createnew() | HtmlResponse | 4 | 536 | 11 | |
| 144 | /admin/dict/synonym/edit | # simple implementation for now html | AdminDictSynonymAction#edit() | EditForm | HtmlResponse | 4 | 536 | 19 |
| 145 | /admin/dict/synonym/details/{dictId}/{crudMode}/{id} | # simple implementation for now html | AdminDictSynonymAction#details() | HtmlResponse | 4 | 536 | 19 | |
| 146 | /admin/dict/synonym/downloadpage/{dictId} | # simple implementation for now html | AdminDictSynonymAction#downloadpage() | HtmlResponse | 4 | 536 | 15 | |
| 147 | /admin/dict/synonym/download | # simple implementation for now api | AdminDictSynonymAction#download() | DownloadForm | ActionResponse | 4 | 536 | 14 |
| 148 | /admin/dict/synonym/uploadpage/{dictId} | # simple implementation for now html | AdminDictSynonymAction#uploadpage() | HtmlResponse | 4 | 536 | 15 | |
| 149 | /admin/dict/synonym/upload | # simple implementation for now html | AdminDictSynonymAction#upload() | UploadForm | HtmlResponse | 4 | 536 | 20 |
| 150 | /admin/dict/synonym/create | # simple implementation for now html | AdminDictSynonymAction#create() | CreateForm | HtmlResponse | 4 | 536 | 19 |
| 151 | /admin/dict/synonym/update | # simple implementation for now html | AdminDictSynonymAction#update() | EditForm | HtmlResponse | 4 | 536 | 20 |
| 152 | /admin/dict/synonym/delete | # simple implementation for now html | AdminDictSynonymAction#delete() | EditForm | HtmlResponse | 4 | 536 | 19 |
| 153 | /admin/duplicatehost/ | # simple implementation for now html | AdminDuplicatehostAction#index() | SearchForm | HtmlResponse | 4 | 365 | 4 |
| 154 | /admin/duplicatehost/list/{pageNumber} | # simple implementation for now html | AdminDuplicatehostAction#list() | SearchForm | HtmlResponse | 4 | 365 | 11 |
| 155 | /admin/duplicatehost/search | # simple implementation for now html | AdminDuplicatehostAction#search() | SearchForm | HtmlResponse | 4 | 365 | 7 |
| 156 | /admin/duplicatehost/reset | # simple implementation for now html | AdminDuplicatehostAction#reset() | SearchForm | HtmlResponse | 4 | 365 | 7 |
| 157 | /admin/duplicatehost/createnew | # simple implementation for now html | AdminDuplicatehostAction#createnew() | HtmlResponse | 4 | 365 | 10 | |
| 158 | /admin/duplicatehost/edit | # simple implementation for now html | AdminDuplicatehostAction#edit() | EditForm | HtmlResponse | 4 | 365 | 18 |
| 159 | /admin/duplicatehost/details/{crudMode}/{id} | # simple implementation for now html | AdminDuplicatehostAction#details() | HtmlResponse | 4 | 365 | 17 | |
| 160 | /admin/duplicatehost/create | # simple implementation for now html | AdminDuplicatehostAction#create() | CreateForm | HtmlResponse | 4 | 365 | 19 |
| 161 | /admin/duplicatehost/update | # simple implementation for now html | AdminDuplicatehostAction#update() | EditForm | HtmlResponse | 4 | 365 | 19 |
| 162 | /admin/duplicatehost/delete | # simple implementation for now html | AdminDuplicatehostAction#delete() | EditForm | HtmlResponse | 4 | 365 | 20 |
| 163 | /admin/elevateword/ | # simple implementation for now html | AdminElevatewordAction#index() | HtmlResponse | 6 | 495 | 4 | |
| 164 | /admin/elevateword/list/{pageNumber} | # simple implementation for now html | AdminElevatewordAction#list() | SearchForm | HtmlResponse | 6 | 495 | 11 |
| 165 | /admin/elevateword/search | # simple implementation for now html | AdminElevatewordAction#search() | SearchForm | HtmlResponse | 6 | 495 | 7 |
| 166 | /admin/elevateword/reset | # simple implementation for now html | AdminElevatewordAction#reset() | SearchForm | HtmlResponse | 6 | 495 | 7 |
| 167 | /admin/elevateword/createnew | # simple implementation for now html | AdminElevatewordAction#createnew() | HtmlResponse | 6 | 495 | 12 | |
| 168 | /admin/elevateword/edit | # simple implementation for now html | AdminElevatewordAction#edit() | EditForm | HtmlResponse | 6 | 495 | 26 |
| 169 | /admin/elevateword/details/{crudMode}/{id} | # simple implementation for now html | AdminElevatewordAction#details() | HtmlResponse | 6 | 495 | 19 | |
| 170 | /admin/elevateword/downloadpage | # simple implementation for now html | AdminElevatewordAction#downloadpage() | HtmlResponse | 6 | 495 | 5 | |
| 171 | /admin/elevateword/download | # simple implementation for now api | AdminElevatewordAction#download() | DownloadForm | ActionResponse | 6 | 495 | 21 |
| 172 | /admin/elevateword/uploadpage | # simple implementation for now html | AdminElevatewordAction#uploadpage() | HtmlResponse | 6 | 495 | 5 | |
| 173 | /admin/elevateword/create | # simple implementation for now html | AdminElevatewordAction#create() | CreateForm | HtmlResponse | 6 | 495 | 21 |
| 174 | /admin/elevateword/update | # simple implementation for now html | AdminElevatewordAction#update() | EditForm | HtmlResponse | 6 | 495 | 21 |
| 175 | /admin/elevateword/delete | # simple implementation for now html | AdminElevatewordAction#delete() | EditForm | HtmlResponse | 6 | 495 | 19 |
| 176 | /admin/elevateword/upload | # simple implementation for now html | AdminElevatewordAction#upload() | UploadForm | HtmlResponse | 6 | 495 | 16 |
| 177 | /admin/failureurl/ | # simple implementation for now html | AdminFailureurlAction#index() | HtmlResponse | 3 | 225 | 5 | |
| 178 | /admin/failureurl/list/{pageNumber} | # simple implementation for now html | AdminFailureurlAction#list() | SearchForm | HtmlResponse | 3 | 225 | 7 |
| 179 | /admin/failureurl/search | # simple implementation for now html | AdminFailureurlAction#search() | SearchForm | HtmlResponse | 3 | 225 | 7 |
| 180 | /admin/failureurl/reset | # simple implementation for now html | AdminFailureurlAction#reset() | SearchForm | HtmlResponse | 3 | 225 | 7 |
| 181 | /admin/failureurl/back | # simple implementation for now html | AdminFailureurlAction#back() | SearchForm | HtmlResponse | 3 | 225 | 6 |
| 182 | /admin/failureurl/details/{crudMode}/{id} | # simple implementation for now html | AdminFailureurlAction#details() | HtmlResponse | 3 | 225 | 16 | |
| 183 | /admin/failureurl/delete | # simple implementation for now html | AdminFailureurlAction#delete() | EditForm | HtmlResponse | 3 | 225 | 12 |
| 184 | /admin/failureurl/deleteall | # simple implementation for now html | AdminFailureurlAction#deleteall() | HtmlResponse | 3 | 225 | 8 | |
| 185 | /admin/fileauth/ | # simple implementation for now html | AdminFileauthAction#index() | HtmlResponse | 5 | 449 | 4 | |
| 186 | /admin/fileauth/list/{pageNumber} | # simple implementation for now html | AdminFileauthAction#list() | SearchForm | HtmlResponse | 5 | 449 | 11 |
| 187 | /admin/fileauth/search | # simple implementation for now html | AdminFileauthAction#search() | SearchForm | HtmlResponse | 5 | 449 | 7 |
| 188 | /admin/fileauth/reset | # simple implementation for now html | AdminFileauthAction#reset() | SearchForm | HtmlResponse | 5 | 449 | 7 |
| 189 | /admin/fileauth/createnew | # simple implementation for now html | AdminFileauthAction#createnew() | HtmlResponse | 5 | 449 | 13 | |
| 190 | /admin/fileauth/edit | # simple implementation for now html | AdminFileauthAction#edit() | EditForm | HtmlResponse | 5 | 449 | 18 |
| 191 | /admin/fileauth/details/{crudMode}/{id} | # simple implementation for now html | AdminFileauthAction#details() | HtmlResponse | 5 | 449 | 17 | |
| 192 | /admin/fileauth/create | # simple implementation for now html | AdminFileauthAction#create() | CreateForm | HtmlResponse | 5 | 449 | 19 |
| 193 | /admin/fileauth/update | # simple implementation for now html | AdminFileauthAction#update() | EditForm | HtmlResponse | 5 | 449 | 19 |
| 194 | /admin/fileauth/delete | # simple implementation for now html | AdminFileauthAction#delete() | EditForm | HtmlResponse | 5 | 449 | 20 |
| 195 | /admin/fileconfig/ | # simple implementation for now html | AdminFileconfigAction#index() | HtmlResponse | 6 | 453 | 4 | |
| 196 | /admin/fileconfig/list/{pageNumber} | # simple implementation for now html | AdminFileconfigAction#list() | SearchForm | HtmlResponse | 6 | 453 | 11 |
| 197 | /admin/fileconfig/search | # simple implementation for now html | AdminFileconfigAction#search() | SearchForm | HtmlResponse | 6 | 453 | 7 |
| 198 | /admin/fileconfig/reset | # simple implementation for now html | AdminFileconfigAction#reset() | SearchForm | HtmlResponse | 6 | 453 | 7 |
| 199 | /admin/fileconfig/createnew | # simple implementation for now html | AdminFileconfigAction#createnew() | HtmlResponse | 6 | 453 | 27 | |
| 200 | /admin/fileconfig/edit | # simple implementation for now html | AdminFileconfigAction#edit() | EditForm | HtmlResponse | 6 | 453 | 26 |
| 201 | /admin/fileconfig/details/{crudMode}/{id} | # simple implementation for now html | AdminFileconfigAction#details() | HtmlResponse | 6 | 453 | 21 | |
| 202 | /admin/fileconfig/create | # simple implementation for now html | AdminFileconfigAction#create() | CreateForm | HtmlResponse | 6 | 453 | 19 |
| 203 | /admin/fileconfig/update | # simple implementation for now html | AdminFileconfigAction#update() | EditForm | HtmlResponse | 6 | 453 | 19 |
| 204 | /admin/fileconfig/delete | # simple implementation for now html | AdminFileconfigAction#delete() | EditForm | HtmlResponse | 6 | 453 | 20 |
| 205 | /admin/general/ | # simple implementation for now html | AdminGeneralAction#index() | HtmlResponse | 4 | 247 | 9 | |
| 206 | /admin/general/sendmail | # simple implementation for now html | AdminGeneralAction#sendmail() | MailForm | HtmlResponse | 4 | 247 | 29 |
| 207 | /admin/general/update | # simple implementation for now html | AdminGeneralAction#update() | EditForm | HtmlResponse | 4 | 247 | 9 |
| 208 | /admin/group/ | # simple implementation for now html | AdminGroupAction#index() | HtmlResponse | 4 | 398 | 4 | |
| 209 | /admin/group/list/{pageNumber} | # simple implementation for now html | AdminGroupAction#list() | SearchForm | HtmlResponse | 4 | 398 | 11 |
| 210 | /admin/group/search | # simple implementation for now html | AdminGroupAction#search() | SearchForm | HtmlResponse | 4 | 398 | 7 |
| 211 | /admin/group/reset | # simple implementation for now html | AdminGroupAction#reset() | SearchForm | HtmlResponse | 4 | 398 | 7 |
| 212 | /admin/group/createnew | # simple implementation for now html | AdminGroupAction#createnew() | HtmlResponse | 4 | 398 | 10 | |
| 213 | /admin/group/edit | # simple implementation for now html | AdminGroupAction#edit() | EditForm | HtmlResponse | 4 | 398 | 18 |
| 214 | /admin/group/details/{crudMode}/{id} | # simple implementation for now html | AdminGroupAction#details() | HtmlResponse | 4 | 398 | 17 | |
| 215 | /admin/group/create | # simple implementation for now html | AdminGroupAction#create() | CreateForm | HtmlResponse | 4 | 398 | 20 |
| 216 | /admin/group/update | # simple implementation for now html | AdminGroupAction#update() | EditForm | HtmlResponse | 4 | 398 | 20 |
| 217 | /admin/group/delete | # simple implementation for now html | AdminGroupAction#delete() | EditForm | HtmlResponse | 4 | 398 | 20 |
| 218 | /admin/joblog/ | # simple implementation for now html | AdminJoblogAction#index() | SearchForm | HtmlResponse | 3 | 265 | 5 |
| 219 | /admin/joblog/list/{pageNumber} | # simple implementation for now html | AdminJoblogAction#list() | SearchForm | HtmlResponse | 3 | 265 | 8 |
| 220 | /admin/joblog/search | # simple implementation for now html | AdminJoblogAction#search() | SearchForm | HtmlResponse | 3 | 265 | 8 |
| 221 | /admin/joblog/reset | # simple implementation for now html | AdminJoblogAction#reset() | SearchForm | HtmlResponse | 3 | 265 | 8 |
| 222 | /admin/joblog/back | # simple implementation for now html | AdminJoblogAction#back() | SearchForm | HtmlResponse | 3 | 265 | 7 |
| 223 | /admin/joblog/details/{crudMode}/{id} | # simple implementation for now html | AdminJoblogAction#details() | HtmlResponse | 3 | 265 | 17 | |
| 224 | /admin/joblog/delete | # simple implementation for now html | AdminJoblogAction#delete() | EditForm | HtmlResponse | 3 | 265 | 12 |
| 225 | /admin/joblog/deleteall | # simple implementation for now html | AdminJoblogAction#deleteall() | HtmlResponse | 3 | 265 | 11 | |
| 226 | /admin/keymatch/ | # simple implementation for now html | AdminKeymatchAction#index() | SearchForm | HtmlResponse | 5 | 404 | 4 |
| 227 | /admin/keymatch/list/{pageNumber} | # simple implementation for now html | AdminKeymatchAction#list() | SearchForm | HtmlResponse | 5 | 404 | 11 |
| 228 | /admin/keymatch/search | # simple implementation for now html | AdminKeymatchAction#search() | SearchForm | HtmlResponse | 5 | 404 | 7 |
| 229 | /admin/keymatch/reset | # simple implementation for now html | AdminKeymatchAction#reset() | SearchForm | HtmlResponse | 5 | 404 | 7 |
| 230 | /admin/keymatch/createnew | # simple implementation for now html | AdminKeymatchAction#createnew() | HtmlResponse | 5 | 404 | 10 | |
| 231 | /admin/keymatch/edit | # simple implementation for now html | AdminKeymatchAction#edit() | EditForm | HtmlResponse | 5 | 404 | 18 |
| 232 | /admin/keymatch/details/{crudMode}/{id} | # simple implementation for now html | AdminKeymatchAction#details() | HtmlResponse | 5 | 404 | 21 | |
| 233 | /admin/keymatch/create | # simple implementation for now html | AdminKeymatchAction#create() | CreateForm | HtmlResponse | 5 | 404 | 20 |
| 234 | /admin/keymatch/update | # simple implementation for now html | AdminKeymatchAction#update() | EditForm | HtmlResponse | 5 | 404 | 20 |
| 235 | /admin/keymatch/delete | # simple implementation for now html | AdminKeymatchAction#delete() | EditForm | HtmlResponse | 5 | 404 | 21 |
| 236 | /admin/labeltype/ | # simple implementation for now html | AdminLabeltypeAction#index() | SearchForm | HtmlResponse | 5 | 435 | 4 |
| 237 | /admin/labeltype/list/{pageNumber} | # simple implementation for now html | AdminLabeltypeAction#list() | SearchForm | HtmlResponse | 5 | 435 | 11 |
| 238 | /admin/labeltype/search | # simple implementation for now html | AdminLabeltypeAction#search() | SearchForm | HtmlResponse | 5 | 435 | 7 |
| 239 | /admin/labeltype/reset | # simple implementation for now html | AdminLabeltypeAction#reset() | SearchForm | HtmlResponse | 5 | 435 | 7 |
| 240 | /admin/labeltype/createnew | # simple implementation for now html | AdminLabeltypeAction#createnew() | HtmlResponse | 5 | 435 | 12 | |
| 241 | /admin/labeltype/edit | # simple implementation for now html | AdminLabeltypeAction#edit() | EditForm | HtmlResponse | 5 | 435 | 26 |
| 242 | /admin/labeltype/details/{crudMode}/{id} | # simple implementation for now html | AdminLabeltypeAction#details() | HtmlResponse | 5 | 435 | 25 | |
| 243 | /admin/labeltype/create | # simple implementation for now html | AdminLabeltypeAction#create() | CreateForm | HtmlResponse | 5 | 435 | 19 |
| 244 | /admin/labeltype/update | # simple implementation for now html | AdminLabeltypeAction#update() | EditForm | HtmlResponse | 5 | 435 | 19 |
| 245 | /admin/labeltype/delete | # simple implementation for now html | AdminLabeltypeAction#delete() | EditForm | HtmlResponse | 5 | 435 | 20 |
| 246 | /admin/log/ | # simple implementation for now html | AdminLogAction#index() | HtmlResponse | 1 | 104 | 4 | |
| 247 | /admin/log/download/{id} | # simple implementation for now api | AdminLogAction#download() | ActionResponse | 1 | 104 | 15 | |
| 248 | /admin/maintenance/ | # simple implementation for now html | AdminMaintenanceAction#index() | HtmlResponse | 4 | 377 | 5 | |
| 249 | /admin/maintenance/reindexOnly | # simple implementation for now html | AdminMaintenanceAction#reindexOnly() | ActionForm | HtmlResponse | 4 | 377 | 10 |
| 250 | /admin/maintenance/reloadDocIndex | # simple implementation for now html | AdminMaintenanceAction#reloadDocIndex() | ActionForm | HtmlResponse | 4 | 377 | 18 |
| 251 | /admin/maintenance/clearCrawlerIndex | # simple implementation for now html | AdminMaintenanceAction#clearCrawlerIndex() | ActionForm | HtmlResponse | 4 | 377 | 15 |
| 252 | /admin/maintenance/downloadLogs | # simple implementation for now api | AdminMaintenanceAction#downloadLogs() | ActionForm | ActionResponse | 4 | 377 | 17 |
| 253 | /admin/pathmap/ | # simple implementation for now html | AdminPathmapAction#index() | SearchForm | HtmlResponse | 4 | 357 | 4 |
| 254 | /admin/pathmap/list/{pageNumber} | # simple implementation for now html | AdminPathmapAction#list() | SearchForm | HtmlResponse | 4 | 357 | 11 |
| 255 | /admin/pathmap/search | # simple implementation for now html | AdminPathmapAction#search() | SearchForm | HtmlResponse | 4 | 357 | 7 |
| 256 | /admin/pathmap/reset | # simple implementation for now html | AdminPathmapAction#reset() | SearchForm | HtmlResponse | 4 | 357 | 7 |
| 257 | /admin/pathmap/createnew | # simple implementation for now html | AdminPathmapAction#createnew() | HtmlResponse | 4 | 357 | 10 | |
| 258 | /admin/pathmap/edit | # simple implementation for now html | AdminPathmapAction#edit() | EditForm | HtmlResponse | 4 | 357 | 18 |
| 259 | /admin/pathmap/details/{crudMode}/{id} | # simple implementation for now html | AdminPathmapAction#details() | HtmlResponse | 4 | 357 | 17 | |
| 260 | /admin/pathmap/create | # simple implementation for now html | AdminPathmapAction#create() | CreateForm | HtmlResponse | 4 | 357 | 19 |
| 261 | /admin/pathmap/update | # simple implementation for now html | AdminPathmapAction#update() | EditForm | HtmlResponse | 4 | 357 | 19 |
| 262 | /admin/pathmap/delete | # simple implementation for now html | AdminPathmapAction#delete() | EditForm | HtmlResponse | 4 | 357 | 20 |
| 263 | /admin/plugin/ | # simple implementation for now html | AdminPluginAction#index() | HtmlResponse | 3 | 251 | 5 | |
| 264 | /admin/plugin/delete | # simple implementation for now html | AdminPluginAction#delete() | DeleteForm | HtmlResponse | 3 | 251 | 9 |
| 265 | /admin/plugin/install | # simple implementation for now html | AdminPluginAction#install() | InstallForm | HtmlResponse | 3 | 251 | 54 |
| 266 | /admin/plugin/installplugin | # simple implementation for now html | AdminPluginAction#installplugin() | HtmlResponse | 3 | 251 | 19 | |
| 267 | /admin/relatedcontent/ | # simple implementation for now html | AdminRelatedcontentAction#index() | HtmlResponse | 4 | 356 | 4 | |
| 268 | /admin/relatedcontent/list/{pageNumber} | # simple implementation for now html | AdminRelatedcontentAction#list() | SearchForm | HtmlResponse | 4 | 356 | 11 |
| 269 | /admin/relatedcontent/search | # simple implementation for now html | AdminRelatedcontentAction#search() | SearchForm | HtmlResponse | 4 | 356 | 7 |
| 270 | /admin/relatedcontent/reset | # simple implementation for now html | AdminRelatedcontentAction#reset() | SearchForm | HtmlResponse | 4 | 356 | 7 |
| 271 | /admin/relatedcontent/createnew | # simple implementation for now html | AdminRelatedcontentAction#createnew() | HtmlResponse | 4 | 356 | 10 | |
| 272 | /admin/relatedcontent/edit | # simple implementation for now html | AdminRelatedcontentAction#edit() | EditForm | HtmlResponse | 4 | 356 | 18 |
| 273 | /admin/relatedcontent/details/{crudMode}/{id} | # simple implementation for now html | AdminRelatedcontentAction#details() | HtmlResponse | 4 | 356 | 17 | |
| 274 | /admin/relatedcontent/create | # simple implementation for now html | AdminRelatedcontentAction#create() | CreateForm | HtmlResponse | 4 | 356 | 19 |
| 275 | /admin/relatedcontent/update | # simple implementation for now html | AdminRelatedcontentAction#update() | EditForm | HtmlResponse | 4 | 356 | 19 |
| 276 | /admin/relatedcontent/delete | # simple implementation for now html | AdminRelatedcontentAction#delete() | EditForm | HtmlResponse | 4 | 356 | 20 |
| 277 | /admin/relatedquery/ | # simple implementation for now html | AdminRelatedqueryAction#index() | HtmlResponse | 4 | 366 | 4 | |
| 278 | /admin/relatedquery/list/{pageNumber} | # simple implementation for now html | AdminRelatedqueryAction#list() | SearchForm | HtmlResponse | 4 | 366 | 11 |
| 279 | /admin/relatedquery/search | # simple implementation for now html | AdminRelatedqueryAction#search() | SearchForm | HtmlResponse | 4 | 366 | 7 |
| 280 | /admin/relatedquery/reset | # simple implementation for now html | AdminRelatedqueryAction#reset() | SearchForm | HtmlResponse | 4 | 366 | 7 |
| 281 | /admin/relatedquery/createnew | # simple implementation for now html | AdminRelatedqueryAction#createnew() | HtmlResponse | 4 | 366 | 10 | |
| 282 | /admin/relatedquery/edit | # simple implementation for now html | AdminRelatedqueryAction#edit() | EditForm | HtmlResponse | 4 | 366 | 23 |
| 283 | /admin/relatedquery/details/{crudMode}/{id} | # simple implementation for now html | AdminRelatedqueryAction#details() | HtmlResponse | 4 | 366 | 20 | |
| 284 | /admin/relatedquery/create | # simple implementation for now html | AdminRelatedqueryAction#create() | CreateForm | HtmlResponse | 4 | 366 | 19 |
| 285 | /admin/relatedquery/update | # simple implementation for now html | AdminRelatedqueryAction#update() | EditForm | HtmlResponse | 4 | 366 | 19 |
| 286 | /admin/relatedquery/delete | # simple implementation for now html | AdminRelatedqueryAction#delete() | EditForm | HtmlResponse | 4 | 366 | 20 |
| 287 | /admin/reqheader/ | # simple implementation for now html | AdminReqheaderAction#index() | SearchForm | HtmlResponse | 5 | 403 | 4 |
| 288 | /admin/reqheader/list/{pageNumber} | # simple implementation for now html | AdminReqheaderAction#list() | SearchForm | HtmlResponse | 5 | 403 | 11 |
| 289 | /admin/reqheader/search | # simple implementation for now html | AdminReqheaderAction#search() | SearchForm | HtmlResponse | 5 | 403 | 7 |
| 290 | /admin/reqheader/reset | # simple implementation for now html | AdminReqheaderAction#reset() | SearchForm | HtmlResponse | 5 | 403 | 7 |
| 291 | /admin/reqheader/createnew | # simple implementation for now html | AdminReqheaderAction#createnew() | HtmlResponse | 5 | 403 | 12 | |
| 292 | /admin/reqheader/edit | # simple implementation for now html | AdminReqheaderAction#edit() | EditForm | HtmlResponse | 5 | 403 | 18 |
| 293 | /admin/reqheader/details/{crudMode}/{id} | # simple implementation for now html | AdminReqheaderAction#details() | HtmlResponse | 5 | 403 | 17 | |
| 294 | /admin/reqheader/create | # simple implementation for now html | AdminReqheaderAction#create() | CreateForm | HtmlResponse | 5 | 403 | 19 |
| 295 | /admin/reqheader/update | # simple implementation for now html | AdminReqheaderAction#update() | EditForm | HtmlResponse | 5 | 403 | 19 |
| 296 | /admin/reqheader/delete | # simple implementation for now html | AdminReqheaderAction#delete() | EditForm | HtmlResponse | 5 | 403 | 20 |
| 297 | /admin/role/ | # simple implementation for now html | AdminRoleAction#index() | SearchForm | HtmlResponse | 4 | 302 | 4 |
| 298 | /admin/role/list/{pageNumber} | # simple implementation for now html | AdminRoleAction#list() | SearchForm | HtmlResponse | 4 | 302 | 11 |
| 299 | /admin/role/search | # simple implementation for now html | AdminRoleAction#search() | SearchForm | HtmlResponse | 4 | 302 | 7 |
| 300 | /admin/role/reset | # simple implementation for now html | AdminRoleAction#reset() | SearchForm | HtmlResponse | 4 | 302 | 7 |
| 301 | /admin/role/createnew | # simple implementation for now html | AdminRoleAction#createnew() | HtmlResponse | 4 | 302 | 10 | |
| 302 | /admin/role/details/{crudMode}/{id} | # simple implementation for now html | AdminRoleAction#details() | HtmlResponse | 4 | 302 | 17 | |
| 303 | /admin/role/create | # simple implementation for now html | AdminRoleAction#create() | CreateForm | HtmlResponse | 4 | 302 | 19 |
| 304 | /admin/role/delete | # simple implementation for now html | AdminRoleAction#delete() | EditForm | HtmlResponse | 4 | 302 | 19 |
| 305 | /admin/scheduler/ | # simple implementation for now html | AdminSchedulerAction#index() | SearchForm | HtmlResponse | 5 | 494 | 4 |
| 306 | /admin/scheduler/list/{pageNumber} | # simple implementation for now html | AdminSchedulerAction#list() | SearchForm | HtmlResponse | 5 | 494 | 11 |
| 307 | /admin/scheduler/search | # simple implementation for now html | AdminSchedulerAction#search() | SearchForm | HtmlResponse | 5 | 494 | 7 |
| 308 | /admin/scheduler/reset | # simple implementation for now html | AdminSchedulerAction#reset() | SearchForm | HtmlResponse | 5 | 494 | 7 |
| 309 | /admin/scheduler/createnewjob/{type}/{id}/{name} | # simple implementation for now html | AdminSchedulerAction#createnewjob() | HtmlResponse | 5 | 494 | 26 | |
| 310 | /admin/scheduler/createnew | # simple implementation for now html | AdminSchedulerAction#createnew() | HtmlResponse | 5 | 494 | 10 | |
| 311 | /admin/scheduler/edit | # simple implementation for now html | AdminSchedulerAction#edit() | EditForm | HtmlResponse | 5 | 494 | 18 |
| 312 | /admin/scheduler/details/{crudMode}/{id} | # simple implementation for now html | AdminSchedulerAction#details() | HtmlResponse | 5 | 494 | 21 | |
| 313 | /admin/scheduler/create | # simple implementation for now html | AdminSchedulerAction#create() | CreateForm | HtmlResponse | 5 | 494 | 19 |
| 314 | /admin/scheduler/update | # simple implementation for now html | AdminSchedulerAction#update() | EditForm | HtmlResponse | 5 | 494 | 19 |
| 315 | /admin/scheduler/delete | # simple implementation for now html | AdminSchedulerAction#delete() | EditForm | HtmlResponse | 5 | 494 | 20 |
| 316 | /admin/scheduler/start | # simple implementation for now html | AdminSchedulerAction#start() | EditForm | HtmlResponse | 5 | 494 | 28 |
| 317 | /admin/scheduler/stop | # simple implementation for now html | AdminSchedulerAction#stop() | EditForm | HtmlResponse | 5 | 494 | 23 |
| 318 | /admin/searchlist/ | # simple implementation for now html | AdminSearchlistAction#index() | ListForm | HtmlResponse | 17 | 35 | 6 |
| 319 | /admin/searchlist/search | # simple implementation for now html | AdminSearchlistAction#search() | ListForm | HtmlResponse | 17 | 35 | 5 |
| 320 | /admin/searchlist/prev | # simple implementation for now html | AdminSearchlistAction#prev() | ListForm | HtmlResponse | 17 | 35 | 5 |
| 321 | /admin/searchlist/next | # simple implementation for now html | AdminSearchlistAction#next() | ListForm | HtmlResponse | 17 | 35 | 5 |
| 322 | /admin/searchlist/move | # simple implementation for now html | AdminSearchlistAction#move() | ListForm | HtmlResponse | 17 | 35 | 5 |
| 323 | /admin/searchlist/delete | # simple implementation for now html | AdminSearchlistAction#delete() | DeleteForm | HtmlResponse | 17 | 35 | 15 |
| 324 | /admin/searchlist/deleteall | # simple implementation for now html | AdminSearchlistAction#deleteall() | ListForm | HtmlResponse | 17 | 35 | 15 |
| 325 | /admin/searchlist/createnew | # simple implementation for now html | AdminSearchlistAction#createnew() | CreateForm | HtmlResponse | 17 | 35 | 10 |
| 326 | /admin/searchlist/edit | # simple implementation for now html | AdminSearchlistAction#edit() | EditForm | HtmlResponse | 17 | 35 | 14 |
| 327 | /admin/searchlist/create | # simple implementation for now html | AdminSearchlistAction#create() | CreateForm | HtmlResponse | 17 | 35 | 26 |
| 328 | /admin/searchlist/update | # simple implementation for now html | AdminSearchlistAction#update() | EditForm | HtmlResponse | 17 | 35 | 35 |
| 329 | /admin/searchlog/ | # simple implementation for now html | AdminSearchlogAction#index() | HtmlResponse | 4 | 239 | 5 | |
| 330 | /admin/searchlog/list/{pageNumber} | # simple implementation for now html | AdminSearchlogAction#list() | SearchForm | HtmlResponse | 4 | 239 | 8 |
| 331 | /admin/searchlog/search | # simple implementation for now html | AdminSearchlogAction#search() | SearchForm | HtmlResponse | 4 | 239 | 10 |
| 332 | /admin/searchlog/reset | # simple implementation for now html | AdminSearchlogAction#reset() | SearchForm | HtmlResponse | 4 | 239 | 8 |
| 333 | /admin/searchlog/back | # simple implementation for now html | AdminSearchlogAction#back() | SearchForm | HtmlResponse | 4 | 239 | 7 |
| 334 | /admin/searchlog/details/{crudMode}/{logType}/{id} | # simple implementation for now html | AdminSearchlogAction#details() | HtmlResponse | 4 | 239 | 14 | |
| 335 | /admin/searchlog/delete | # simple implementation for now html | AdminSearchlogAction#delete() | EditForm | HtmlResponse | 4 | 239 | 11 |
| 336 | /admin/searchlog/deleteall | # simple implementation for now html | AdminSearchlogAction#deleteall() | HtmlResponse | 4 | 239 | 8 | |
| 337 | /admin/sereq/ | # simple implementation for now html | AdminSereqAction#index() | HtmlResponse | 2 | 152 | 4 | |
| 338 | /admin/sereq/upload | # simple implementation for now api | AdminSereqAction#upload() | UploadForm | ActionResponse | 2 | 152 | 56 |
| 339 | /admin/storage/ | # simple implementation for now html | AdminStorageAction#index() | HtmlResponse | 2 | 32 | 5 | |
| 340 | /admin/storage/list/{id} | # simple implementation for now api | AdminStorageAction#list() | ActionResponse | 2 | 32 | 5 | |
| 341 | /admin/storage/upload | # simple implementation for now html | AdminStorageAction#upload() | ItemForm | HtmlResponse | 2 | 32 | 18 |
| 342 | /admin/storage/download/{id} | # simple implementation for now api | AdminStorageAction#download() | ActionResponse | 2 | 32 | 24 | |
| 343 | /admin/storage/delete/{id} | # simple implementation for now html | AdminStorageAction#delete() | HtmlResponse | 2 | 32 | 17 | |
| 344 | /admin/storage/createDir | # simple implementation for now html | AdminStorageAction#createDir() | ItemForm | HtmlResponse | 2 | 32 | 8 |
| 345 | /admin/storage/editTags | # simple implementation for now html | AdminStorageAction#editTags() | TagForm | HtmlResponse | 2 | 32 | 6 |
| 346 | /admin/storage/updateTags | # simple implementation for now html | AdminStorageAction#updateTags() | TagForm | HtmlResponse | 2 | 32 | 14 |
| 347 | /admin/suggest/ | # simple implementation for now html | AdminSuggestAction#index() | HtmlResponse | 2 | 101 | 5 | |
| 348 | /admin/suggest/deleteAllWords | # simple implementation for now html | AdminSuggestAction#deleteAllWords() | HtmlResponse | 2 | 101 | 10 | |
| 349 | /admin/suggest/deleteDocumentWords | # simple implementation for now html | AdminSuggestAction#deleteDocumentWords() | HtmlResponse | 2 | 101 | 10 | |
| 350 | /admin/suggest/deleteQueryWords | # simple implementation for now html | AdminSuggestAction#deleteQueryWords() | HtmlResponse | 2 | 101 | 10 | |
| 351 | /admin/systeminfo/ | # simple implementation for now html | AdminSysteminfoAction#index() | HtmlResponse | 4 | 229 | 9 | |
| 352 | /admin/user/ | # simple implementation for now html | AdminUserAction#index() | HtmlResponse | 6 | 440 | 4 | |
| 353 | /admin/user/list/{pageNumber} | # simple implementation for now html | AdminUserAction#list() | SearchForm | HtmlResponse | 6 | 440 | 11 |
| 354 | /admin/user/search | # simple implementation for now html | AdminUserAction#search() | SearchForm | HtmlResponse | 6 | 440 | 7 |
| 355 | /admin/user/reset | # simple implementation for now html | AdminUserAction#reset() | SearchForm | HtmlResponse | 6 | 440 | 7 |
| 356 | /admin/user/createnew | # simple implementation for now html | AdminUserAction#createnew() | HtmlResponse | 6 | 440 | 12 | |
| 357 | /admin/user/edit | # simple implementation for now html | AdminUserAction#edit() | EditForm | HtmlResponse | 6 | 440 | 19 |
| 358 | /admin/user/details/{crudMode}/{id} | # simple implementation for now html | AdminUserAction#details() | HtmlResponse | 6 | 440 | 20 | |
| 359 | /admin/user/create | # simple implementation for now html | AdminUserAction#create() | CreateForm | HtmlResponse | 6 | 440 | 21 |
| 360 | /admin/user/update | # simple implementation for now html | AdminUserAction#update() | EditForm | HtmlResponse | 6 | 440 | 21 |
| 361 | /admin/user/delete | # simple implementation for now html | AdminUserAction#delete() | EditForm | HtmlResponse | 6 | 440 | 25 |
| 362 | /admin/webauth/ | # simple implementation for now html | AdminWebauthAction#index() | SearchForm | HtmlResponse | 5 | 429 | 4 |
| 363 | /admin/webauth/list/{pageNumber} | # simple implementation for now html | AdminWebauthAction#list() | SearchForm | HtmlResponse | 5 | 429 | 11 |
| 364 | /admin/webauth/search | # simple implementation for now html | AdminWebauthAction#search() | SearchForm | HtmlResponse | 5 | 429 | 7 |
| 365 | /admin/webauth/reset | # simple implementation for now html | AdminWebauthAction#reset() | SearchForm | HtmlResponse | 5 | 429 | 7 |
| 366 | /admin/webauth/createnew | # simple implementation for now html | AdminWebauthAction#createnew() | HtmlResponse | 5 | 429 | 13 | |
| 367 | /admin/webauth/edit | # simple implementation for now html | AdminWebauthAction#edit() | EditForm | HtmlResponse | 5 | 429 | 18 |
| 368 | /admin/webauth/details/{crudMode}/{id} | # simple implementation for now html | AdminWebauthAction#details() | HtmlResponse | 5 | 429 | 20 | |
| 369 | /admin/webauth/create | # simple implementation for now html | AdminWebauthAction#create() | CreateForm | HtmlResponse | 5 | 429 | 19 |
| 370 | /admin/webauth/update | # simple implementation for now html | AdminWebauthAction#update() | EditForm | HtmlResponse | 5 | 429 | 19 |
| 371 | /admin/webauth/delete | # simple implementation for now html | AdminWebauthAction#delete() | EditForm | HtmlResponse | 5 | 429 | 20 |
| 372 | /admin/webconfig/ | # simple implementation for now html | AdminWebconfigAction#index() | SearchForm | HtmlResponse | 7 | 431 | 4 |
| 373 | /admin/webconfig/list/{pageNumber} | # simple implementation for now html | AdminWebconfigAction#list() | SearchForm | HtmlResponse | 7 | 431 | 11 |
| 374 | /admin/webconfig/search | # simple implementation for now html | AdminWebconfigAction#search() | SearchForm | HtmlResponse | 7 | 431 | 7 |
| 375 | /admin/webconfig/reset | # simple implementation for now html | AdminWebconfigAction#reset() | SearchForm | HtmlResponse | 7 | 431 | 7 |
| 376 | /admin/webconfig/createnew | # simple implementation for now html | AdminWebconfigAction#createnew() | HtmlResponse | 7 | 431 | 25 | |
| 377 | /admin/webconfig/edit | # simple implementation for now html | AdminWebconfigAction#edit() | EditForm | HtmlResponse | 7 | 431 | 28 |
| 378 | /admin/webconfig/details/{crudMode}/{id} | # simple implementation for now html | AdminWebconfigAction#details() | HtmlResponse | 7 | 431 | 25 | |
| 379 | /admin/webconfig/create | # simple implementation for now html | AdminWebconfigAction#create() | CreateForm | HtmlResponse | 7 | 431 | 19 |
| 380 | /admin/webconfig/update | # simple implementation for now html | AdminWebconfigAction#update() | EditForm | HtmlResponse | 7 | 431 | 19 |
| 381 | /admin/webconfig/delete | # simple implementation for now html | AdminWebconfigAction#delete() | EditForm | HtmlResponse | 7 | 431 | 20 |
| 382 | /admin/wizard/ | # simple implementation for now html | AdminWizardAction#index() | HtmlResponse | 7 | 349 | 4 | |
| 383 | /admin/wizard/crawlingConfigForm | # simple implementation for now html | AdminWizardAction#crawlingConfigForm() | HtmlResponse | 7 | 349 | 5 | |
| 384 | /admin/wizard/crawlingConfig | # simple implementation for now html | AdminWizardAction#crawlingConfig() | CrawlingConfigForm | HtmlResponse | 7 | 349 | 8 |
| 385 | /admin/wizard/crawlingConfigNext | # simple implementation for now html | AdminWizardAction#crawlingConfigNext() | CrawlingConfigForm | HtmlResponse | 7 | 349 | 8 |
| 386 | /admin/wizard/startCrawlingForm | # simple implementation for now html | AdminWizardAction#startCrawlingForm() | HtmlResponse | 7 | 349 | 5 | |
| 387 | /admin/wizard/startCrawling | # simple implementation for now html | AdminWizardAction#startCrawling() | StartCrawlingForm | HtmlResponse | 7 | 349 | 17 |
| 388 | /api/admin/accesstoken/settings | # simple implementation for now api | ApiAdminAccesstokenAction#settings() | SearchBody | JsonResponse<ApiResult> | 1 | 149 | 9 |
| 389 | /api/admin/accesstoken/setting/{id} | # simple implementation for now api | ApiAdminAccesstokenAction#get$setting() | JsonResponse<ApiResult> | 1 | 149 | 6 | |
| 390 | /api/admin/accesstoken/setting | # simple implementation for now api | ApiAdminAccesstokenAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 1 | 149 | 18 |
| 391 | /api/admin/accesstoken/setting | # simple implementation for now api | ApiAdminAccesstokenAction#put$setting() | EditBody | JsonResponse<ApiResult> | 1 | 149 | 17 |
| 392 | /api/admin/accesstoken/setting/{id} | # simple implementation for now api | ApiAdminAccesstokenAction#delete$setting() | JsonResponse<ApiResult> | 1 | 149 | 14 | |
| 393 | /api/admin/backup/files | # simple implementation for now api | ApiAdminBackupAction#files() | JsonResponse<ApiResult> | 0 | 102 | 4 | |
| 394 | /api/admin/backup/file/{id} | # simple implementation for now stream | ApiAdminBackupAction#get$file() | StreamResponse | 0 | 102 | 58 | |
| 395 | /api/admin/badword/settings | # simple implementation for now api | ApiAdminBadwordAction#settings() | SearchBody | JsonResponse<ApiResult> | 3 | 208 | 10 |
| 396 | /api/admin/badword/setting/{id} | # simple implementation for now api | ApiAdminBadwordAction#get$setting() | JsonResponse<ApiResult> | 3 | 208 | 10 | |
| 397 | /api/admin/badword/setting | # simple implementation for now api | ApiAdminBadwordAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 3 | 208 | 18 |
| 398 | /api/admin/badword/setting | # simple implementation for now api | ApiAdminBadwordAction#put$setting() | EditBody | JsonResponse<ApiResult> | 3 | 208 | 19 |
| 399 | /api/admin/badword/setting/{id} | # simple implementation for now api | ApiAdminBadwordAction#delete$setting() | JsonResponse<ApiResult> | 3 | 208 | 20 | |
| 400 | /api/admin/badword/upload | # simple implementation for now api | ApiAdminBadwordAction#put$upload() | UploadForm | JsonResponse<ApiResult> | 3 | 208 | 12 |
| 401 | /api/admin/badword/download | # simple implementation for now stream | ApiAdminBadwordAction#get$download() | DownloadBody | StreamResponse | 3 | 208 | 19 |
| 402 | /api/admin/boostdoc/settings | # simple implementation for now api | ApiAdminBoostdocAction#settings() | SearchBody | JsonResponse<ApiResult> | 2 | 145 | 9 |
| 403 | /api/admin/boostdoc/setting/{id} | # simple implementation for now api | ApiAdminBoostdocAction#get$setting() | JsonResponse<ApiResult> | 2 | 145 | 9 | |
| 404 | /api/admin/boostdoc/setting | # simple implementation for now api | ApiAdminBoostdocAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 145 | 17 |
| 405 | /api/admin/boostdoc/setting | # simple implementation for now api | ApiAdminBoostdocAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 145 | 17 |
| 406 | /api/admin/boostdoc/setting/{id} | # simple implementation for now api | ApiAdminBoostdocAction#delete$setting() | JsonResponse<ApiResult> | 2 | 145 | 14 | |
| 407 | /api/admin/crawlinginfo/logs | # simple implementation for now api | ApiAdminCrawlinginfoAction#logs() | SearchBody | JsonResponse<ApiResult> | 3 | 113 | 9 |
| 408 | /api/admin/crawlinginfo/log/{id} | # simple implementation for now api | ApiAdminCrawlinginfoAction#get$log() | JsonResponse<ApiResult> | 3 | 113 | 6 | |
| 409 | /api/admin/crawlinginfo/log/{id} | # simple implementation for now api | ApiAdminCrawlinginfoAction#delete$log() | JsonResponse<ApiResult> | 3 | 113 | 14 | |
| 410 | /api/admin/crawlinginfo/all | # simple implementation for now api | ApiAdminCrawlinginfoAction#delete$all() | JsonResponse<ApiResult> | 3 | 113 | 10 | |
| 411 | /api/admin/dataconfig/settings | # simple implementation for now api | ApiAdminDataconfigAction#settings() | SearchBody | JsonResponse<ApiResult> | 2 | 154 | 10 |
| 412 | /api/admin/dataconfig/setting/{id} | # simple implementation for now api | ApiAdminDataconfigAction#get$setting() | JsonResponse<ApiResult> | 2 | 154 | 6 | |
| 413 | /api/admin/dataconfig/setting | # simple implementation for now api | ApiAdminDataconfigAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 154 | 18 |
| 414 | /api/admin/dataconfig/setting | # simple implementation for now api | ApiAdminDataconfigAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 154 | 17 |
| 415 | /api/admin/dataconfig/setting/{id} | # simple implementation for now api | ApiAdminDataconfigAction#delete$setting() | JsonResponse<ApiResult> | 2 | 154 | 14 | |
| 416 | /api/admin/dict/ | # simple implementation for now api | ApiAdminDictAction#get$index() | JsonResponse<ApiResult> | 1 | 42 | 7 | |
| 417 | /api/admin/dict/kuromoji/settings/{dictId} | # simple implementation for now api | ApiAdminDictKuromojiAction#get$settings() | SearchBody | JsonResponse<ApiResult> | 2 | 185 | 9 |
| 418 | /api/admin/dict/kuromoji/setting/{dictId}/{id} | # simple implementation for now api | ApiAdminDictKuromojiAction#get$setting() | JsonResponse<ApiResult> | 2 | 185 | 9 | |
| 419 | /api/admin/dict/kuromoji/setting/{dictId} | # simple implementation for now api | ApiAdminDictKuromojiAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 185 | 15 |
| 420 | /api/admin/dict/kuromoji/setting/{dictId} | # simple implementation for now api | ApiAdminDictKuromojiAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 185 | 15 |
| 421 | /api/admin/dict/kuromoji/setting/{dictId}/{id} | # simple implementation for now api | ApiAdminDictKuromojiAction#delete$setting() | JsonResponse<ApiResult> | 2 | 185 | 9 | |
| 422 | /api/admin/dict/kuromoji/upload/{dictId} | # simple implementation for now api | ApiAdminDictKuromojiAction#put$upload() | UploadForm | JsonResponse<ApiResult> | 2 | 185 | 15 |
| 423 | /api/admin/dict/kuromoji/download/{dictId} | # simple implementation for now stream | ApiAdminDictKuromojiAction#get$download() | DownloadBody | StreamResponse | 2 | 185 | 12 |
| 424 | /api/admin/dict/mapping/settings/{dictId} | # simple implementation for now api | ApiAdminDictMappingAction#get$settings() | SearchBody | JsonResponse<ApiResult> | 2 | 183 | 9 |
| 425 | /api/admin/dict/mapping/setting/{dictId}/{id} | # simple implementation for now api | ApiAdminDictMappingAction#get$setting() | JsonResponse<ApiResult> | 2 | 183 | 9 | |
| 426 | /api/admin/dict/mapping/setting/{dictId} | # simple implementation for now api | ApiAdminDictMappingAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 183 | 15 |
| 427 | /api/admin/dict/mapping/setting/{dictId} | # simple implementation for now api | ApiAdminDictMappingAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 183 | 15 |
| 428 | /api/admin/dict/mapping/setting/{dictId}/{id} | # simple implementation for now api | ApiAdminDictMappingAction#delete$setting() | JsonResponse<ApiResult> | 2 | 183 | 9 | |
| 429 | /api/admin/dict/mapping/upload/{dictId} | # simple implementation for now api | ApiAdminDictMappingAction#put$upload() | UploadForm | JsonResponse<ApiResult> | 2 | 183 | 15 |
| 430 | /api/admin/dict/mapping/download/{dictId} | # simple implementation for now stream | ApiAdminDictMappingAction#get$download() | DownloadBody | StreamResponse | 2 | 183 | 12 |
| 431 | /api/admin/dict/protwords/settings/{dictId} | # simple implementation for now api | ApiAdminDictProtwordsAction#get$settings() | SearchBody | JsonResponse<ApiResult> | 2 | 182 | 9 |
| 432 | /api/admin/dict/protwords/setting/{dictId}/{id} | # simple implementation for now api | ApiAdminDictProtwordsAction#get$setting() | JsonResponse<ApiResult> | 2 | 182 | 9 | |
| 433 | /api/admin/dict/protwords/setting/{dictId} | # simple implementation for now api | ApiAdminDictProtwordsAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 182 | 15 |
| 434 | /api/admin/dict/protwords/setting/{dictId} | # simple implementation for now api | ApiAdminDictProtwordsAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 182 | 15 |
| 435 | /api/admin/dict/protwords/setting/{dictId}/{id} | # simple implementation for now api | ApiAdminDictProtwordsAction#delete$setting() | JsonResponse<ApiResult> | 2 | 182 | 9 | |
| 436 | /api/admin/dict/protwords/upload/{dictId} | # simple implementation for now api | ApiAdminDictProtwordsAction#put$upload() | UploadForm | JsonResponse<ApiResult> | 2 | 182 | 15 |
| 437 | /api/admin/dict/protwords/download/{dictId} | # simple implementation for now stream | ApiAdminDictProtwordsAction#get$download() | DownloadBody | StreamResponse | 2 | 182 | 12 |
| 438 | /api/admin/dict/stemmeroverride/settings/{dictId} | # simple implementation for now api | ApiAdminDictStemmeroverrideAction#get$settings() | SearchBody | JsonResponse<ApiResult> | 2 | 182 | 10 |
| 439 | /api/admin/dict/stemmeroverride/setting/{dictId}/{id} | # simple implementation for now api | ApiAdminDictStemmeroverrideAction#get$setting() | JsonResponse<ApiResult> | 2 | 182 | 7 | |
| 440 | /api/admin/dict/stemmeroverride/setting/{dictId} | # simple implementation for now api | ApiAdminDictStemmeroverrideAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 182 | 15 |
| 441 | /api/admin/dict/stemmeroverride/setting/{dictId} | # simple implementation for now api | ApiAdminDictStemmeroverrideAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 182 | 15 |
| 442 | /api/admin/dict/stemmeroverride/setting/{dictId}/{id} | # simple implementation for now api | ApiAdminDictStemmeroverrideAction#delete$setting() | JsonResponse<ApiResult> | 2 | 182 | 9 | |
| 443 | /api/admin/dict/stemmeroverride/upload/{dictId} | # simple implementation for now api | ApiAdminDictStemmeroverrideAction#put$upload() | UploadForm | JsonResponse<ApiResult> | 2 | 182 | 15 |
| 444 | /api/admin/dict/stemmeroverride/download/{dictId} | # simple implementation for now stream | ApiAdminDictStemmeroverrideAction#get$download() | DownloadBody | StreamResponse | 2 | 182 | 12 |
| 445 | /api/admin/dict/stopwords/settings/{dictId} | # simple implementation for now api | ApiAdminDictStopwordsAction#get$settings() | SearchBody | JsonResponse<ApiResult> | 2 | 182 | 9 |
| 446 | /api/admin/dict/stopwords/setting/{dictId}/{id} | # simple implementation for now api | ApiAdminDictStopwordsAction#get$setting() | JsonResponse<ApiResult> | 2 | 182 | 9 | |
| 447 | /api/admin/dict/stopwords/setting/{dictId} | # simple implementation for now api | ApiAdminDictStopwordsAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 182 | 15 |
| 448 | /api/admin/dict/stopwords/setting/{dictId} | # simple implementation for now api | ApiAdminDictStopwordsAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 182 | 15 |
| 449 | /api/admin/dict/stopwords/setting/{dictId}/{id} | # simple implementation for now api | ApiAdminDictStopwordsAction#delete$setting() | JsonResponse<ApiResult> | 2 | 182 | 9 | |
| 450 | /api/admin/dict/stopwords/upload/{dictId} | # simple implementation for now api | ApiAdminDictStopwordsAction#put$upload() | UploadForm | JsonResponse<ApiResult> | 2 | 182 | 15 |
| 451 | /api/admin/dict/stopwords/download/{dictId} | # simple implementation for now stream | ApiAdminDictStopwordsAction#get$download() | DownloadBody | StreamResponse | 2 | 182 | 12 |
| 452 | /api/admin/dict/synonym/settings/{dictId} | # simple implementation for now api | ApiAdminDictSynonymAction#get$settings() | SearchBody | JsonResponse<ApiResult> | 2 | 183 | 9 |
| 453 | /api/admin/dict/synonym/setting/{dictId}/{id} | # simple implementation for now api | ApiAdminDictSynonymAction#get$setting() | JsonResponse<ApiResult> | 2 | 183 | 9 | |
| 454 | /api/admin/dict/synonym/setting/{dictId} | # simple implementation for now api | ApiAdminDictSynonymAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 183 | 15 |
| 455 | /api/admin/dict/synonym/setting/{dictId} | # simple implementation for now api | ApiAdminDictSynonymAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 183 | 15 |
| 456 | /api/admin/dict/synonym/setting/{dictId}/{id} | # simple implementation for now api | ApiAdminDictSynonymAction#delete$setting() | JsonResponse<ApiResult> | 2 | 183 | 9 | |
| 457 | /api/admin/dict/synonym/upload/{dictId} | # simple implementation for now api | ApiAdminDictSynonymAction#put$upload() | UploadForm | JsonResponse<ApiResult> | 2 | 183 | 15 |
| 458 | /api/admin/dict/synonym/download/{dictId} | # simple implementation for now stream | ApiAdminDictSynonymAction#get$download() | DownloadBody | StreamResponse | 2 | 183 | 12 |
| 459 | /api/admin/documents/bulk | # simple implementation for now api | ApiAdminDocumentsAction#put$bulk() | BulkBody | JsonResponse<ApiResult> | 2 | 136 | 97 |
| 460 | /api/admin/duplicatehost/settings | # simple implementation for now api | ApiAdminDuplicatehostAction#settings() | SearchBody | JsonResponse<ApiResult> | 2 | 151 | 10 |
| 461 | /api/admin/duplicatehost/setting/{id} | # simple implementation for now api | ApiAdminDuplicatehostAction#get$setting() | JsonResponse<ApiResult> | 2 | 151 | 6 | |
| 462 | /api/admin/duplicatehost/setting | # simple implementation for now api | ApiAdminDuplicatehostAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 151 | 18 |
| 463 | /api/admin/duplicatehost/setting | # simple implementation for now api | ApiAdminDuplicatehostAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 151 | 17 |
| 464 | /api/admin/duplicatehost/setting/{id} | # simple implementation for now api | ApiAdminDuplicatehostAction#delete$setting() | JsonResponse<ApiResult> | 2 | 151 | 14 | |
| 465 | /api/admin/elevateword/settings | # simple implementation for now api | ApiAdminElevatewordAction#settings() | SearchBody | JsonResponse<ApiResult> | 3 | 242 | 10 |
| 466 | /api/admin/elevateword/setting/{id} | # simple implementation for now api | ApiAdminElevatewordAction#get$setting() | JsonResponse<ApiResult> | 3 | 242 | 15 | |
| 467 | /api/admin/elevateword/setting | # simple implementation for now api | ApiAdminElevatewordAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 3 | 242 | 19 |
| 468 | /api/admin/elevateword/setting | # simple implementation for now api | ApiAdminElevatewordAction#put$setting() | EditBody | JsonResponse<ApiResult> | 3 | 242 | 20 |
| 469 | /api/admin/elevateword/setting/{id} | # simple implementation for now api | ApiAdminElevatewordAction#delete$setting() | JsonResponse<ApiResult> | 3 | 242 | 20 | |
| 470 | /api/admin/elevateword/upload | # simple implementation for now api | ApiAdminElevatewordAction#put$upload() | UploadForm | JsonResponse<ApiResult> | 3 | 242 | 12 |
| 471 | /api/admin/elevateword/download | # simple implementation for now stream | ApiAdminElevatewordAction#get$download() | DownloadBody | StreamResponse | 3 | 242 | 19 |
| 472 | /api/admin/failureurl/logs | # simple implementation for now api | ApiAdminFailureurlAction#logs() | SearchBody | JsonResponse<ApiResult> | 4 | 118 | 9 |
| 473 | /api/admin/failureurl/log/{id} | # simple implementation for now api | ApiAdminFailureurlAction#get$log() | JsonResponse<ApiResult> | 4 | 118 | 6 | |
| 474 | /api/admin/failureurl/log/{id} | # simple implementation for now api | ApiAdminFailureurlAction#delete$log() | JsonResponse<ApiResult> | 4 | 118 | 14 | |
| 475 | /api/admin/failureurl/all | # simple implementation for now api | ApiAdminFailureurlAction#delete$all() | JsonResponse<ApiResult> | 4 | 118 | 11 | |
| 476 | /api/admin/fileauth/settings | # simple implementation for now api | ApiAdminFileauthAction#settings() | SearchBody | JsonResponse<ApiResult> | 3 | 168 | 10 |
| 477 | /api/admin/fileauth/setting/{id} | # simple implementation for now api | ApiAdminFileauthAction#get$setting() | JsonResponse<ApiResult> | 3 | 168 | 6 | |
| 478 | /api/admin/fileauth/setting | # simple implementation for now api | ApiAdminFileauthAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 3 | 168 | 22 |
| 479 | /api/admin/fileauth/setting | # simple implementation for now api | ApiAdminFileauthAction#put$setting() | EditBody | JsonResponse<ApiResult> | 3 | 168 | 17 |
| 480 | /api/admin/fileauth/setting/{id} | # simple implementation for now api | ApiAdminFileauthAction#delete$setting() | JsonResponse<ApiResult> | 3 | 168 | 14 | |
| 481 | /api/admin/fileconfig/settings | # simple implementation for now api | ApiAdminFileconfigAction#settings() | SearchBody | JsonResponse<ApiResult> | 2 | 159 | 10 |
| 482 | /api/admin/fileconfig/setting/{id} | # simple implementation for now api | ApiAdminFileconfigAction#get$setting() | JsonResponse<ApiResult> | 2 | 159 | 6 | |
| 483 | /api/admin/fileconfig/setting | # simple implementation for now api | ApiAdminFileconfigAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 159 | 18 |
| 484 | /api/admin/fileconfig/setting | # simple implementation for now api | ApiAdminFileconfigAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 159 | 17 |
| 485 | /api/admin/fileconfig/setting/{id} | # simple implementation for now api | ApiAdminFileconfigAction#delete$setting() | JsonResponse<ApiResult> | 2 | 159 | 14 | |
| 486 | /api/admin/general/ | # simple implementation for now api | ApiAdminGeneralAction#get$index() | JsonResponse<ApiResult> | 1 | 55 | 6 | |
| 487 | /api/admin/general/ | # simple implementation for now api | ApiAdminGeneralAction#put$index() | EditBody | JsonResponse<ApiResult> | 1 | 55 | 8 |
| 488 | /api/admin/group/settings | # simple implementation for now api | ApiAdminGroupAction#settings() | SearchBody | JsonResponse<ApiResult> | 2 | 154 | 10 |
| 489 | /api/admin/group/setting/{id} | # simple implementation for now api | ApiAdminGroupAction#get$setting() | JsonResponse<ApiResult> | 2 | 154 | 6 | |
| 490 | /api/admin/group/setting | # simple implementation for now api | ApiAdminGroupAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 154 | 19 |
| 491 | /api/admin/group/setting | # simple implementation for now api | ApiAdminGroupAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 154 | 17 |
| 492 | /api/admin/group/setting/{id} | # simple implementation for now api | ApiAdminGroupAction#delete$setting() | JsonResponse<ApiResult> | 2 | 154 | 19 | |
| 493 | /api/admin/joblog/logs | # simple implementation for now api | ApiAdminJoblogAction#logs() | SearchBody | JsonResponse<ApiResult> | 2 | 97 | 9 |
| 494 | /api/admin/joblog/log/{id} | # simple implementation for now api | ApiAdminJoblogAction#get$log() | JsonResponse<ApiResult> | 2 | 97 | 6 | |
| 495 | /api/admin/joblog/log/{id} | # simple implementation for now api | ApiAdminJoblogAction#delete$log() | JsonResponse<ApiResult> | 2 | 97 | 14 | |
| 496 | /api/admin/keymatch/settings | # simple implementation for now api | ApiAdminKeymatchAction#settings() | SearchBody | JsonResponse<ApiResult> | 2 | 150 | 10 |
| 497 | /api/admin/keymatch/setting/{id} | # simple implementation for now api | ApiAdminKeymatchAction#get$setting() | JsonResponse<ApiResult> | 2 | 150 | 6 | |
| 498 | /api/admin/keymatch/setting | # simple implementation for now api | ApiAdminKeymatchAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 150 | 18 |
| 499 | /api/admin/keymatch/setting | # simple implementation for now api | ApiAdminKeymatchAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 150 | 17 |
| 500 | /api/admin/keymatch/setting/{id} | # simple implementation for now api | ApiAdminKeymatchAction#delete$setting() | JsonResponse<ApiResult> | 2 | 150 | 14 | |
| 501 | /api/admin/labeltype/settings | # simple implementation for now api | ApiAdminLabeltypeAction#settings() | SearchBody | JsonResponse<ApiResult> | 2 | 156 | 10 |
| 502 | /api/admin/labeltype/setting/{id} | # simple implementation for now api | ApiAdminLabeltypeAction#get$setting() | JsonResponse<ApiResult> | 2 | 156 | 6 | |
| 503 | /api/admin/labeltype/setting | # simple implementation for now api | ApiAdminLabeltypeAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 156 | 18 |
| 504 | /api/admin/labeltype/setting | # simple implementation for now api | ApiAdminLabeltypeAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 156 | 17 |
| 505 | /api/admin/labeltype/setting/{id} | # simple implementation for now api | ApiAdminLabeltypeAction#delete$setting() | JsonResponse<ApiResult> | 2 | 156 | 14 | |
| 506 | /api/admin/log/files | # simple implementation for now api | ApiAdminLogAction#files() | JsonResponse<ApiResult> | 0 | 49 | 4 | |
| 507 | /api/admin/log/file/{id} | # simple implementation for now stream | ApiAdminLogAction#get$file() | StreamResponse | 0 | 49 | 13 | |
| 508 | /api/admin/pathmap/settings | # simple implementation for now api | ApiAdminPathmapAction#settings() | SearchBody | JsonResponse<ApiResult> | 2 | 146 | 10 |
| 509 | /api/admin/pathmap/setting/{id} | # simple implementation for now api | ApiAdminPathmapAction#get$setting() | JsonResponse<ApiResult> | 2 | 146 | 7 | |
| 510 | /api/admin/pathmap/setting | # simple implementation for now api | ApiAdminPathmapAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 146 | 18 |
| 511 | /api/admin/pathmap/setting | # simple implementation for now api | ApiAdminPathmapAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 146 | 17 |
| 512 | /api/admin/pathmap/setting/{id} | # simple implementation for now api | ApiAdminPathmapAction#delete$setting() | JsonResponse<ApiResult> | 2 | 146 | 14 | |
| 513 | /api/admin/plugin/installed | # simple implementation for now api | ApiAdminPluginAction#get$installed() | JsonResponse<ApiResult> | 0 | 73 | 4 | |
| 514 | /api/admin/plugin/available | # simple implementation for now api | ApiAdminPluginAction#get$available() | JsonResponse<ApiResult> | 0 | 73 | 4 | |
| 515 | /api/admin/plugin/ | # simple implementation for now api | ApiAdminPluginAction#post$index() | InstallBody | JsonResponse<ApiResult> | 0 | 73 | 10 |
| 516 | /api/admin/plugin/ | # simple implementation for now api | ApiAdminPluginAction#delete$index() | DeleteBody | JsonResponse<ApiResult> | 0 | 73 | 5 |
| 517 | /api/admin/relatedcontent/settings | # simple implementation for now api | ApiAdminRelatedcontentAction#settings() | SearchBody | JsonResponse<ApiResult> | 2 | 151 | 10 |
| 518 | /api/admin/relatedcontent/setting/{id} | # simple implementation for now api | ApiAdminRelatedcontentAction#get$setting() | JsonResponse<ApiResult> | 2 | 151 | 7 | |
| 519 | /api/admin/relatedcontent/setting | # simple implementation for now api | ApiAdminRelatedcontentAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 151 | 18 |
| 520 | /api/admin/relatedcontent/setting | # simple implementation for now api | ApiAdminRelatedcontentAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 151 | 17 |
| 521 | /api/admin/relatedcontent/setting/{id} | # simple implementation for now api | ApiAdminRelatedcontentAction#delete$setting() | JsonResponse<ApiResult> | 2 | 151 | 14 | |
| 522 | /api/admin/relatedquery/settings | # simple implementation for now api | ApiAdminRelatedqueryAction#settings() | SearchBody | JsonResponse<ApiResult> | 2 | 152 | 10 |
| 523 | /api/admin/relatedquery/setting/{id} | # simple implementation for now api | ApiAdminRelatedqueryAction#get$setting() | JsonResponse<ApiResult> | 2 | 152 | 6 | |
| 524 | /api/admin/relatedquery/setting | # simple implementation for now api | ApiAdminRelatedqueryAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 152 | 18 |
| 525 | /api/admin/relatedquery/setting | # simple implementation for now api | ApiAdminRelatedqueryAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 152 | 17 |
| 526 | /api/admin/relatedquery/setting/{id} | # simple implementation for now api | ApiAdminRelatedqueryAction#delete$setting() | JsonResponse<ApiResult> | 2 | 152 | 14 | |
| 527 | /api/admin/reqheader/settings | # simple implementation for now api | ApiAdminReqheaderAction#settings() | SearchBody | JsonResponse<ApiResult> | 3 | 171 | 10 |
| 528 | /api/admin/reqheader/setting/{id} | # simple implementation for now api | ApiAdminReqheaderAction#get$setting() | JsonResponse<ApiResult> | 3 | 171 | 6 | |
| 529 | /api/admin/reqheader/setting | # simple implementation for now api | ApiAdminReqheaderAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 3 | 171 | 22 |
| 530 | /api/admin/reqheader/setting | # simple implementation for now api | ApiAdminReqheaderAction#put$setting() | EditBody | JsonResponse<ApiResult> | 3 | 171 | 17 |
| 531 | /api/admin/reqheader/setting/{id} | # simple implementation for now api | ApiAdminReqheaderAction#delete$setting() | JsonResponse<ApiResult> | 3 | 171 | 14 | |
| 532 | /api/admin/role/settings | # simple implementation for now api | ApiAdminRoleAction#settings() | SearchBody | JsonResponse<ApiResult> | 2 | 145 | 10 |
| 533 | /api/admin/role/setting/{id} | # simple implementation for now api | ApiAdminRoleAction#get$setting() | JsonResponse<ApiResult> | 2 | 145 | 6 | |
| 534 | /api/admin/role/setting | # simple implementation for now api | ApiAdminRoleAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 145 | 17 |
| 535 | /api/admin/role/setting | # simple implementation for now api | ApiAdminRoleAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 145 | 17 |
| 536 | /api/admin/role/setting/{id} | # simple implementation for now api | ApiAdminRoleAction#delete$setting() | JsonResponse<ApiResult> | 2 | 145 | 13 | |
| 537 | /api/admin/scheduler/ | # simple implementation for now html | ApiAdminSchedulerAction#index() | HtmlResponse | 2 | 216 | 3 | |
| 538 | /api/admin/scheduler/{id}/start | # simple implementation for now api | ApiAdminSchedulerAction#put$start() | JsonResponse<ApiResult> | 2 | 216 | 21 | |
| 539 | /api/admin/scheduler/{id}/stop | # simple implementation for now api | ApiAdminSchedulerAction#put$stop() | JsonResponse<ApiResult> | 2 | 216 | 17 | |
| 540 | /api/admin/scheduler/settings | # simple implementation for now api | ApiAdminSchedulerAction#settings() | SearchBody | JsonResponse<ApiResult> | 2 | 216 | 10 |
| 541 | /api/admin/scheduler/setting/{id} | # simple implementation for now api | ApiAdminSchedulerAction#get$setting() | JsonResponse<ApiResult> | 2 | 216 | 9 | |
| 542 | /api/admin/scheduler/setting | # simple implementation for now api | ApiAdminSchedulerAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 216 | 18 |
| 543 | /api/admin/scheduler/setting | # simple implementation for now api | ApiAdminSchedulerAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 216 | 17 |
| 544 | /api/admin/scheduler/setting/{id} | # simple implementation for now api | ApiAdminSchedulerAction#delete$setting() | JsonResponse<ApiResult> | 2 | 216 | 14 | |
| 545 | /api/admin/searchlist/docs | # simple implementation for now api | ApiAdminSearchlistAction#docs() | SearchBody | JsonResponse<ApiResult> | 3 | 230 | 28 |
| 546 | /api/admin/searchlist/doc/{id} | # simple implementation for now api | ApiAdminSearchlistAction#get$doc() | JsonResponse<ApiResult> | 3 | 230 | 9 | |
| 547 | /api/admin/searchlist/doc | # simple implementation for now api | ApiAdminSearchlistAction#post$doc() | CreateBody | JsonResponse<ApiResult> | 3 | 230 | 29 |
| 548 | /api/admin/searchlist/doc | # simple implementation for now api | ApiAdminSearchlistAction#put$doc() | EditBody | JsonResponse<ApiResult> | 3 | 230 | 38 |
| 549 | /api/admin/searchlist/doc/{id} | # simple implementation for now api | ApiAdminSearchlistAction#delete$doc() | JsonResponse<ApiResult> | 3 | 230 | 11 | |
| 550 | /api/admin/searchlist/query | # simple implementation for now api | ApiAdminSearchlistAction#delete$query() | SearchBody | JsonResponse<ApiResult> | 3 | 230 | 24 |
| 551 | /api/admin/stats/ | # simple implementation for now api | ApiAdminStatsAction#index() | JsonResponse<ApiResult> | 0 | 10 | 9 | |
| 552 | /api/admin/storage/list/{id} | # simple implementation for now api | ApiAdminStorageAction#list() | JsonResponse<ApiResult> | 1 | 111 | 13 | |
| 553 | /api/admin/storage/download/{id} | # simple implementation for now stream | ApiAdminStorageAction#get$download() | StreamResponse | 1 | 111 | 14 | |
| 554 | /api/admin/storage/delete/{id} | # simple implementation for now api | ApiAdminStorageAction#delete$delete() | JsonResponse<ApiResult> | 1 | 111 | 16 | |
| 555 | /api/admin/storage/upload | # simple implementation for now api | ApiAdminStorageAction#put$upload() | UploadForm | JsonResponse<ApiResult> | 1 | 111 | 16 |
| 556 | /api/admin/suggest/ | # simple implementation for now api | ApiAdminSuggestAction#get$index() | JsonResponse<ApiResult> | 1 | 75 | 7 | |
| 557 | /api/admin/suggest/all | # simple implementation for now api | ApiAdminSuggestAction#delete$all() | JsonResponse<ApiResult> | 1 | 75 | 6 | |
| 558 | /api/admin/suggest/document | # simple implementation for now api | ApiAdminSuggestAction#delete$document() | JsonResponse<ApiResult> | 1 | 75 | 6 | |
| 559 | /api/admin/suggest/query | # simple implementation for now api | ApiAdminSuggestAction#delete$query() | JsonResponse<ApiResult> | 1 | 75 | 6 | |
| 560 | /api/admin/systeminfo/ | # simple implementation for now api | ApiAdminSysteminfoAction#get$index() | JsonResponse<ApiResult> | 0 | 36 | 12 | |
| 561 | /api/admin/user/settings | # simple implementation for now api | ApiAdminUserAction#settings() | SearchBody | JsonResponse<ApiResult> | 2 | 155 | 10 |
| 562 | /api/admin/user/setting/{id} | # simple implementation for now api | ApiAdminUserAction#get$setting() | JsonResponse<ApiResult> | 2 | 155 | 6 | |
| 563 | /api/admin/user/setting | # simple implementation for now api | ApiAdminUserAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 155 | 18 |
| 564 | /api/admin/user/setting | # simple implementation for now api | ApiAdminUserAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 155 | 18 |
| 565 | /api/admin/user/setting/{id} | # simple implementation for now api | ApiAdminUserAction#delete$setting() | JsonResponse<ApiResult> | 2 | 155 | 19 | |
| 566 | /api/admin/webauth/settings | # simple implementation for now api | ApiAdminWebauthAction#settings() | SearchBody | JsonResponse<ApiResult> | 3 | 171 | 10 |
| 567 | /api/admin/webauth/setting/{id} | # simple implementation for now api | ApiAdminWebauthAction#get$setting() | JsonResponse<ApiResult> | 3 | 171 | 6 | |
| 568 | /api/admin/webauth/setting | # simple implementation for now api | ApiAdminWebauthAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 3 | 171 | 22 |
| 569 | /api/admin/webauth/setting | # simple implementation for now api | ApiAdminWebauthAction#put$setting() | EditBody | JsonResponse<ApiResult> | 3 | 171 | 17 |
| 570 | /api/admin/webauth/setting/{id} | # simple implementation for now api | ApiAdminWebauthAction#delete$setting() | JsonResponse<ApiResult> | 3 | 171 | 14 | |
| 571 | /api/admin/webconfig/settings | # simple implementation for now api | ApiAdminWebconfigAction#settings() | SearchBody | JsonResponse<ApiResult> | 2 | 158 | 10 |
| 572 | /api/admin/webconfig/setting/{id} | # simple implementation for now api | ApiAdminWebconfigAction#get$setting() | JsonResponse<ApiResult> | 2 | 158 | 6 | |
| 573 | /api/admin/webconfig/setting | # simple implementation for now api | ApiAdminWebconfigAction#post$setting() | CreateBody | JsonResponse<ApiResult> | 2 | 158 | 18 |
| 574 | /api/admin/webconfig/setting | # simple implementation for now api | ApiAdminWebconfigAction#put$setting() | EditBody | JsonResponse<ApiResult> | 2 | 158 | 17 |
| 575 | /api/admin/webconfig/setting/{id} | # simple implementation for now api | ApiAdminWebconfigAction#delete$setting() | JsonResponse<ApiResult> | 2 | 158 | 14 | |
| 576 | /cache/ | # simple implementation for now api | CacheAction#index() | CacheForm | ActionResponse | 1 | 62 | 29 |
| 577 | /error/ | # simple implementation for now html | ErrorAction#index() | ErrorForm | HtmlResponse | 0 | 30 | 3 |
| 578 | /error/badrequrest/ | # simple implementation for now html | ErrorBadrequrestAction#index() | ErrorForm | HtmlResponse | 0 | 30 | 3 |
| 579 | /error/notfound/ | # simple implementation for now html | ErrorNotfoundAction#index() | ErrorForm | HtmlResponse | 0 | 30 | 3 |
| 580 | /error/systemerror/ | # simple implementation for now html | ErrorSystemerrorAction#index() | ErrorForm | HtmlResponse | 0 | 30 | 3 |
| 581 | /go/ | # simple implementation for now api | GoAction#index() | GoForm | ActionResponse | 2 | 144 | 91 |
| 582 | /help/ | # simple implementation for now html | HelpAction#index() | HtmlResponse | 0 | 52 | 14 | |
| 583 | /login/ | # simple implementation for now html | LoginAction#index() | HtmlResponse | 3 | 130 | 4 | |
| 584 | /login/login | # simple implementation for now html | LoginAction#login() | LoginForm | HtmlResponse | 3 | 130 | 26 |
| 585 | /login/changePassword | # simple implementation for now html | LoginAction#changePassword() | PasswordForm | HtmlResponse | 3 | 130 | 18 |
| 586 | /logout/ | # simple implementation for now html | LogoutAction#index() | HtmlResponse | 0 | 43 | 11 | |
| 587 | /osdd/ | # simple implementation for now api | OsddAction#index() | ActionResponse | 0 | 38 | 6 | |
| 588 | /profile/ | # simple implementation for now html | ProfileAction#index() | HtmlResponse | 2 | 91 | 3 | |
| 589 | /profile/changePassword | # simple implementation for now html | ProfileAction#changePassword() | ProfileForm | HtmlResponse | 2 | 91 | 16 |
| 590 | /search/ | # simple implementation for now html | SearchAction#index() | SearchForm | HtmlResponse | 3 | 34 | 3 |
| 591 | /search/advance | # simple implementation for now html | SearchAction#advance() | SearchForm | HtmlResponse | 3 | 34 | 20 |
| 592 | /search/search | # simple implementation for now html | SearchAction#search() | SearchForm | HtmlResponse | 3 | 34 | 11 |
| 593 | /search/prev | # simple implementation for now html | SearchAction#prev() | SearchForm | HtmlResponse | 3 | 34 | 3 |
| 594 | /search/next | # simple implementation for now html | SearchAction#next() | SearchForm | HtmlResponse | 3 | 34 | 3 |
| 595 | /search/move | # simple implementation for now html | SearchAction#move() | SearchForm | HtmlResponse | 3 | 34 | 3 |
| 596 | /sso/ | # simple implementation for now api | SsoAction#index() | ActionResponse | 1 | 176 | 57 | |
| 597 | /sso/metadata | # simple implementation for now api | SsoAction#metadata() | ActionResponse | 1 | 176 | 21 | |
| 598 | /sso/logout | # simple implementation for now api | SsoAction#logout() | ActionResponse | 1 | 176 | 21 | |
| 599 | /thumbnail/ | # simple implementation for now api | ThumbnailAction#index() | ThumbnailForm | ActionResponse | 1 | 81 | 29 |
Execute Method: org.codelibs.fess.app.web.RootAction#index()
annotations: @Execute
The action for the root of the application.
The index page.
@return The HTML response for the index page.
implementations: redirectToLogin(),asHtml(virtualHost(path_IndexJsp)
Execute Method: org.codelibs.fess.app.web.admin.AdminAction#index()
annotations: @Execute @Secured{value=[admin-dashboard, admin-dashboard-view, admin-wizard, admin-wizard-view, admin-general, admin-general-view, admin-scheduler, admin-scheduler-view, admin-design, admin-design-view, admin-dict, admin-dict-view, admin-accesstoken, admin-accesstoken-view, admin-plugin, admin-plugin-view, admin-storage, admin-storage-view, admin-webconfig, admin-webconfig-view, admin-fileconfig, admin-fileconfig-view, admin-dataconfig, admin-dataconfig-view, admin-labeltype, admin-labeltype-view, admin-keymatch, admin-keymatch-view, admin-boostdoc, admin-boostdoc-view, admin-relatedcontent, admin-relatedcontent-view, admin-relatedquery, admin-relatedquery-view, admin-pathmap, admin-pathmap-view, admin-webauth, admin-webauth-view, admin-fileauth, admin-fileauth-view, admin-reqheader, admin-reqheader-view, admin-duplicatehost, admin-duplicatehost-view, admin-user, admin-user-view, admin-role, admin-role-view, admin-group, admin-group-view, admin-suggest, admin-suggest-view, admin-elevateword, admin-elevateword-view, admin-badword, admin-badword-view, admin-systeminfo, admin-systeminfo-view, admin-searchlog, admin-searchlog-view, admin-joblog, admin-joblog-view, admin-crawlinginfo, admin-crawlinginfo-view, admin-log, admin-log-view, admin-failureurl, admin-failureurl-view, admin-backup, admin-backup-view, admin-maintenance, admin-maintenance-view, admin-sereq, admin-sereq-view, admin-dashboard, admin-dashboard-view, admin-wizard, admin-wizard-view, admin-general, admin-general-view, admin-scheduler, admin-scheduler-view, admin-design, admin-design-view, admin-dict, admin-dict-view, admin-accesstoken, admin-accesstoken-view, admin-plugin, admin-plugin-view, admin-storage, admin-storage-view, admin-webconfig, admin-webconfig-view, admin-fileconfig, admin-fileconfig-view, admin-dataconfig, admin-dataconfig-view, admin-labeltype, admin-labeltype-view, admin-keymatch, admin-keymatch-view, admin-boostdoc, admin-boostdoc-view, admin-relatedcontent, admin-relatedcontent-view, admin-relatedquery, admin-relatedquery-view, admin-pathmap, admin-pathmap-view, admin-webauth, admin-webauth-view, admin-fileauth, admin-fileauth-view, admin-reqheader, admin-reqheader-view, admin-duplicatehost, admin-duplicatehost-view, admin-user, admin-user-view, admin-role, admin-role-view, admin-group, admin-group-view, admin-suggest, admin-suggest-view, admin-elevateword, admin-elevateword-view, admin-badword, admin-badword-view, admin-systeminfo, admin-systeminfo-view, admin-searchlog, admin-searchlog-view, admin-joblog, admin-joblog-view, admin-crawlinginfo, admin-crawlinginfo-view, admin-log, admin-log-view, admin-failureurl, admin-failureurl-view, admin-backup, admin-backup-view, admin-maintenance, admin-maintenance-view, admin-sereq, admin-sereq-view, admin-dashboard, admin-dashboard-view, admin-wizard, admin-wizard-view, admin-general, admin-general-view, admin-scheduler, admin-scheduler-view, admin-design, admin-design-view, admin-dict, admin-dict-view, admin-accesstoken, admin-accesstoken-view, admin-plugin, admin-plugin-view, admin-storage, admin-storage-view, admin-webconfig, admin-webconfig-view, admin-fileconfig, admin-fileconfig-view, admin-dataconfig, admin-dataconfig-view, admin-labeltype, admin-labeltype-view, admin-keymatch, admin-keymatch-view, admin-boostdoc, admin-boostdoc-view, admin-relatedcontent, admin-relatedcontent-view, admin-relatedquery, admin-relatedquery-view, admin-pathmap, admin-pathmap-view, admin-webauth, admin-webauth-view, admin-fileauth, admin-fileauth-view, admin-reqheader, admin-reqheader-view, admin-duplicatehost, admin-duplicatehost-view, admin-user, admin-user-view, admin-role, admin-role-view, admin-group, admin-group-view, admin-suggest, admin-suggest-view, admin-elevateword, admin-elevateword-view, admin-badword, admin-badword-view, admin-systeminfo, admin-systeminfo-view, admin-searchlog, admin-searchlog-view, admin-joblog, admin-joblog-view, admin-crawlinginfo, admin-crawlinginfo-view, admin-log, admin-log-view, admin-failureurl, admin-failureurl-view, admin-backup, admin-backup-view, admin-maintenance, admin-maintenance-view, admin-sereq, admin-sereq-view]}
The action for admin pages.
Show the index page.
@return The HTML response.
implementations: redirect(getUserBean(),##unanalyzable##,##unanalyzable##
Execute Method: org.codelibs.fess.app.web.admin.accesstoken.AdminAccesstokenAction#index()
annotations: @Execute @Secured{value=[admin-accesstoken, admin-accesstoken-view]}
Admin action for Access Token management.
This class provides CRUD operations for access tokens.
Show the index page.
@return The HTML response.
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.accesstoken.AdminAccesstokenAction#list()
annotations: @Execute @Secured{value=[admin-accesstoken, admin-accesstoken-view]}
Admin action for Access Token management.
This class provides CRUD operations for access tokens.
Show the list page.
@param pageNumber The page number.
@param form The search form.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
The page number. |
The search form for Access Token.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching access tokens |
implementations: asHtml(path_AdminAccesstoken_AdminAccesstokenJsp)
Execute Method: org.codelibs.fess.app.web.admin.accesstoken.AdminAccesstokenAction#search()
annotations: @Execute @Secured{value=[admin-accesstoken, admin-accesstoken-view]}
Admin action for Access Token management.
This class provides CRUD operations for access tokens.
Search the access tokens.
@param form The search form.
@return The HTML response.
The search form for Access Token.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching access tokens |
implementations: asHtml(path_AdminAccesstoken_AdminAccesstokenJsp)
Execute Method: org.codelibs.fess.app.web.admin.accesstoken.AdminAccesstokenAction#reset()
annotations: @Execute @Secured{value=[admin-accesstoken, admin-accesstoken-view]}
Admin action for Access Token management.
This class provides CRUD operations for access tokens.
Reset the search form.
@param form The search form.
@return The HTML response.
The search form for Access Token.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching access tokens |
implementations: asHtml(path_AdminAccesstoken_AdminAccesstokenJsp)
Execute Method: org.codelibs.fess.app.web.admin.accesstoken.AdminAccesstokenAction#createnew()
annotations: @Execute @Secured{value=[admin-accesstoken]}
Admin action for Access Token management.
This class provides CRUD operations for access tokens.
Show the create new page.
@return The HTML response.
implementations: asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.accesstoken.AdminAccesstokenAction#details()
annotations: @Execute @Secured{value=[admin-accesstoken, admin-accesstoken-view]}
Admin action for Access Token management.
This class provides CRUD operations for access tokens.
Show the details page.
@param crudMode The CRUD mode.
@param id The ID.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
The CRUD mode. |
|
| 2 | id | String |
The ID. |
implementations: asDetailsHtml()
Execute Method: org.codelibs.fess.app.web.admin.accesstoken.AdminAccesstokenAction#edit()
annotations: @Execute @Secured{value=[admin-accesstoken]}
Admin action for Access Token management.
This class provides CRUD operations for access tokens.
Show the edit page.
@param form The edit form.
@return The HTML response.
Form class for editing access tokens in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the access token being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this access token |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this access token was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the access token for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure |
| 6 | name | String |
The name of the access token |
@Required , @Size{max=1000} |
| 7 | token | String |
The actual access token string |
@Size{max=10000} |
| 8 | permissions | String |
The permissions associated with this access token |
@CustomSize{maxKey=form.admin.max.input.size} |
| 9 | parameterName | String |
The parameter name for the access token |
@Size{max=10000} |
| 10 | expires | String |
The expiration date and time for the access token |
@Pattern{regexp=[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]T[0-9][0-9]:[0-9][0-9]:[0-9][0-9]} |
| 11 | createdBy | String |
The username of the user who created this access token |
@Size{max=1000} |
| 12 | createdTime | Long |
The timestamp when this access token was created |
@ValidateTypeFailure |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.accesstoken.AdminAccesstokenAction#create()
annotations: @Execute @Secured{value=[admin-accesstoken]}
Admin action for Access Token management.
This class provides CRUD operations for access tokens.
Create an access token.
@param form The create form.
@return The HTML response.
Form class for creating access tokens in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure |
| 2 | name | String |
The name of the access token |
@Required , @Size{max=1000} |
| 3 | token | String |
The actual access token string |
@Size{max=10000} |
| 4 | permissions | String |
The permissions associated with this access token |
@CustomSize{maxKey=form.admin.max.input.size} |
| 5 | parameterName | String |
The parameter name for the access token |
@Size{max=10000} |
| 6 | expires | String |
The expiration date and time for the access token |
@Pattern{regexp=[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]T[0-9][0-9]:[0-9][0-9]:[0-9][0-9]} |
| 7 | createdBy | String |
The username of the user who created this access token |
@Size{max=1000} |
| 8 | createdTime | Long |
The timestamp when this access token was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.accesstoken.AdminAccesstokenAction#update()
annotations: @Execute @Secured{value=[admin-accesstoken]}
Admin action for Access Token management.
This class provides CRUD operations for access tokens.
Update an access token.
@param form The edit form.
@return The HTML response.
Form class for editing access tokens in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the access token being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this access token |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this access token was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the access token for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure |
| 6 | name | String |
The name of the access token |
@Required , @Size{max=1000} |
| 7 | token | String |
The actual access token string |
@Size{max=10000} |
| 8 | permissions | String |
The permissions associated with this access token |
@CustomSize{maxKey=form.admin.max.input.size} |
| 9 | parameterName | String |
The parameter name for the access token |
@Size{max=10000} |
| 10 | expires | String |
The expiration date and time for the access token |
@Pattern{regexp=[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]T[0-9][0-9]:[0-9][0-9]:[0-9][0-9]} |
| 11 | createdBy | String |
The username of the user who created this access token |
@Size{max=1000} |
| 12 | createdTime | Long |
The timestamp when this access token was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.accesstoken.AdminAccesstokenAction#delete()
annotations: @Execute @Secured{value=[admin-accesstoken]}
Admin action for Access Token management.
This class provides CRUD operations for access tokens.
Delete an access token.
@param form The edit form.
@return The HTML response.
Form class for editing access tokens in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the access token being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this access token |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this access token was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the access token for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure |
| 6 | name | String |
The name of the access token |
@Required , @Size{max=1000} |
| 7 | token | String |
The actual access token string |
@Size{max=10000} |
| 8 | permissions | String |
The permissions associated with this access token |
@CustomSize{maxKey=form.admin.max.input.size} |
| 9 | parameterName | String |
The parameter name for the access token |
@Size{max=10000} |
| 10 | expires | String |
The expiration date and time for the access token |
@Pattern{regexp=[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]T[0-9][0-9]:[0-9][0-9]:[0-9][0-9]} |
| 11 | createdBy | String |
The username of the user who created this access token |
@Size{max=1000} |
| 12 | createdTime | Long |
The timestamp when this access token was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.backup.AdminBackupAction#index()
annotations: @Execute @Secured{value=[admin-backup, admin-backup-view]}
Admin action for Backup management.
Show the index page.
@return The HTML response.
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.backup.AdminBackupAction#upload()
annotations: @Execute @Secured{value=[admin-backup]}
Admin action for Backup management.
Upload a file.
@param form The upload form.
@return The HTML response.
Form class for backup file upload.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | bulkFile | MultipartFormFile |
The backup file to be uploaded |
@Required |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.backup.AdminBackupAction#download()
annotations: @Execute @Secured{value=[admin-backup, admin-backup-view]}
Admin action for Backup management.
Download a file.
@param id The ID of the file.
@return The action response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID of the file. |
Execute Method: org.codelibs.fess.app.web.admin.badword.AdminBadwordAction#index()
annotations: @Execute @Secured{value=[admin-badword, admin-badword-view]}
Admin action for Bad Word management.
Show the index page.
@return The HTML response.
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.badword.AdminBadwordAction#list()
annotations: @Execute @Secured{value=[admin-badword, admin-badword-view]}
Admin action for Bad Word management.
Show the list page.
@param pageNumber The page number.
@param form The search form.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
The page number. |
The search form for Bad Word.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching bad words |
implementations: asHtml(path_AdminBadword_AdminBadwordJsp)
Execute Method: org.codelibs.fess.app.web.admin.badword.AdminBadwordAction#search()
annotations: @Execute @Secured{value=[admin-badword, admin-badword-view]}
Admin action for Bad Word management.
Search the bad words.
@param form The search form.
@return The HTML response.
The search form for Bad Word.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching bad words |
implementations: asHtml(path_AdminBadword_AdminBadwordJsp)
Execute Method: org.codelibs.fess.app.web.admin.badword.AdminBadwordAction#reset()
annotations: @Execute @Secured{value=[admin-badword, admin-badword-view]}
Admin action for Bad Word management.
Reset the search form.
@param form The search form.
@return The HTML response.
The search form for Bad Word.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching bad words |
implementations: asHtml(path_AdminBadword_AdminBadwordJsp)
Execute Method: org.codelibs.fess.app.web.admin.badword.AdminBadwordAction#createnew()
annotations: @Execute @Secured{value=[admin-badword]}
Admin action for Bad Word management.
Show the create new page.
@return The HTML response.
implementations: asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.badword.AdminBadwordAction#edit()
annotations: @Execute @Secured{value=[admin-badword]}
Admin action for Bad Word management.
Show the edit page.
@param form The edit form.
@return The HTML response.
Form class for editing bad words in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the bad word entry being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this bad word entry |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this bad word entry was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Long |
The version number of the bad word entry for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for form processing (create, update, delete operations) |
@ValidateTypeFailure |
| 6 | suggestWord | String |
The bad word to be filtered from search suggestions |
@Required , @Pattern{regexp=[^\s]+} |
| 7 | createdBy | String |
The username of the user who created this bad word entry |
@Size{max=1000} |
| 8 | createdTime | Long |
The timestamp when this bad word entry was created |
@ValidateTypeFailure |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.badword.AdminBadwordAction#details()
annotations: @Execute @Secured{value=[admin-badword, admin-badword-view]}
Admin action for Bad Word management.
Show the details page.
@param crudMode The CRUD mode.
@param id The ID.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
The CRUD mode. |
|
| 2 | id | String |
The ID. |
implementations: asDetailsHtml()
Execute Method: org.codelibs.fess.app.web.admin.badword.AdminBadwordAction#downloadpage()
annotations: @Execute @Secured{value=[admin-badword, admin-badword-view]}
Admin action for Bad Word management.
Show the download page.
@return The HTML response.
implementations: asDownloadHtml()
Execute Method: org.codelibs.fess.app.web.admin.badword.AdminBadwordAction#download()
annotations: @Execute @Secured{value=[admin-badword, admin-badword-view]}
Admin action for Bad Word management.
Download the bad words.
@param form The download form.
@return The action response.
The download form for Bad Word.
Return as: ActionResponseExecute Method: org.codelibs.fess.app.web.admin.badword.AdminBadwordAction#uploadpage()
annotations: @Execute @Secured{value=[admin-badword]}
Admin action for Bad Word management.
Show the upload page.
@return The HTML response.
implementations: asUploadHtml()
Execute Method: org.codelibs.fess.app.web.admin.badword.AdminBadwordAction#create()
annotations: @Execute @Secured{value=[admin-badword]}
Admin action for Bad Word management.
Create a bad word.
@param form The create form.
@return The HTML response.
The create form for Bad Word.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
The CRUD mode for form processing (create, update, delete operations) |
@ValidateTypeFailure |
| 2 | suggestWord | String |
The bad word to be filtered from search suggestions |
@Required , @Pattern{regexp=[^\s]+} |
| 3 | createdBy | String |
The username of the user who created this bad word entry |
@Size{max=1000} |
| 4 | createdTime | Long |
The timestamp when this bad word entry was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.badword.AdminBadwordAction#update()
annotations: @Execute @Secured{value=[admin-badword]}
Admin action for Bad Word management.
Update a bad word.
@param form The edit form.
@return The HTML response.
Form class for editing bad words in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the bad word entry being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this bad word entry |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this bad word entry was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Long |
The version number of the bad word entry for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for form processing (create, update, delete operations) |
@ValidateTypeFailure |
| 6 | suggestWord | String |
The bad word to be filtered from search suggestions |
@Required , @Pattern{regexp=[^\s]+} |
| 7 | createdBy | String |
The username of the user who created this bad word entry |
@Size{max=1000} |
| 8 | createdTime | Long |
The timestamp when this bad word entry was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.badword.AdminBadwordAction#delete()
annotations: @Execute @Secured{value=[admin-badword]}
Admin action for Bad Word management.
Delete a bad word.
@param form The edit form.
@return The HTML response.
Form class for editing bad words in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the bad word entry being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this bad word entry |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this bad word entry was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Long |
The version number of the bad word entry for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for form processing (create, update, delete operations) |
@ValidateTypeFailure |
| 6 | suggestWord | String |
The bad word to be filtered from search suggestions |
@Required , @Pattern{regexp=[^\s]+} |
| 7 | createdBy | String |
The username of the user who created this bad word entry |
@Size{max=1000} |
| 8 | createdTime | Long |
The timestamp when this bad word entry was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.badword.AdminBadwordAction#upload()
annotations: @Execute @Secured{value=[admin-badword]}
Admin action for Bad Word management.
Upload the bad words.
@param form The upload form.
@return The HTML response.
Form for uploading bad word files to the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | badWordFile | MultipartFormFile |
The multipart file containing bad words to be uploaded |
@Required |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.boostdoc.AdminBoostdocAction#index()
annotations: @Execute @Secured{value=[admin-boostdoc, admin-boostdoc-view]}
Admin action for Boost Document management.
Show the index page.
@return The HTML response.
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.boostdoc.AdminBoostdocAction#list()
annotations: @Execute @Secured{value=[admin-boostdoc, admin-boostdoc-view]}
Admin action for Boost Document management.
Show the list page.
@param pageNumber The page number.
@param form The search form.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
The page number. |
The search form for Boost Document.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | urlExpr | String |
The URL expression field for boost document configuration |
|
| 2 | boostExpr | String |
The boost expression field for document scoring |
implementations: asHtml(path_AdminBoostdoc_AdminBoostdocJsp)
Execute Method: org.codelibs.fess.app.web.admin.boostdoc.AdminBoostdocAction#search()
annotations: @Execute @Secured{value=[admin-boostdoc, admin-boostdoc-view]}
Admin action for Boost Document management.
Search for boost document rules.
@param form The search form.
@return The HTML response.
The search form for Boost Document.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | urlExpr | String |
The URL expression field for boost document configuration |
|
| 2 | boostExpr | String |
The boost expression field for document scoring |
implementations: asHtml(path_AdminBoostdoc_AdminBoostdocJsp)
Execute Method: org.codelibs.fess.app.web.admin.boostdoc.AdminBoostdocAction#reset()
annotations: @Execute @Secured{value=[admin-boostdoc, admin-boostdoc-view]}
Admin action for Boost Document management.
Reset the search form.
@param form The search form.
@return The HTML response.
The search form for Boost Document.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | urlExpr | String |
The URL expression field for boost document configuration |
|
| 2 | boostExpr | String |
The boost expression field for document scoring |
implementations: asHtml(path_AdminBoostdoc_AdminBoostdocJsp)
Execute Method: org.codelibs.fess.app.web.admin.boostdoc.AdminBoostdocAction#createnew()
annotations: @Execute @Secured{value=[admin-boostdoc]}
Admin action for Boost Document management.
Show the create new page.
@return The HTML response.
implementations: asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.boostdoc.AdminBoostdocAction#edit()
annotations: @Execute @Secured{value=[admin-boostdoc]}
Admin action for Boost Document management.
Show the edit page.
@param form The edit form.
@return The HTML response.
Form class for editing boost document configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the boost document configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this boost document configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this boost document configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the boost document configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 6 | urlExpr | String |
URL expression pattern to match documents for boosting |
@Required , @Size{max=10000} |
| 7 | boostExpr | String |
Boost expression to apply to matching documents |
@Required , @Size{max=10000} |
| 8 | sortOrder | Integer |
Sort order for displaying boost configurations |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 9 | createdBy | String |
User who created this configuration |
@Size{max=1000} |
| 10 | createdTime | Long |
Timestamp when this configuration was created |
@ValidateTypeFailure |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.boostdoc.AdminBoostdocAction#details()
annotations: @Execute @Secured{value=[admin-boostdoc, admin-boostdoc-view]}
Admin action for Boost Document management.
Show the details page.
@param crudMode The CRUD mode.
@param id The ID of the boost document rule.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
The CRUD mode. |
|
| 2 | id | String |
The ID of the boost document rule. |
implementations: asDetailsHtml()
Execute Method: org.codelibs.fess.app.web.admin.boostdoc.AdminBoostdocAction#create()
annotations: @Execute @Secured{value=[admin-boostdoc]}
Admin action for Boost Document management.
Create a new boost document rule.
@param form The create form.
@return The HTML response.
Form class for creating boost document configurations.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 2 | urlExpr | String |
URL expression pattern to match documents for boosting |
@Required , @Size{max=10000} |
| 3 | boostExpr | String |
Boost expression to apply to matching documents |
@Required , @Size{max=10000} |
| 4 | sortOrder | Integer |
Sort order for displaying boost configurations |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 5 | createdBy | String |
User who created this configuration |
@Size{max=1000} |
| 6 | createdTime | Long |
Timestamp when this configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.boostdoc.AdminBoostdocAction#update()
annotations: @Execute @Secured{value=[admin-boostdoc]}
Admin action for Boost Document management.
Update a boost document rule.
@param form The edit form.
@return The HTML response.
Form class for editing boost document configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the boost document configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this boost document configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this boost document configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the boost document configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 6 | urlExpr | String |
URL expression pattern to match documents for boosting |
@Required , @Size{max=10000} |
| 7 | boostExpr | String |
Boost expression to apply to matching documents |
@Required , @Size{max=10000} |
| 8 | sortOrder | Integer |
Sort order for displaying boost configurations |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 9 | createdBy | String |
User who created this configuration |
@Size{max=1000} |
| 10 | createdTime | Long |
Timestamp when this configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.boostdoc.AdminBoostdocAction#delete()
annotations: @Execute @Secured{value=[admin-boostdoc]}
Admin action for Boost Document management.
Delete a boost document rule.
@param form The edit form.
@return The HTML response.
Form class for editing boost document configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the boost document configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this boost document configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this boost document configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the boost document configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 6 | urlExpr | String |
URL expression pattern to match documents for boosting |
@Required , @Size{max=10000} |
| 7 | boostExpr | String |
Boost expression to apply to matching documents |
@Required , @Size{max=10000} |
| 8 | sortOrder | Integer |
Sort order for displaying boost configurations |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 9 | createdBy | String |
User who created this configuration |
@Size{max=1000} |
| 10 | createdTime | Long |
Timestamp when this configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.crawlinginfo.AdminCrawlinginfoAction#index()
annotations: @Execute @Secured{value=[admin-crawlinginfo, admin-crawlinginfo-view]}
Admin action for Crawling Info management.
Show the index page.
@return The HTML response.
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.crawlinginfo.AdminCrawlinginfoAction#list()
annotations: @Execute @Secured{value=[admin-crawlinginfo, admin-crawlinginfo-view]}
Admin action for Crawling Info management.
Show the list page.
@param pageNumber The page number.
@param form The search form.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | Integer |
The page number. |
The search form for Crawling Info.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | sessionId | String |
The session ID field for searching crawling information |
implementations: asHtml(path_AdminCrawlinginfo_AdminCrawlinginfoJsp)
Execute Method: org.codelibs.fess.app.web.admin.crawlinginfo.AdminCrawlinginfoAction#search()
annotations: @Execute @Secured{value=[admin-crawlinginfo, admin-crawlinginfo-view]}
Admin action for Crawling Info management.
Search crawling info.
@param form The search form.
@return The HTML response.
The search form for Crawling Info.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | sessionId | String |
The session ID field for searching crawling information |
implementations: asHtml(path_AdminCrawlinginfo_AdminCrawlinginfoJsp)
Execute Method: org.codelibs.fess.app.web.admin.crawlinginfo.AdminCrawlinginfoAction#reset()
annotations: @Execute @Secured{value=[admin-crawlinginfo, admin-crawlinginfo-view]}
Admin action for Crawling Info management.
Reset the search form.
@param form The search form.
@return The HTML response.
The search form for Crawling Info.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | sessionId | String |
The session ID field for searching crawling information |
implementations: asHtml(path_AdminCrawlinginfo_AdminCrawlinginfoJsp)
Execute Method: org.codelibs.fess.app.web.admin.crawlinginfo.AdminCrawlinginfoAction#back()
annotations: @Execute @Secured{value=[admin-crawlinginfo, admin-crawlinginfo-view]}
Admin action for Crawling Info management.
Go back to the list page.
@param form The search form.
@return The HTML response.
The search form for Crawling Info.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | sessionId | String |
The session ID field for searching crawling information |
implementations: asHtml(path_AdminCrawlinginfo_AdminCrawlinginfoJsp)
Execute Method: org.codelibs.fess.app.web.admin.crawlinginfo.AdminCrawlinginfoAction#details()
annotations: @Execute @Secured{value=[admin-crawlinginfo, admin-crawlinginfo-view]}
Admin action for Crawling Info management.
Show the details page.
@param crudMode The CRUD mode.
@param id The crawling info ID.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
The CRUD mode. |
|
| 2 | id | String |
The crawling info ID. |
implementations: crawlingInfoService.getCrawlingInfo(id),##unanalyzable##
Execute Method: org.codelibs.fess.app.web.admin.crawlinginfo.AdminCrawlinginfoAction#threaddump()
annotations: @Execute @Secured{value=[admin-crawlinginfo]}
Admin action for Crawling Info management.
Print a thread dump.
@param form The edit form.
@return The HTML response.
Form class for editing crawling information in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
The CRUD operation mode for this form |
@ValidateTypeFailure |
| 2 | id | String |
The unique identifier of the crawling information entry being edited |
@Required , @Size{max=1000} |
| 3 | sessionId | String |
The session identifier of the crawling session |
@Required , @Size{max=20} |
| 4 | name | String |
The name or description of the crawling session |
@Size{max=20} |
| 5 | expiredTime | String |
The expiration time for the crawling session |
|
| 6 | createdTime | Long |
The timestamp when this crawling session was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.crawlinginfo.AdminCrawlinginfoAction#delete()
annotations: @Execute @Secured{value=[admin-crawlinginfo]}
Admin action for Crawling Info management.
Delete a crawling info.
@param form The edit form.
@return The HTML response.
Form class for editing crawling information in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
The CRUD operation mode for this form |
@ValidateTypeFailure |
| 2 | id | String |
The unique identifier of the crawling information entry being edited |
@Required , @Size{max=1000} |
| 3 | sessionId | String |
The session identifier of the crawling session |
@Required , @Size{max=20} |
| 4 | name | String |
The name or description of the crawling session |
@Size{max=20} |
| 5 | expiredTime | String |
The expiration time for the crawling session |
|
| 6 | createdTime | Long |
The timestamp when this crawling session was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.crawlinginfo.AdminCrawlinginfoAction#deleteall()
annotations: @Execute @Secured{value=[admin-crawlinginfo, admin-crawlinginfo-view]}
Admin action for Crawling Info management.
Delete all crawling info.
@return The HTML response.
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dashboard.AdminDashboardAction#index()
annotations: @Execute @Secured{value=[admin-dashboard]}
Admin action for Dashboard.
Show the index page.
@return The HTML response.
implementations: asHtml(path_AdminDashboard_AdminDashboardJsp)
Execute Method: org.codelibs.fess.app.web.admin.dataconfig.AdminDataconfigAction#index()
annotations: @Execute @Secured{value=[admin-dataconfig, admin-dataconfig-view]}
Admin action for Data Config management.
Show the index page.
@return The HTML response.
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.dataconfig.AdminDataconfigAction#list()
annotations: @Execute @Secured{value=[admin-dataconfig, admin-dataconfig-view]}
Admin action for Data Config management.
Show the list page.
@param pageNumber The page number.
@param form The search form.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
The page number. |
The search form for Data Config.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
The name field for searching data configurations |
|
| 2 | handlerName | String |
The handler name field for searching data configurations |
|
| 3 | description | String |
The description field for searching data configurations |
implementations: asHtml(path_AdminDataconfig_AdminDataconfigJsp)
Execute Method: org.codelibs.fess.app.web.admin.dataconfig.AdminDataconfigAction#search()
annotations: @Execute @Secured{value=[admin-dataconfig, admin-dataconfig-view]}
Admin action for Data Config management.
Search for data configs.
@param form The search form.
@return The HTML response.
The search form for Data Config.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
The name field for searching data configurations |
|
| 2 | handlerName | String |
The handler name field for searching data configurations |
|
| 3 | description | String |
The description field for searching data configurations |
implementations: asHtml(path_AdminDataconfig_AdminDataconfigJsp)
Execute Method: org.codelibs.fess.app.web.admin.dataconfig.AdminDataconfigAction#reset()
annotations: @Execute @Secured{value=[admin-dataconfig, admin-dataconfig-view]}
Admin action for Data Config management.
Reset the search form.
@param form The search form.
@return The HTML response.
The search form for Data Config.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
The name field for searching data configurations |
|
| 2 | handlerName | String |
The handler name field for searching data configurations |
|
| 3 | description | String |
The description field for searching data configurations |
implementations: asHtml(path_AdminDataconfig_AdminDataconfigJsp)
Execute Method: org.codelibs.fess.app.web.admin.dataconfig.AdminDataconfigAction#createnew()
annotations: @Execute @Secured{value=[admin-dataconfig]}
Admin action for Data Config management.
Show the create new page.
@return The HTML response.
implementations: asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.dataconfig.AdminDataconfigAction#edit()
annotations: @Execute @Secured{value=[admin-dataconfig]}
Admin action for Data Config management.
Show the edit page.
@param form The edit form.
@return The HTML response.
Form class for editing data crawling configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the data configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this data configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this data configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the data configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 6 | name | String |
Configuration name for identifying this data source |
@Required , @Size{max=200} |
| 7 | description | String |
Optional description of this data configuration |
@Size{max=1000} |
| 8 | handlerName | String |
Handler class name for processing this data source |
@Required , @CustomSize{maxKey=form.admin.max.input.size} |
| 9 | handlerParameter | String |
Parameters passed to the data handler |
@CustomSize{maxKey=form.admin.max.input.size} |
| 10 | handlerScript | String |
Script for custom data processing logic |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | boost | Float |
Boost value for documents from this data source |
@Required , @ValidateTypeFailure |
| 12 | available | String |
Whether this configuration is enabled (true/false) |
@Required , @Size{max=5} |
| 13 | permissions | String |
Access permissions for documents from this data source |
@CustomSize{maxKey=form.admin.max.input.size} |
| 14 | virtualHosts | String |
Virtual hosts where this configuration applies |
@CustomSize{maxKey=form.admin.max.input.size} |
| 15 | sortOrder | Integer |
Sort order for displaying configurations |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 16 | createdBy | String |
User who created this configuration |
@Size{max=1000} |
| 17 | createdTime | Long |
Timestamp when this configuration was created |
@ValidateTypeFailure |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.dataconfig.AdminDataconfigAction#details()
annotations: @Execute @Secured{value=[admin-dataconfig, admin-dataconfig-view]}
Admin action for Data Config management.
Show the details page.
@param crudMode The CRUD mode.
@param id The data config ID.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
The CRUD mode. |
|
| 2 | id | String |
The data config ID. |
implementations: asDetailsHtml()
Execute Method: org.codelibs.fess.app.web.admin.dataconfig.AdminDataconfigAction#create()
annotations: @Execute @Secured{value=[admin-dataconfig]}
Admin action for Data Config management.
Create a new data config.
@param form The create form.
@return The HTML response.
Form class for creating data store configurations.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 2 | name | String |
Configuration name for identifying this data source |
@Required , @Size{max=200} |
| 3 | description | String |
Optional description of this data configuration |
@Size{max=1000} |
| 4 | handlerName | String |
Handler class name for processing this data source |
@Required , @CustomSize{maxKey=form.admin.max.input.size} |
| 5 | handlerParameter | String |
Parameters passed to the data handler |
@CustomSize{maxKey=form.admin.max.input.size} |
| 6 | handlerScript | String |
Script for custom data processing logic |
@CustomSize{maxKey=form.admin.max.input.size} |
| 7 | boost | Float |
Boost value for documents from this data source |
@Required , @ValidateTypeFailure |
| 8 | available | String |
Whether this configuration is enabled (true/false) |
@Required , @Size{max=5} |
| 9 | permissions | String |
Access permissions for documents from this data source |
@CustomSize{maxKey=form.admin.max.input.size} |
| 10 | virtualHosts | String |
Virtual hosts where this configuration applies |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | sortOrder | Integer |
Sort order for displaying configurations |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 12 | createdBy | String |
User who created this configuration |
@Size{max=1000} |
| 13 | createdTime | Long |
Timestamp when this configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dataconfig.AdminDataconfigAction#update()
annotations: @Execute @Secured{value=[admin-dataconfig]}
Admin action for Data Config management.
Update a data config.
@param form The edit form.
@return The HTML response.
Form class for editing data crawling configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the data configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this data configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this data configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the data configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 6 | name | String |
Configuration name for identifying this data source |
@Required , @Size{max=200} |
| 7 | description | String |
Optional description of this data configuration |
@Size{max=1000} |
| 8 | handlerName | String |
Handler class name for processing this data source |
@Required , @CustomSize{maxKey=form.admin.max.input.size} |
| 9 | handlerParameter | String |
Parameters passed to the data handler |
@CustomSize{maxKey=form.admin.max.input.size} |
| 10 | handlerScript | String |
Script for custom data processing logic |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | boost | Float |
Boost value for documents from this data source |
@Required , @ValidateTypeFailure |
| 12 | available | String |
Whether this configuration is enabled (true/false) |
@Required , @Size{max=5} |
| 13 | permissions | String |
Access permissions for documents from this data source |
@CustomSize{maxKey=form.admin.max.input.size} |
| 14 | virtualHosts | String |
Virtual hosts where this configuration applies |
@CustomSize{maxKey=form.admin.max.input.size} |
| 15 | sortOrder | Integer |
Sort order for displaying configurations |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 16 | createdBy | String |
User who created this configuration |
@Size{max=1000} |
| 17 | createdTime | Long |
Timestamp when this configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dataconfig.AdminDataconfigAction#delete()
annotations: @Execute @Secured{value=[admin-dataconfig]}
Admin action for Data Config management.
Delete a data config.
@param form The edit form.
@return The HTML response.
Form class for editing data crawling configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the data configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this data configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this data configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the data configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 6 | name | String |
Configuration name for identifying this data source |
@Required , @Size{max=200} |
| 7 | description | String |
Optional description of this data configuration |
@Size{max=1000} |
| 8 | handlerName | String |
Handler class name for processing this data source |
@Required , @CustomSize{maxKey=form.admin.max.input.size} |
| 9 | handlerParameter | String |
Parameters passed to the data handler |
@CustomSize{maxKey=form.admin.max.input.size} |
| 10 | handlerScript | String |
Script for custom data processing logic |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | boost | Float |
Boost value for documents from this data source |
@Required , @ValidateTypeFailure |
| 12 | available | String |
Whether this configuration is enabled (true/false) |
@Required , @Size{max=5} |
| 13 | permissions | String |
Access permissions for documents from this data source |
@CustomSize{maxKey=form.admin.max.input.size} |
| 14 | virtualHosts | String |
Virtual hosts where this configuration applies |
@CustomSize{maxKey=form.admin.max.input.size} |
| 15 | sortOrder | Integer |
Sort order for displaying configurations |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 16 | createdBy | String |
User who created this configuration |
@Size{max=1000} |
| 17 | createdTime | Long |
Timestamp when this configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.design.AdminDesignAction#index()
annotations: @Execute @Secured{value=[admin-design, admin-design-view]}
Admin action for Design management.
Show the index page.
@return The HTML response.
implementations: asHtml(path_AdminDesign_AdminDesignJsp)
Execute Method: org.codelibs.fess.app.web.admin.design.AdminDesignAction#back()
annotations: @Execute @Secured{value=[admin-design, admin-design-view]}
Admin action for Design management.
Go back to the index page.
@return The HTML response.
implementations: asHtml(path_AdminDesign_AdminDesignJsp)
Execute Method: org.codelibs.fess.app.web.admin.design.AdminDesignAction#upload()
annotations: @Execute @Secured{value=[admin-design]}
Admin action for Design management.
Upload a design file.
@param form The upload form.
@return The HTML response.
Form for uploading design files to customize the appearance of the Fess search interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | designFile | MultipartFormFile |
The multipart file containing design resources to be uploaded |
@Required |
| 2 | designFileName | String |
The name for the design file being uploaded |
@Pattern{message={errors.design_file_name_is_invalid}, regexp=^[^\\|/|:|\*|?|"|<|>|\|]+$} |
implementations: ##unanalyzable##,##unanalyzable##,redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.design.AdminDesignAction#download()
annotations: @Execute @Secured{value=[admin-design, admin-design-view]}
Admin action for Design management.
Download a design file.
@param form The file access form.
@return The stream response.
Form class for file access operations in the admin design interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | fileName | String |
The name of the file to access (required) |
@Required |
Execute Method: org.codelibs.fess.app.web.admin.design.AdminDesignAction#delete()
annotations: @Execute @Secured{value=[admin-design]}
Admin action for Design management.
Delete a design file.
@param form The file access form.
@return The HTML response.
Form class for file access operations in the admin design interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | fileName | String |
The name of the file to access (required) |
@Required |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.design.AdminDesignAction#edit()
annotations: @Execute @Secured{value=[admin-design]}
Admin action for Design management.
Show the edit page.
@param form The edit form.
@return The HTML response.
Form class for editing design files in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | fileName | String |
The name of the design file being edited |
|
| 2 | content | String |
The content of the design file |
implementations: asEditHtml(form)
Execute Method: org.codelibs.fess.app.web.admin.design.AdminDesignAction#editAsUseDefault()
annotations: @Execute @Secured{value=[admin-design]}
Admin action for Design management.
Show the edit page with the default content.
@param form The edit form.
@return The HTML response.
Form class for editing design files in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | fileName | String |
The name of the design file being edited |
|
| 2 | content | String |
The content of the design file |
implementations: asEditHtml(form)
Execute Method: org.codelibs.fess.app.web.admin.design.AdminDesignAction#update()
annotations: @Execute @Secured{value=[admin-design]}
Admin action for Design management.
Update a design file.
@param form The edit form.
@return The HTML response.
Form class for editing design files in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | fileName | String |
The name of the design file being edited |
|
| 2 | content | String |
The content of the design file |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.AdminDictAction#index()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Dictionary management.
Show the index page.
@return The HTML response.
implementations: asHtml(path_AdminDict_AdminDictJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.kuromoji.AdminDictKuromojiAction#index()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Kuromoji dictionary management.
Show the index page.
@param form The search form.
@return The HTML response.
The search form for Kuromoji.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for Kuromoji dictionary operations |
@Required |
implementations: asHtml(path_AdminDictKuromoji_AdminDictKuromojiJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.kuromoji.AdminDictKuromojiAction#list()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Kuromoji dictionary management.
Show the list page.
@param pageNumber The page number.
@param form The search form.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
The page number. |
The search form for Kuromoji.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for Kuromoji dictionary operations |
@Required |
implementations: asHtml(path_AdminDictKuromoji_AdminDictKuromojiJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.kuromoji.AdminDictKuromojiAction#search()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Kuromoji dictionary management.
Search for kuromoji items.
@param form The search form.
@return The HTML response.
The search form for Kuromoji.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for Kuromoji dictionary operations |
@Required |
implementations: asHtml(path_AdminDictKuromoji_AdminDictKuromojiJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.kuromoji.AdminDictKuromojiAction#reset()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Kuromoji dictionary management.
Reset the search form.
@param form The search form.
@return The HTML response.
The search form for Kuromoji.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for Kuromoji dictionary operations |
@Required |
implementations: asHtml(path_AdminDictKuromoji_AdminDictKuromojiJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.kuromoji.AdminDictKuromojiAction#createnew()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Kuromoji dictionary management.
Show the create new page.
@param dictId The dictionary ID.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID. |
implementations: asHtml(path_AdminDictKuromoji_AdminDictKuromojiEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.kuromoji.AdminDictKuromojiAction#edit()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Kuromoji dictionary management.
Show the edit page.
@param form The edit form.
@return The HTML response.
Form class for editing Kuromoji dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the Kuromoji dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
Dictionary identifier |
@Required |
| 3 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 4 | token | String |
Token (word) to be added to the dictionary |
@Required , @Size{max=1000} |
| 5 | segmentation | String |
Segmentation information for the token |
@Required , @Size{max=1000} |
| 6 | reading | String |
Reading (pronunciation) of the token in katakana |
@Required , @Size{max=1000} |
| 7 | pos | String |
Part of speech tag for the token |
@Required , @Size{max=1000} |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.dict.kuromoji.AdminDictKuromojiAction#details()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Kuromoji dictionary management.
Show the details page.
@param dictId The dictionary ID.
@param crudMode The CRUD mode.
@param id The ID of the kuromoji item.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID. |
|
| 2 | crudMode | int |
The CRUD mode. |
|
| 3 | id | long |
The ID of the kuromoji item. |
implementations: asDetailsHtml()
Execute Method: org.codelibs.fess.app.web.admin.dict.kuromoji.AdminDictKuromojiAction#downloadpage()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Kuromoji dictionary management.
Show the download page.
@param dictId The dictionary ID.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID. |
implementations: asHtml(path_AdminDictKuromoji_AdminDictKuromojiDownloadJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.kuromoji.AdminDictKuromojiAction#download()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Kuromoji dictionary management.
Download a kuromoji dictionary file.
@param form The download form.
@return The action response.
The download form for Kuromoji dictionary.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Dictionary ID for identifying the Kuromoji dictionary to download |
@Required |
Execute Method: org.codelibs.fess.app.web.admin.dict.kuromoji.AdminDictKuromojiAction#uploadpage()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Kuromoji dictionary management.
Show the upload page.
@param dictId The dictionary ID.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID. |
implementations: asHtml(path_AdminDictKuromoji_AdminDictKuromojiUploadJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.kuromoji.AdminDictKuromojiAction#upload()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Kuromoji dictionary management.
Upload a kuromoji dictionary file.
@param form The upload form.
@return The HTML response.
Form for uploading Kuromoji dictionary files to the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID that identifies which Kuromoji dictionary configuration to update |
@Required |
| 2 | kuromojiFile | MultipartFormFile |
The multipart file containing the Kuromoji user dictionary to be uploaded |
@Required |
implementations: kuromojiService.getKuromojiFile(form.dictId),##unanalyzable##,redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.kuromoji.AdminDictKuromojiAction#create()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Kuromoji dictionary management.
Create a new kuromoji item.
@param form The create form.
@return The HTML response.
Form class for creating Kuromoji dictionary entries.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Dictionary identifier |
@Required |
| 2 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 3 | token | String |
Token (word) to be added to the dictionary |
@Required , @Size{max=1000} |
| 4 | segmentation | String |
Segmentation information for the token |
@Required , @Size{max=1000} |
| 5 | reading | String |
Reading (pronunciation) of the token in katakana |
@Required , @Size{max=1000} |
| 6 | pos | String |
Part of speech tag for the token |
@Required , @Size{max=1000} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.kuromoji.AdminDictKuromojiAction#update()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Kuromoji dictionary management.
Update a kuromoji item.
@param form The edit form.
@return The HTML response.
Form class for editing Kuromoji dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the Kuromoji dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
Dictionary identifier |
@Required |
| 3 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 4 | token | String |
Token (word) to be added to the dictionary |
@Required , @Size{max=1000} |
| 5 | segmentation | String |
Segmentation information for the token |
@Required , @Size{max=1000} |
| 6 | reading | String |
Reading (pronunciation) of the token in katakana |
@Required , @Size{max=1000} |
| 7 | pos | String |
Part of speech tag for the token |
@Required , @Size{max=1000} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.kuromoji.AdminDictKuromojiAction#delete()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Kuromoji dictionary management.
Delete a kuromoji item.
@param form The edit form.
@return The HTML response.
Form class for editing Kuromoji dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the Kuromoji dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
Dictionary identifier |
@Required |
| 3 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 4 | token | String |
Token (word) to be added to the dictionary |
@Required , @Size{max=1000} |
| 5 | segmentation | String |
Segmentation information for the token |
@Required , @Size{max=1000} |
| 6 | reading | String |
Reading (pronunciation) of the token in katakana |
@Required , @Size{max=1000} |
| 7 | pos | String |
Part of speech tag for the token |
@Required , @Size{max=1000} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.mapping.AdminDictMappingAction#index()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Mapping management.
Show the index page.
@param form The search form.
@return The HTML response.
The search form for Mapping.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for mapping dictionary operations |
@Required |
implementations: asHtml(path_AdminDictMapping_AdminDictMappingJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.mapping.AdminDictMappingAction#list()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Mapping management.
Show the list page.
@param pageNumber The page number.
@param form The search form.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
The page number. |
The search form for Mapping.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for mapping dictionary operations |
@Required |
implementations: asHtml(path_AdminDictMapping_AdminDictMappingJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.mapping.AdminDictMappingAction#search()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Mapping management.
Search for char mapping items.
@param form The search form.
@return The HTML response.
The search form for Mapping.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for mapping dictionary operations |
@Required |
implementations: asHtml(path_AdminDictMapping_AdminDictMappingJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.mapping.AdminDictMappingAction#reset()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Mapping management.
Reset the search form.
@param form The search form.
@return The HTML response.
The search form for Mapping.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for mapping dictionary operations |
@Required |
implementations: asHtml(path_AdminDictMapping_AdminDictMappingJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.mapping.AdminDictMappingAction#createnew()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Mapping management.
Show the create new page.
@param dictId The dictionary ID.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID. |
implementations: asHtml(path_AdminDictMapping_AdminDictMappingEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.mapping.AdminDictMappingAction#edit()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Mapping management.
Show the edit page.
@param form The edit form.
@return The HTML response.
Form class for editing mapping dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the mapping dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
Dictionary identifier |
@Required |
| 3 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 4 | inputs | String |
Input terms (comma-separated) that will be mapped to the output term |
@Required , @Size{max=1000} |
| 5 | output | String |
Output term that input terms will be mapped to |
@Size{max=1000, min=1} |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.dict.mapping.AdminDictMappingAction#details()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Mapping management.
Show the details page.
@param dictId The dictionary ID.
@param crudMode The CRUD mode.
@param id The ID of the char mapping item.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID. |
|
| 2 | crudMode | int |
The CRUD mode. |
|
| 3 | id | long |
The ID of the char mapping item. |
implementations: asDetailsHtml()
Execute Method: org.codelibs.fess.app.web.admin.dict.mapping.AdminDictMappingAction#downloadpage()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Mapping management.
Show the download page.
@param dictId The dictionary ID.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID. |
implementations: asHtml(path_AdminDictMapping_AdminDictMappingDownloadJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.mapping.AdminDictMappingAction#download()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Mapping management.
Download a char mapping file.
@param form The download form.
@return The action response.
The download form for mapping dictionary.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Dictionary ID for identifying the mapping dictionary to download |
@Required |
Execute Method: org.codelibs.fess.app.web.admin.dict.mapping.AdminDictMappingAction#uploadpage()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Mapping management.
Show the upload page.
@param dictId The dictionary ID.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID. |
implementations: asHtml(path_AdminDictMapping_AdminDictMappingUploadJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.mapping.AdminDictMappingAction#upload()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Mapping management.
Upload a char mapping file.
@param form The upload form.
@return The HTML response.
Form for uploading character mapping files to the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID that identifies which character mapping dictionary configuration to update |
@Required |
| 2 | charMappingFile | MultipartFormFile |
The multipart file containing the character mapping rules to be uploaded |
@Required |
implementations: charMappingService.getCharMappingFile(form.dictId),##unanalyzable##,redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.mapping.AdminDictMappingAction#create()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Mapping management.
Create a new char mapping item.
@param form The create form.
@return The HTML response.
Form class for creating mapping dictionary entries.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Dictionary identifier |
@Required |
| 2 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 3 | inputs | String |
Input terms (comma-separated) that will be mapped to the output term |
@Required , @Size{max=1000} |
| 4 | output | String |
Output term that input terms will be mapped to |
@Size{max=1000, min=1} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.mapping.AdminDictMappingAction#update()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Mapping management.
Update a char mapping item.
@param form The edit form.
@return The HTML response.
Form class for editing mapping dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the mapping dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
Dictionary identifier |
@Required |
| 3 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 4 | inputs | String |
Input terms (comma-separated) that will be mapped to the output term |
@Required , @Size{max=1000} |
| 5 | output | String |
Output term that input terms will be mapped to |
@Size{max=1000, min=1} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.mapping.AdminDictMappingAction#delete()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Mapping management.
Delete a char mapping item.
@param form The edit form.
@return The HTML response.
Form class for editing mapping dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the mapping dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
Dictionary identifier |
@Required |
| 3 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 4 | inputs | String |
Input terms (comma-separated) that will be mapped to the output term |
@Required , @Size{max=1000} |
| 5 | output | String |
Output term that input terms will be mapped to |
@Size{max=1000, min=1} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.protwords.AdminDictProtwordsAction#index()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Protected Words management.
Show the index page.
@param form The search form.
@return The HTML response.
The search form for Protected Words.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for protected words dictionary operations |
@Required |
implementations: asHtml(path_AdminDictProtwords_AdminDictProtwordsJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.protwords.AdminDictProtwordsAction#list()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Protected Words management.
Show the list page.
@param pageNumber The page number.
@param form The search form.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
The page number. |
The search form for Protected Words.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for protected words dictionary operations |
@Required |
implementations: asHtml(path_AdminDictProtwords_AdminDictProtwordsJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.protwords.AdminDictProtwordsAction#search()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Protected Words management.
Search the protected words.
@param form The search form.
@return The HTML response.
The search form for Protected Words.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for protected words dictionary operations |
@Required |
implementations: asHtml(path_AdminDictProtwords_AdminDictProtwordsJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.protwords.AdminDictProtwordsAction#reset()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Protected Words management.
Reset the search form.
@param form The search form.
@return The HTML response.
The search form for Protected Words.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for protected words dictionary operations |
@Required |
implementations: asHtml(path_AdminDictProtwords_AdminDictProtwordsJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.protwords.AdminDictProtwordsAction#createnew()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Protected Words management.
Show the create new page.
@param dictId The dictionary ID.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID. |
implementations: asHtml(path_AdminDictProtwords_AdminDictProtwordsEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.protwords.AdminDictProtwordsAction#edit()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Protected Words management.
Show the edit page.
@param form The edit form.
@return The HTML response.
Form class for editing protected words dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the protected words dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
Dictionary identifier |
@Required |
| 3 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 4 | input | String |
Word or phrase to be protected from analysis |
@Required , @Size{max=1000} |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.dict.protwords.AdminDictProtwordsAction#details()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Protected Words management.
Show the details page.
@param dictId The dictionary ID.
@param crudMode The CRUD mode.
@param id The ID.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID. |
|
| 2 | crudMode | int |
The CRUD mode. |
|
| 3 | id | long |
The ID. |
implementations: asDetailsHtml()
Execute Method: org.codelibs.fess.app.web.admin.dict.protwords.AdminDictProtwordsAction#downloadpage()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Protected Words management.
Show the download page.
@param dictId The dictionary ID.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID. |
implementations: asHtml(path_AdminDictProtwords_AdminDictProtwordsDownloadJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.protwords.AdminDictProtwordsAction#download()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Protected Words management.
Download the protected words.
@param form The download form.
@return The action response.
The download form for protected words dictionary.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Dictionary ID for identifying the protected words dictionary to download |
@Required |
Execute Method: org.codelibs.fess.app.web.admin.dict.protwords.AdminDictProtwordsAction#uploadpage()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Protected Words management.
Show the upload page.
@param dictId The dictionary ID.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID. |
implementations: asHtml(path_AdminDictProtwords_AdminDictProtwordsUploadJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.protwords.AdminDictProtwordsAction#upload()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Protected Words management.
Upload the protected words.
@param form The upload form.
@return The HTML response.
Form for uploading protected words files to the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID that identifies which protected words dictionary configuration to update |
@Required |
| 2 | protwordsFile | MultipartFormFile |
The multipart file containing the protected words to be uploaded |
@Required |
implementations: protwordsService.getProtwordsFile(form.dictId),##unanalyzable##,redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.protwords.AdminDictProtwordsAction#create()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Protected Words management.
Create a protected word item.
@param form The create form.
@return The HTML response.
Form class for creating protected words dictionary entries.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Dictionary identifier |
@Required |
| 2 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 3 | input | String |
Word or phrase to be protected from analysis |
@Required , @Size{max=1000} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.protwords.AdminDictProtwordsAction#update()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Protected Words management.
Update a protected word item.
@param form The edit form.
@return The HTML response.
Form class for editing protected words dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the protected words dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
Dictionary identifier |
@Required |
| 3 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 4 | input | String |
Word or phrase to be protected from analysis |
@Required , @Size{max=1000} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.protwords.AdminDictProtwordsAction#delete()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Protected Words management.
Delete a protected word item.
@param form The edit form.
@return The HTML response.
Form class for editing protected words dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the protected words dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
Dictionary identifier |
@Required |
| 3 | crudMode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure |
| 4 | input | String |
Word or phrase to be protected from analysis |
@Required , @Size{max=1000} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.stemmeroverride.AdminDictStemmeroverrideAction#index()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Stemmer Override management.
Display the main index page for stemmer override dictionary management.
Clears the pager and shows the initial search form.
@param form The search form containing filter criteria
@return HTML response for the stemmer override index page
The search form for Stemmer Override.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for stemmer override dictionary operations |
@Required |
implementations: asHtml(path_AdminDictStemmeroverride_AdminDictStemmeroverrideJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.stemmeroverride.AdminDictStemmeroverrideAction#list()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Stemmer Override management.
Display a paginated list of stemmer override items.
Sets the current page number and shows the list with pagination.
@param pageNumber Optional page number to display (0-based)
@param form The search form containing filter criteria
@return HTML response showing the stemmer override list
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
Optional page number to display |
The search form for Stemmer Override.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for stemmer override dictionary operations |
@Required |
implementations: asHtml(path_AdminDictStemmeroverride_AdminDictStemmeroverrideJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.stemmeroverride.AdminDictStemmeroverrideAction#search()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Stemmer Override management.
Perform a search operation for stemmer override items.
Updates the pager with search criteria and displays filtered results.
@param form The search form containing search criteria
@return HTML response showing search results
The search form for Stemmer Override.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for stemmer override dictionary operations |
@Required |
implementations: asHtml(path_AdminDictStemmeroverride_AdminDictStemmeroverrideJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.stemmeroverride.AdminDictStemmeroverrideAction#reset()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Stemmer Override management.
Reset the search criteria and pager to default state.
Clears all filters and returns to the initial page view.
@param form The search form to reset
@return HTML response showing the reset stemmer override list
The search form for Stemmer Override.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for stemmer override dictionary operations |
@Required |
implementations: asHtml(path_AdminDictStemmeroverride_AdminDictStemmeroverrideJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.stemmeroverride.AdminDictStemmeroverrideAction#createnew()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Stemmer Override management.
Show the create new page.
@param dictId The dictionary ID.
@return The HTML response.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID. |
implementations: asHtml(path_AdminDictStemmeroverride_AdminDictStemmeroverrideEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.stemmeroverride.AdminDictStemmeroverrideAction#edit()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Stemmer Override management.
Display the edit form for an existing stemmer override item.
Loads the item data and switches to edit mode or details view based on current state.
@param form The edit form containing item ID and CRUD mode
@return HTML response for the edit page or details page
Form class for editing stemmer override dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the stemmer override dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
The dictionary ID to which this stemmer override entry belongs |
@Required |
| 3 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 4 | input | String |
The input word that should be stemmed differently |
@Required , @Size{max=1000} |
| 5 | output | String |
The desired stem output for the input word |
@Required , @Size{max=1000} |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.dict.stemmeroverride.AdminDictStemmeroverrideAction#details()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Stemmer Override management.
Display detailed view of a specific stemmer override item.
Shows read-only details of the selected item.
@param dictId The dictionary ID
@param crudMode The CRUD mode (should be DETAILS)
@param id The ID of the stemmer override item to display
@return HTML response showing item details
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID |
|
| 2 | crudMode | int |
The CRUD mode |
|
| 3 | id | long |
The ID of the stemmer override item to display |
implementations: asDetailsHtml()
Execute Method: org.codelibs.fess.app.web.admin.dict.stemmeroverride.AdminDictStemmeroverrideAction#downloadpage()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Stemmer Override management.
Display the download page for stemmer override dictionary file.
Shows the file path and provides download interface.
@param dictId The dictionary ID to download
@return HTML response for the download page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID to download |
implementations: asHtml(path_AdminDictStemmeroverride_AdminDictStemmeroverrideDownloadJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.stemmeroverride.AdminDictStemmeroverrideAction#download()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Stemmer Override management.
Download the stemmer override dictionary file.
Streams the dictionary file as an octet-stream download.
@param form The download form containing dictionary ID
@return Action response with file stream for download
The download form for stemmer override dictionary.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Dictionary ID for identifying the stemmer override dictionary to download |
@Required |
Execute Method: org.codelibs.fess.app.web.admin.dict.stemmeroverride.AdminDictStemmeroverrideAction#uploadpage()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Stemmer Override management.
Display the upload page for stemmer override dictionary file.
Shows the current file path and provides upload interface.
@param dictId The dictionary ID to upload to
@return HTML response for the upload page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID to upload to |
implementations: asHtml(path_AdminDictStemmeroverride_AdminDictStemmeroverrideUploadJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.stemmeroverride.AdminDictStemmeroverrideAction#upload()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Stemmer Override management.
Upload a new stemmer override dictionary file.
Processes the uploaded file and updates the dictionary.
@param form The upload form containing the file and dictionary ID
@return HTML response redirecting to the list page on success
Form for uploading stemmer override files to the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID that identifies which stemmer override dictionary configuration to update |
@Required |
| 2 | stemmerOverrideFile | MultipartFormFile |
The multipart file containing the stemmer override rules to be uploaded |
@Required |
implementations: stemmerOverrideService.getStemmerOverrideFile(form.dictId),##unanalyzable##,redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.stemmeroverride.AdminDictStemmeroverrideAction#create()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Stemmer Override management.
Create a stemmer override item.
@param form The create form.
@return The HTML response.
Form class for creating new stemmer override dictionary entries.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID to which this stemmer override entry belongs |
@Required |
| 2 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 3 | input | String |
The input word that should be stemmed differently |
@Required , @Size{max=1000} |
| 4 | output | String |
The desired stem output for the input word |
@Required , @Size{max=1000} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.stemmeroverride.AdminDictStemmeroverrideAction#update()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Stemmer Override management.
Update an existing stemmer override item.
Validates the form data and updates the item in the dictionary.
@param form The edit form containing updated item data
@return HTML response redirecting to the list page on success
Form class for editing stemmer override dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the stemmer override dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
The dictionary ID to which this stemmer override entry belongs |
@Required |
| 3 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 4 | input | String |
The input word that should be stemmed differently |
@Required , @Size{max=1000} |
| 5 | output | String |
The desired stem output for the input word |
@Required , @Size{max=1000} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.stemmeroverride.AdminDictStemmeroverrideAction#delete()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Stemmer Override management.
Delete a stemmer override item from the dictionary.
Removes the specified item and redirects to the list page.
@param form The edit form containing the item ID to delete
@return HTML response redirecting to the list page on success
Form class for editing stemmer override dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the stemmer override dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
The dictionary ID to which this stemmer override entry belongs |
@Required |
| 3 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 4 | input | String |
The input word that should be stemmed differently |
@Required , @Size{max=1000} |
| 5 | output | String |
The desired stem output for the input word |
@Required , @Size{max=1000} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.stopwords.AdminDictStopwordsAction#index()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Stopwords management.
Display the stopwords index page.
@param form the search form
@return HTML response for the index page
The search form for Stopwords.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for stopwords dictionary operations |
@Required |
implementations: asHtml(path_AdminDictStopwords_AdminDictStopwordsJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.stopwords.AdminDictStopwordsAction#list()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Stopwords management.
Display the stopwords list with pagination.
@param pageNumber the page number to display
@param form the search form
@return HTML response for the list page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
the page number to display |
The search form for Stopwords.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for stopwords dictionary operations |
@Required |
implementations: asHtml(path_AdminDictStopwords_AdminDictStopwordsJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.stopwords.AdminDictStopwordsAction#search()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Stopwords management.
Perform search for stopwords.
@param form the search form containing search criteria
@return HTML response with search results
The search form for Stopwords.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for stopwords dictionary operations |
@Required |
implementations: asHtml(path_AdminDictStopwords_AdminDictStopwordsJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.stopwords.AdminDictStopwordsAction#reset()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Stopwords management.
Reset search criteria and return to default view.
@param form the search form to reset
@return HTML response for the reset page
The search form for Stopwords.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for stopwords dictionary operations |
@Required |
implementations: asHtml(path_AdminDictStopwords_AdminDictStopwordsJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.stopwords.AdminDictStopwordsAction#createnew()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Stopwords management.
Display the form for creating a new stopwords entry.
@param dictId the dictionary ID
@return HTML response for the create form
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
the dictionary ID |
implementations: asHtml(path_AdminDictStopwords_AdminDictStopwordsEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.stopwords.AdminDictStopwordsAction#edit()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Stopwords management.
Display the edit form for an existing stopwords entry.
@param form the edit form containing the entry ID and dictionary ID
@return HTML response for the edit form
Form class for editing stopwords dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the stopwords dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
The dictionary ID to which this stopword entry belongs |
@Required |
| 3 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 4 | input | String |
The stopword to be added to the dictionary |
@Required , @Size{max=1000} |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.dict.stopwords.AdminDictStopwordsAction#details()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Stopwords management.
Display details of a specific stopwords entry.
@param dictId the dictionary ID
@param crudMode the CRUD mode for the operation
@param id the entry ID
@return HTML response for the details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
the dictionary ID |
|
| 2 | crudMode | int |
the CRUD mode for the operation |
|
| 3 | id | long |
the entry ID |
implementations: asDetailsHtml()
Execute Method: org.codelibs.fess.app.web.admin.dict.stopwords.AdminDictStopwordsAction#downloadpage()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Stopwords management.
Display the download page for stopwords file.
@param dictId the dictionary ID
@return HTML response for the download page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
the dictionary ID |
implementations: asHtml(path_AdminDictStopwords_AdminDictStopwordsDownloadJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.stopwords.AdminDictStopwordsAction#download()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Stopwords management.
Download the stopwords file.
@param form the download form containing dictionary ID
@return action response with the file download stream
The download form for stop words dictionary.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Dictionary ID for identifying the stop words dictionary to download |
@Required |
Execute Method: org.codelibs.fess.app.web.admin.dict.stopwords.AdminDictStopwordsAction#uploadpage()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Stopwords management.
Display the upload page for stopwords file.
@param dictId the dictionary ID
@return HTML response for the upload page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
the dictionary ID |
implementations: asHtml(path_AdminDictStopwords_AdminDictStopwordsUploadJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.stopwords.AdminDictStopwordsAction#upload()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Stopwords management.
Upload a stopwords file.
@param form the upload form containing the file and dictionary ID
@return HTML response redirecting to the list page after successful upload
Form for uploading stopwords files to the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID that identifies which stopwords dictionary configuration to update |
@Required |
| 2 | stopwordsFile | MultipartFormFile |
The multipart file containing the stopwords to be uploaded |
@Required |
implementations: stopwordsService.getStopwordsFile(form.dictId),##unanalyzable##,redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.stopwords.AdminDictStopwordsAction#create()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Stopwords management.
Create a new stopwords entry.
@param form the create form containing the new entry data
@return HTML response redirecting to the list page after successful creation
Form class for creating new stopwords dictionary entries.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID to which this stopword entry belongs |
@Required |
| 2 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 3 | input | String |
The stopword to be added to the dictionary |
@Required , @Size{max=1000} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.stopwords.AdminDictStopwordsAction#update()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Stopwords management.
Update an existing stopwords entry.
@param form the edit form containing the updated entry data
@return HTML response redirecting to the list page after successful update
Form class for editing stopwords dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the stopwords dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
The dictionary ID to which this stopword entry belongs |
@Required |
| 3 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 4 | input | String |
The stopword to be added to the dictionary |
@Required , @Size{max=1000} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.stopwords.AdminDictStopwordsAction#delete()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Stopwords management.
Delete a stopwords entry.
@param form the edit form containing the entry ID to delete
@return HTML response redirecting to the list page after successful deletion
Form class for editing stopwords dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the stopwords dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
The dictionary ID to which this stopword entry belongs |
@Required |
| 3 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 4 | input | String |
The stopword to be added to the dictionary |
@Required , @Size{max=1000} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.synonym.AdminDictSynonymAction#index()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Synonym management.
Displays the main synonym dictionary index page.
@param form the search form containing search criteria
@return HTML response for the synonym dictionary index page
The search form for Synonym.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for synonym dictionary operations |
@Required |
implementations: asHtml(path_AdminDictSynonym_AdminDictSynonymJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.synonym.AdminDictSynonymAction#list()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Synonym management.
Displays a paginated list of synonym items.
@param pageNumber the optional page number for pagination
@param form the search form containing search criteria
@return HTML response with the synonym items list
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
the optional page number for pagination |
The search form for Synonym.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for synonym dictionary operations |
@Required |
implementations: asHtml(path_AdminDictSynonym_AdminDictSynonymJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.synonym.AdminDictSynonymAction#search()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Synonym management.
Performs a search for synonym items based on the provided criteria.
@param form the search form containing search criteria
@return HTML response with the search results
The search form for Synonym.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for synonym dictionary operations |
@Required |
implementations: asHtml(path_AdminDictSynonym_AdminDictSynonymJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.synonym.AdminDictSynonymAction#reset()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Synonym management.
Resets the search criteria and returns to the default view.
@param form the search form to reset
@return HTML response with reset search criteria
The search form for Synonym.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID field for synonym dictionary operations |
@Required |
implementations: asHtml(path_AdminDictSynonym_AdminDictSynonymJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.synonym.AdminDictSynonymAction#createnew()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Synonym management.
Displays the form for creating a new synonym item.
@param dictId the dictionary ID
@return HTML response for the create new synonym form
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
the dictionary ID |
implementations: asHtml(path_AdminDictSynonym_AdminDictSynonymEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.synonym.AdminDictSynonymAction#edit()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Synonym management.
Displays the form for editing an existing synonym item.
@param form the edit form containing synonym item data
@return HTML response for the edit synonym form
Form class for editing synonym dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the synonym dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
The dictionary ID to which this synonym entry belongs |
@Required |
| 3 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 4 | inputs | String |
The input terms that should be considered synonymous |
@Required , @Size{max=1000} |
| 5 | outputs | String |
The output synonyms that should be matched for the input terms |
@Required , @Size{max=1000} |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.dict.synonym.AdminDictSynonymAction#details()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Synonym management.
Displays the details view for a specific synonym item.
@param dictId the dictionary ID
@param crudMode the CRUD operation mode
@param id the synonym item ID
@return HTML response for the synonym item details
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
the dictionary ID |
|
| 2 | crudMode | int |
the CRUD operation mode |
|
| 3 | id | long |
the synonym item ID |
implementations: asDetailsHtml()
Execute Method: org.codelibs.fess.app.web.admin.dict.synonym.AdminDictSynonymAction#downloadpage()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Synonym management.
Displays the download page for synonym dictionary files.
@param dictId the dictionary ID
@return HTML response for the download page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
the dictionary ID |
implementations: asHtml(path_AdminDictSynonym_AdminDictSynonymDownloadJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.synonym.AdminDictSynonymAction#download()
annotations: @Execute @Secured{value=[admin-dict, admin-dict-view]}
Admin action for Synonym management.
Downloads the synonym dictionary file.
@param form the download form containing download parameters
@return ActionResponse with the file download stream
The download form for synonym dictionary.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Dictionary ID for identifying the synonym dictionary to download |
@Required |
Execute Method: org.codelibs.fess.app.web.admin.dict.synonym.AdminDictSynonymAction#uploadpage()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Synonym management.
Displays the upload page for synonym dictionary files.
@param dictId the dictionary ID
@return HTML response for the upload page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
the dictionary ID |
implementations: asHtml(path_AdminDictSynonym_AdminDictSynonymUploadJsp)
Execute Method: org.codelibs.fess.app.web.admin.dict.synonym.AdminDictSynonymAction#upload()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Synonym management.
Handles the upload of synonym dictionary files.
@param form the upload form containing the file to upload
@return HTML response after processing the upload
Form for uploading synonym files to the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID that identifies which synonym dictionary configuration to update |
@Required |
| 2 | synonymFile | MultipartFormFile |
The multipart file containing the synonym mappings to be uploaded |
@Required |
implementations: synonymService.getSynonymFile(form.dictId),##unanalyzable##,redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.synonym.AdminDictSynonymAction#create()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Synonym management.
Creates a new synonym item.
@param form the create form containing synonym item data
@return HTML response after creating the synonym item
Form class for creating new synonym dictionary entries.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID to which this synonym entry belongs |
@Required |
| 2 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 3 | inputs | String |
The input terms that should be considered synonymous |
@Required , @Size{max=1000} |
| 4 | outputs | String |
The output synonyms that should be matched for the input terms |
@Required , @Size{max=1000} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.synonym.AdminDictSynonymAction#update()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Synonym management.
Updates an existing synonym item.
@param form the edit form containing updated synonym item data
@return HTML response after updating the synonym item
Form class for editing synonym dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the synonym dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
The dictionary ID to which this synonym entry belongs |
@Required |
| 3 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 4 | inputs | String |
The input terms that should be considered synonymous |
@Required , @Size{max=1000} |
| 5 | outputs | String |
The output synonyms that should be matched for the input terms |
@Required , @Size{max=1000} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.dict.synonym.AdminDictSynonymAction#delete()
annotations: @Execute @Secured{value=[admin-dict]}
Admin action for Synonym management.
Deletes an existing synonym item.
@param form the edit form containing the synonym item to delete
@return HTML response after deleting the synonym item
Form class for editing synonym dictionary entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the synonym dictionary entry being edited |
@Required , @ValidateTypeFailure |
| 2 | dictId | String |
The dictionary ID to which this synonym entry belongs |
@Required |
| 3 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 4 | inputs | String |
The input terms that should be considered synonymous |
@Required , @Size{max=1000} |
| 5 | outputs | String |
The output synonyms that should be matched for the input terms |
@Required , @Size{max=1000} |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.duplicatehost.AdminDuplicatehostAction#index()
annotations: @Execute @Secured{value=[admin-duplicatehost, admin-duplicatehost-view]}
Admin action for Duplicate Host management.
Displays the initial duplicate host management page.
@param form the search form
@return HTML response for the duplicate host list page
The search form for Duplicate Host.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | regularName | String |
The regular name field for duplicate host configuration |
|
| 2 | duplicateHostName | String |
The duplicate host name field for searching duplicate hosts |
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.duplicatehost.AdminDuplicatehostAction#list()
annotations: @Execute @Secured{value=[admin-duplicatehost, admin-duplicatehost-view]}
Admin action for Duplicate Host management.
Displays the duplicate host list with pagination.
@param pageNumber the page number to display
@param form the search form
@return HTML response for the duplicate host list page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
the page number to display |
The search form for Duplicate Host.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | regularName | String |
The regular name field for duplicate host configuration |
|
| 2 | duplicateHostName | String |
The duplicate host name field for searching duplicate hosts |
implementations: asHtml(path_AdminDuplicatehost_AdminDuplicatehostJsp)
Execute Method: org.codelibs.fess.app.web.admin.duplicatehost.AdminDuplicatehostAction#search()
annotations: @Execute @Secured{value=[admin-duplicatehost, admin-duplicatehost-view]}
Admin action for Duplicate Host management.
Performs search for duplicate hosts based on form criteria.
@param form the search form containing search criteria
@return HTML response for the duplicate host list page with search results
The search form for Duplicate Host.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | regularName | String |
The regular name field for duplicate host configuration |
|
| 2 | duplicateHostName | String |
The duplicate host name field for searching duplicate hosts |
implementations: asHtml(path_AdminDuplicatehost_AdminDuplicatehostJsp)
Execute Method: org.codelibs.fess.app.web.admin.duplicatehost.AdminDuplicatehostAction#reset()
annotations: @Execute @Secured{value=[admin-duplicatehost, admin-duplicatehost-view]}
Admin action for Duplicate Host management.
Resets the search criteria and pager state.
@param form the search form
@return HTML response for the duplicate host list page with cleared search
The search form for Duplicate Host.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | regularName | String |
The regular name field for duplicate host configuration |
|
| 2 | duplicateHostName | String |
The duplicate host name field for searching duplicate hosts |
implementations: asHtml(path_AdminDuplicatehost_AdminDuplicatehostJsp)
Execute Method: org.codelibs.fess.app.web.admin.duplicatehost.AdminDuplicatehostAction#createnew()
annotations: @Execute @Secured{value=[admin-duplicatehost]}
Admin action for Duplicate Host management.
Displays the form for creating a new duplicate host configuration.
@return HTML response for the duplicate host creation form
implementations: asHtml(path_AdminDuplicatehost_AdminDuplicatehostEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.duplicatehost.AdminDuplicatehostAction#edit()
annotations: @Execute @Secured{value=[admin-duplicatehost]}
Admin action for Duplicate Host management.
Displays the form for editing an existing duplicate host configuration.
@param form the edit form containing the duplicate host ID
@return HTML response for the duplicate host edit form
Form class for editing duplicate host configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the duplicate host configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this duplicate host configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this duplicate host configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the duplicate host configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 6 | regularName | String |
The regular canonical hostname that should be used |
@Required , @Size{max=1000} |
| 7 | duplicateHostName | String |
The duplicate hostname that should be redirected to the regular name |
@Required , @Size{max=1000} |
| 8 | sortOrder | Integer |
The sort order for displaying this duplicate host entry |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 9 | createdBy | String |
The username of who created this duplicate host entry |
@Size{max=1000} |
| 10 | createdTime | Long |
The timestamp when this duplicate host entry was created |
@ValidateTypeFailure |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.duplicatehost.AdminDuplicatehostAction#details()
annotations: @Execute @Secured{value=[admin-duplicatehost, admin-duplicatehost-view]}
Admin action for Duplicate Host management.
Displays the details of a duplicate host configuration.
@param crudMode the CRUD mode
@param id the duplicate host ID
@return HTML response for the duplicate host details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD mode |
|
| 2 | id | String |
the duplicate host ID |
implementations: asHtml(path_AdminDuplicatehost_AdminDuplicatehostDetailsJsp)
Execute Method: org.codelibs.fess.app.web.admin.duplicatehost.AdminDuplicatehostAction#create()
annotations: @Execute @Secured{value=[admin-duplicatehost]}
Admin action for Duplicate Host management.
Creates a new duplicate host configuration.
@param form the creation form containing duplicate host data
@return HTML response redirecting to the duplicate host list
Form class for creating new duplicate host configuration entries.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 2 | regularName | String |
The regular canonical hostname that should be used |
@Required , @Size{max=1000} |
| 3 | duplicateHostName | String |
The duplicate hostname that should be redirected to the regular name |
@Required , @Size{max=1000} |
| 4 | sortOrder | Integer |
The sort order for displaying this duplicate host entry |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 5 | createdBy | String |
The username of who created this duplicate host entry |
@Size{max=1000} |
| 6 | createdTime | Long |
The timestamp when this duplicate host entry was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.duplicatehost.AdminDuplicatehostAction#update()
annotations: @Execute @Secured{value=[admin-duplicatehost]}
Admin action for Duplicate Host management.
Updates an existing duplicate host configuration.
@param form the edit form containing updated duplicate host data
@return HTML response redirecting to the duplicate host list
Form class for editing duplicate host configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the duplicate host configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this duplicate host configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this duplicate host configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the duplicate host configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 6 | regularName | String |
The regular canonical hostname that should be used |
@Required , @Size{max=1000} |
| 7 | duplicateHostName | String |
The duplicate hostname that should be redirected to the regular name |
@Required , @Size{max=1000} |
| 8 | sortOrder | Integer |
The sort order for displaying this duplicate host entry |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 9 | createdBy | String |
The username of who created this duplicate host entry |
@Size{max=1000} |
| 10 | createdTime | Long |
The timestamp when this duplicate host entry was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.duplicatehost.AdminDuplicatehostAction#delete()
annotations: @Execute @Secured{value=[admin-duplicatehost]}
Admin action for Duplicate Host management.
Deletes a duplicate host configuration.
@param form the edit form containing the duplicate host ID to delete
@return HTML response redirecting to the duplicate host list
Form class for editing duplicate host configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the duplicate host configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this duplicate host configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this duplicate host configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the duplicate host configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 6 | regularName | String |
The regular canonical hostname that should be used |
@Required , @Size{max=1000} |
| 7 | duplicateHostName | String |
The duplicate hostname that should be redirected to the regular name |
@Required , @Size{max=1000} |
| 8 | sortOrder | Integer |
The sort order for displaying this duplicate host entry |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 9 | createdBy | String |
The username of who created this duplicate host entry |
@Size{max=1000} |
| 10 | createdTime | Long |
The timestamp when this duplicate host entry was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.elevateword.AdminElevatewordAction#index()
annotations: @Execute @Secured{value=[admin-elevateword, admin-elevateword-view]}
Admin action for Elevate Word management.
Shows the main elevate word management page.
@return HTML response for the elevate word list page
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.elevateword.AdminElevatewordAction#list()
annotations: @Execute @Secured{value=[admin-elevateword, admin-elevateword-view]}
Admin action for Elevate Word management.
Lists elevate words with pagination support.
@param pageNumber optional page number for pagination
@param form search form containing filter criteria
@return HTML response with elevate word list
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
optional page number for pagination |
The search form for Elevate Word.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching elevate words |
implementations: asHtml(path_AdminElevateword_AdminElevatewordJsp)
Execute Method: org.codelibs.fess.app.web.admin.elevateword.AdminElevatewordAction#search()
annotations: @Execute @Secured{value=[admin-elevateword, admin-elevateword-view]}
Admin action for Elevate Word management.
Searches elevate words based on form criteria.
@param form search form containing search parameters
@return HTML response with filtered elevate word list
The search form for Elevate Word.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching elevate words |
implementations: asHtml(path_AdminElevateword_AdminElevatewordJsp)
Execute Method: org.codelibs.fess.app.web.admin.elevateword.AdminElevatewordAction#reset()
annotations: @Execute @Secured{value=[admin-elevateword, admin-elevateword-view]}
Admin action for Elevate Word management.
Resets the search criteria and shows all elevate words.
@param form search form to be reset
@return HTML response with all elevate words
The search form for Elevate Word.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching elevate words |
implementations: asHtml(path_AdminElevateword_AdminElevatewordJsp)
Execute Method: org.codelibs.fess.app.web.admin.elevateword.AdminElevatewordAction#createnew()
annotations: @Execute @Secured{value=[admin-elevateword]}
Admin action for Elevate Word management.
Shows the form for creating a new elevate word.
@return HTML response for the create elevate word form
implementations: asHtml(path_AdminElevateword_AdminElevatewordEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.elevateword.AdminElevatewordAction#edit()
annotations: @Execute @Secured{value=[admin-elevateword]}
Admin action for Elevate Word management.
Shows the form for editing an existing elevate word.
@param form edit form containing the elevate word ID
@return HTML response for the edit elevate word form
Form class for editing elevate word configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the elevate word configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this elevate word configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this elevate word configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Long |
The version number of the elevate word configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | labelTypeIds | String[] |
The label type IDs associated with this elevate word entry |
|
| 6 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 7 | suggestWord | String |
The word that should trigger document elevation in search results |
@Required |
| 8 | reading | String |
The reading/pronunciation of the suggest word for language analysis |
|
| 9 | targetLabel | String |
The target label for filtering documents to be elevated |
|
| 10 | permissions | String |
The permission settings for accessing this elevate word configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | boost | Float |
The boost score multiplier applied to elevated documents |
@Required , @ValidateTypeFailure |
| 12 | createdBy | String |
The username of who created this elevate word entry |
@Size{max=1000} |
| 13 | createdTime | Long |
The timestamp when this elevate word entry was created |
@ValidateTypeFailure |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.elevateword.AdminElevatewordAction#details()
annotations: @Execute @Secured{value=[admin-elevateword, admin-elevateword-view]}
Admin action for Elevate Word management.
Shows detailed information for a specific elevate word.
@param crudMode CRUD operation mode
@param id unique identifier of the elevate word
@return HTML response with elevate word details
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
CRUD operation mode |
|
| 2 | id | String |
unique identifier of the elevate word |
implementations: asHtml(path_AdminElevateword_AdminElevatewordDetailsJsp)
Execute Method: org.codelibs.fess.app.web.admin.elevateword.AdminElevatewordAction#downloadpage()
annotations: @Execute @Secured{value=[admin-elevateword, admin-elevateword-view]}
Admin action for Elevate Word management.
Shows the download page for exporting elevate words.
@return HTML response for the download page
implementations: asDownloadHtml()
Execute Method: org.codelibs.fess.app.web.admin.elevateword.AdminElevatewordAction#download()
annotations: @Execute @Secured{value=[admin-elevateword, admin-elevateword-view]}
Admin action for Elevate Word management.
Downloads elevate words data as a CSV file.
@param form download form with export options
@return streaming response containing CSV data
The download form for Elevate Word.
Return as: ActionResponseExecute Method: org.codelibs.fess.app.web.admin.elevateword.AdminElevatewordAction#uploadpage()
annotations: @Execute @Secured{value=[admin-elevateword]}
Admin action for Elevate Word management.
Shows the upload page for importing elevate words.
@return HTML response for the upload page
implementations: asUploadHtml()
Execute Method: org.codelibs.fess.app.web.admin.elevateword.AdminElevatewordAction#create()
annotations: @Execute @Secured{value=[admin-elevateword]}
Admin action for Elevate Word management.
Creates a new elevate word entry.
@param form create form containing new elevate word data
@return redirect response to the main elevate word page
Form class for creating new elevate word configuration entries.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | labelTypeIds | String[] |
The label type IDs associated with this elevate word entry |
|
| 2 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 3 | suggestWord | String |
The word that should trigger document elevation in search results |
@Required |
| 4 | reading | String |
The reading/pronunciation of the suggest word for language analysis |
|
| 5 | targetLabel | String |
The target label for filtering documents to be elevated |
|
| 6 | permissions | String |
The permission settings for accessing this elevate word configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 7 | boost | Float |
The boost score multiplier applied to elevated documents |
@Required , @ValidateTypeFailure |
| 8 | createdBy | String |
The username of who created this elevate word entry |
@Size{max=1000} |
| 9 | createdTime | Long |
The timestamp when this elevate word entry was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.elevateword.AdminElevatewordAction#update()
annotations: @Execute @Secured{value=[admin-elevateword]}
Admin action for Elevate Word management.
Updates an existing elevate word entry.
@param form edit form containing updated elevate word data
@return redirect response to the main elevate word page
Form class for editing elevate word configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the elevate word configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this elevate word configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this elevate word configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Long |
The version number of the elevate word configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | labelTypeIds | String[] |
The label type IDs associated with this elevate word entry |
|
| 6 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 7 | suggestWord | String |
The word that should trigger document elevation in search results |
@Required |
| 8 | reading | String |
The reading/pronunciation of the suggest word for language analysis |
|
| 9 | targetLabel | String |
The target label for filtering documents to be elevated |
|
| 10 | permissions | String |
The permission settings for accessing this elevate word configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | boost | Float |
The boost score multiplier applied to elevated documents |
@Required , @ValidateTypeFailure |
| 12 | createdBy | String |
The username of who created this elevate word entry |
@Size{max=1000} |
| 13 | createdTime | Long |
The timestamp when this elevate word entry was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.elevateword.AdminElevatewordAction#delete()
annotations: @Execute @Secured{value=[admin-elevateword]}
Admin action for Elevate Word management.
Deletes an existing elevate word entry.
@param form edit form containing the elevate word ID to delete
@return redirect response to the main elevate word page
Form class for editing elevate word configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the elevate word configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this elevate word configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this elevate word configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Long |
The version number of the elevate word configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | labelTypeIds | String[] |
The label type IDs associated with this elevate word entry |
|
| 6 | crudMode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure |
| 7 | suggestWord | String |
The word that should trigger document elevation in search results |
@Required |
| 8 | reading | String |
The reading/pronunciation of the suggest word for language analysis |
|
| 9 | targetLabel | String |
The target label for filtering documents to be elevated |
|
| 10 | permissions | String |
The permission settings for accessing this elevate word configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | boost | Float |
The boost score multiplier applied to elevated documents |
@Required , @ValidateTypeFailure |
| 12 | createdBy | String |
The username of who created this elevate word entry |
@Size{max=1000} |
| 13 | createdTime | Long |
The timestamp when this elevate word entry was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.elevateword.AdminElevatewordAction#upload()
annotations: @Execute @Secured{value=[admin-elevateword]}
Admin action for Elevate Word management.
Uploads and imports elevate words from a CSV file.
@param form upload form containing the CSV file
@return redirect response to the main elevate word page
Form for uploading elevate word files to the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | elevateWordFile | MultipartFormFile |
The multipart file containing the elevate word configurations to be uploaded |
@Required |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.failureurl.AdminFailureurlAction#index()
annotations: @Execute @Secured{value=[admin-failureurl, admin-failureurl-view]}
Admin action for Failure URL management.
Displays the main failure URL management page.
@return HTML response for the failure URL list page
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.failureurl.AdminFailureurlAction#list()
annotations: @Execute @Secured{value=[admin-failureurl, admin-failureurl-view]}
Admin action for Failure URL management.
Displays the failure URL list page with pagination support.
@param pageNumber the page number to display
@param form the search form containing filter criteria
@return HTML response for the failure URL list page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | Integer |
the page number to display |
The search form for Failure URL.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | url | String |
The URL field for searching failure URLs |
|
| 2 | errorCountMin | String |
The minimum error count field for filtering failure URLs |
|
| 3 | errorCountMax | String |
The maximum error count field for filtering failure URLs |
|
| 4 | errorName | String |
The error name field for searching failure URLs by error type |
implementations: asHtml(path_AdminFailureurl_AdminFailureurlJsp)
Execute Method: org.codelibs.fess.app.web.admin.failureurl.AdminFailureurlAction#search()
annotations: @Execute @Secured{value=[admin-failureurl, admin-failureurl-view]}
Admin action for Failure URL management.
Performs a search for failure URLs based on the provided criteria.
@param form the search form containing filter criteria
@return HTML response for the failure URL list page with search results
The search form for Failure URL.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | url | String |
The URL field for searching failure URLs |
|
| 2 | errorCountMin | String |
The minimum error count field for filtering failure URLs |
|
| 3 | errorCountMax | String |
The maximum error count field for filtering failure URLs |
|
| 4 | errorName | String |
The error name field for searching failure URLs by error type |
implementations: asHtml(path_AdminFailureurl_AdminFailureurlJsp)
Execute Method: org.codelibs.fess.app.web.admin.failureurl.AdminFailureurlAction#reset()
annotations: @Execute @Secured{value=[admin-failureurl, admin-failureurl-view]}
Admin action for Failure URL management.
Resets the search criteria and pagination state.
@param form the search form to reset
@return HTML response for the failure URL list page with cleared search
The search form for Failure URL.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | url | String |
The URL field for searching failure URLs |
|
| 2 | errorCountMin | String |
The minimum error count field for filtering failure URLs |
|
| 3 | errorCountMax | String |
The maximum error count field for filtering failure URLs |
|
| 4 | errorName | String |
The error name field for searching failure URLs by error type |
implementations: asHtml(path_AdminFailureurl_AdminFailureurlJsp)
Execute Method: org.codelibs.fess.app.web.admin.failureurl.AdminFailureurlAction#back()
annotations: @Execute @Secured{value=[admin-failureurl, admin-failureurl-view]}
Admin action for Failure URL management.
Returns to the failure URL list page with the current search form.
@param form the search form containing current search parameters
@return HTML response for the failure URL list page
The search form for Failure URL.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | url | String |
The URL field for searching failure URLs |
|
| 2 | errorCountMin | String |
The minimum error count field for filtering failure URLs |
|
| 3 | errorCountMax | String |
The maximum error count field for filtering failure URLs |
|
| 4 | errorName | String |
The error name field for searching failure URLs by error type |
implementations: asHtml(path_AdminFailureurl_AdminFailureurlJsp)
Execute Method: org.codelibs.fess.app.web.admin.failureurl.AdminFailureurlAction#details()
annotations: @Execute @Secured{value=[admin-failureurl, admin-failureurl-view]}
Admin action for Failure URL management.
Displays the details of a specific failure URL record.
@param crudMode the CRUD operation mode (should be DETAILS)
@param id the ID of the failure URL record to display
@return HTML response for the failure URL details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD operation mode |
|
| 2 | id | String |
the ID of the failure URL record to display |
implementations: asHtml(path_AdminFailureurl_AdminFailureurlDetailsJsp)
Execute Method: org.codelibs.fess.app.web.admin.failureurl.AdminFailureurlAction#delete()
annotations: @Execute @Secured{value=[admin-failureurl]}
Admin action for Failure URL management.
Deletes a specific failure URL record.
@param form the edit form containing the ID of the failure URL to delete
@return HTML response redirecting to the failure URL list page
Form class for editing failure URL records in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | webConfigName | String |
The name of the web configuration associated with this failure URL |
|
| 2 | fileConfigName | String |
The name of the file configuration associated with this failure URL |
|
| 3 | pageNumber | String |
The current page number for pagination in the failure URL list |
@ValidateTypeFailure |
| 4 | crudMode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure |
| 5 | id | String |
The unique identifier of the failure URL record being edited |
@Required , @Size{max=1000} |
| 6 | url | String |
The URL that failed during crawling |
@Required |
| 7 | threadName | String |
The name of the crawler thread that encountered the failure |
@Required |
| 8 | errorName | String |
The name or type of the error that occurred |
|
| 9 | errorLog | String |
The detailed error log or stack trace for the failure |
|
| 10 | errorCount | String |
The number of times this URL has failed |
@Required , @ValidateTypeFailure |
| 11 | lastAccessTime | String |
The timestamp of the last access attempt for this URL |
@Required |
| 12 | configId | String |
The configuration ID associated with this failure URL |
@Size{max=1000} |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.failureurl.AdminFailureurlAction#deleteall()
annotations: @Execute @Secured{value=[admin-failureurl]}
Admin action for Failure URL management.
Deletes all failure URL records that match the current search criteria.
@return HTML response redirecting to the failure URL list page
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.fileauth.AdminFileauthAction#index()
annotations: @Execute @Secured{value=[admin-fileauth, admin-fileauth-view]}
Admin action for File Authentication management.
Displays the file authentication list page.
@return HTML response for the list page
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.fileauth.AdminFileauthAction#list()
annotations: @Execute @Secured{value=[admin-fileauth, admin-fileauth-view]}
Admin action for File Authentication management.
Displays the file authentication list with pagination.
@param pageNumber the page number
@param form the search form
@return HTML response for the list page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
the page number |
The search form for File Authentication.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching file authentication settings |
implementations: asHtml(path_AdminFileauth_AdminFileauthJsp)
Execute Method: org.codelibs.fess.app.web.admin.fileauth.AdminFileauthAction#search()
annotations: @Execute @Secured{value=[admin-fileauth, admin-fileauth-view]}
Admin action for File Authentication management.
Searches file authentications based on the form criteria.
@param form the search form
@return HTML response for the search results
The search form for File Authentication.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching file authentication settings |
implementations: asHtml(path_AdminFileauth_AdminFileauthJsp)
Execute Method: org.codelibs.fess.app.web.admin.fileauth.AdminFileauthAction#reset()
annotations: @Execute @Secured{value=[admin-fileauth, admin-fileauth-view]}
Admin action for File Authentication management.
Resets the search criteria and displays the default list.
@param form the search form
@return HTML response for the reset list
The search form for File Authentication.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching file authentication settings |
implementations: asHtml(path_AdminFileauth_AdminFileauthJsp)
Execute Method: org.codelibs.fess.app.web.admin.fileauth.AdminFileauthAction#createnew()
annotations: @Execute @Secured{value=[admin-fileauth]}
Admin action for File Authentication management.
Displays the create new file authentication page.
@return HTML response for the create page
implementations: asHtml(path_AdminFileauth_AdminFileauthEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.fileauth.AdminFileauthAction#edit()
annotations: @Execute @Secured{value=[admin-fileauth]}
Admin action for File Authentication management.
Displays the edit file authentication page.
@param form the edit form
@return HTML response for the edit page
Form class for editing file authentication configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the file authentication configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this file authentication configuration |
@Size{max=255} |
| 3 | updatedTime | Long |
The timestamp when this file authentication configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the file authentication configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure |
| 6 | hostname | String |
The hostname of the file server (maximum 100 characters) |
@Size{max=100} |
| 7 | port | Integer |
The port number of the file server (0 to 2147483647) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 8 | protocolScheme | String |
The protocol scheme for file access (maximum 10 characters) |
@Size{max=10} |
| 9 | username | String |
The username for file authentication (required, maximum 100 characters) |
@Required , @Size{max=100} |
| 10 | password | String |
The password for file authentication (maximum 100 characters) |
@Size{max=100} |
| 11 | parameters | String |
Additional parameters for file authentication (maximum 1000 characters) |
@Size{max=1000} |
| 12 | fileConfigId | String |
The ID of the associated file configuration (required, maximum 1000 characters) |
@Required , @Size{max=1000} |
| 13 | createdBy | String |
The user who created this file authentication configuration (maximum 1000 characters) |
@Size{max=1000} |
| 14 | createdTime | Long |
The timestamp when this file authentication configuration was created |
@ValidateTypeFailure |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.fileauth.AdminFileauthAction#details()
annotations: @Execute @Secured{value=[admin-fileauth, admin-fileauth-view]}
Admin action for File Authentication management.
Displays the file authentication details page.
@param crudMode the CRUD mode
@param id the file authentication ID
@return HTML response for the details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD mode |
|
| 2 | id | String |
the file authentication ID |
implementations: asDetailsHtml()
Execute Method: org.codelibs.fess.app.web.admin.fileauth.AdminFileauthAction#create()
annotations: @Execute @Secured{value=[admin-fileauth]}
Admin action for File Authentication management.
Creates a new file authentication.
@param form the create form
@return HTML response after creation
The create form for File Authentication.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure |
| 2 | hostname | String |
The hostname of the file server (maximum 100 characters) |
@Size{max=100} |
| 3 | port | Integer |
The port number of the file server (0 to 2147483647) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 4 | protocolScheme | String |
The protocol scheme for file access (maximum 10 characters) |
@Size{max=10} |
| 5 | username | String |
The username for file authentication (required, maximum 100 characters) |
@Required , @Size{max=100} |
| 6 | password | String |
The password for file authentication (maximum 100 characters) |
@Size{max=100} |
| 7 | parameters | String |
Additional parameters for file authentication (maximum 1000 characters) |
@Size{max=1000} |
| 8 | fileConfigId | String |
The ID of the associated file configuration (required, maximum 1000 characters) |
@Required , @Size{max=1000} |
| 9 | createdBy | String |
The user who created this file authentication configuration (maximum 1000 characters) |
@Size{max=1000} |
| 10 | createdTime | Long |
The timestamp when this file authentication configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.fileauth.AdminFileauthAction#update()
annotations: @Execute @Secured{value=[admin-fileauth]}
Admin action for File Authentication management.
Updates an existing file authentication.
@param form the edit form
@return HTML response after update
Form class for editing file authentication configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the file authentication configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this file authentication configuration |
@Size{max=255} |
| 3 | updatedTime | Long |
The timestamp when this file authentication configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the file authentication configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure |
| 6 | hostname | String |
The hostname of the file server (maximum 100 characters) |
@Size{max=100} |
| 7 | port | Integer |
The port number of the file server (0 to 2147483647) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 8 | protocolScheme | String |
The protocol scheme for file access (maximum 10 characters) |
@Size{max=10} |
| 9 | username | String |
The username for file authentication (required, maximum 100 characters) |
@Required , @Size{max=100} |
| 10 | password | String |
The password for file authentication (maximum 100 characters) |
@Size{max=100} |
| 11 | parameters | String |
Additional parameters for file authentication (maximum 1000 characters) |
@Size{max=1000} |
| 12 | fileConfigId | String |
The ID of the associated file configuration (required, maximum 1000 characters) |
@Required , @Size{max=1000} |
| 13 | createdBy | String |
The user who created this file authentication configuration (maximum 1000 characters) |
@Size{max=1000} |
| 14 | createdTime | Long |
The timestamp when this file authentication configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.fileauth.AdminFileauthAction#delete()
annotations: @Execute @Secured{value=[admin-fileauth]}
Admin action for File Authentication management.
Deletes a file authentication.
@param form the edit form
@return HTML response after deletion
Form class for editing file authentication configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the file authentication configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this file authentication configuration |
@Size{max=255} |
| 3 | updatedTime | Long |
The timestamp when this file authentication configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the file authentication configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure |
| 6 | hostname | String |
The hostname of the file server (maximum 100 characters) |
@Size{max=100} |
| 7 | port | Integer |
The port number of the file server (0 to 2147483647) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 8 | protocolScheme | String |
The protocol scheme for file access (maximum 10 characters) |
@Size{max=10} |
| 9 | username | String |
The username for file authentication (required, maximum 100 characters) |
@Required , @Size{max=100} |
| 10 | password | String |
The password for file authentication (maximum 100 characters) |
@Size{max=100} |
| 11 | parameters | String |
Additional parameters for file authentication (maximum 1000 characters) |
@Size{max=1000} |
| 12 | fileConfigId | String |
The ID of the associated file configuration (required, maximum 1000 characters) |
@Required , @Size{max=1000} |
| 13 | createdBy | String |
The user who created this file authentication configuration (maximum 1000 characters) |
@Size{max=1000} |
| 14 | createdTime | Long |
The timestamp when this file authentication configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.fileconfig.AdminFileconfigAction#index()
annotations: @Execute @Secured{value=[admin-fileconfig, admin-fileconfig-view]}
Admin action for File Config management.
Displays the file configuration list page.
@return HTML response for the list page
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.fileconfig.AdminFileconfigAction#list()
annotations: @Execute @Secured{value=[admin-fileconfig, admin-fileconfig-view]}
Admin action for File Config management.
Displays the file configuration list with pagination.
@param pageNumber the page number
@param form the search form
@return HTML response for the list page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
the page number |
The search form for File Config.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
The name field for searching file configurations |
|
| 2 | paths | String |
The paths field for searching file configurations |
|
| 3 | description | String |
The description field for searching file configurations |
implementations: asHtml(path_AdminFileconfig_AdminFileconfigJsp)
Execute Method: org.codelibs.fess.app.web.admin.fileconfig.AdminFileconfigAction#search()
annotations: @Execute @Secured{value=[admin-fileconfig, admin-fileconfig-view]}
Admin action for File Config management.
Searches file configurations based on the form criteria.
@param form the search form
@return HTML response for the search results
The search form for File Config.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
The name field for searching file configurations |
|
| 2 | paths | String |
The paths field for searching file configurations |
|
| 3 | description | String |
The description field for searching file configurations |
implementations: asHtml(path_AdminFileconfig_AdminFileconfigJsp)
Execute Method: org.codelibs.fess.app.web.admin.fileconfig.AdminFileconfigAction#reset()
annotations: @Execute @Secured{value=[admin-fileconfig, admin-fileconfig-view]}
Admin action for File Config management.
Resets the search criteria and displays the default list.
@param form the search form
@return HTML response for the reset list
The search form for File Config.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
The name field for searching file configurations |
|
| 2 | paths | String |
The paths field for searching file configurations |
|
| 3 | description | String |
The description field for searching file configurations |
implementations: asHtml(path_AdminFileconfig_AdminFileconfigJsp)
Execute Method: org.codelibs.fess.app.web.admin.fileconfig.AdminFileconfigAction#createnew()
annotations: @Execute @Secured{value=[admin-fileconfig]}
Admin action for File Config management.
Displays the create new file configuration page.
@return HTML response for the create page
implementations: asHtml(path_AdminFileconfig_AdminFileconfigEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.fileconfig.AdminFileconfigAction#edit()
annotations: @Execute @Secured{value=[admin-fileconfig]}
Admin action for File Config management.
Displays the edit file configuration page.
@param form the edit form
@return HTML response for the edit page
Form class for editing file crawling configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the file configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this file configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this file configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the file configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | labelTypeIds | String[] |
The IDs of label types associated with this file configuration |
|
| 6 | crudMode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure |
| 7 | name | String |
The name of the file configuration (required, maximum 200 characters) |
@Required , @Size{max=200} |
| 8 | description | String |
The description of the file configuration (maximum 1000 characters) |
@Size{max=1000} |
| 9 | paths | String |
The file paths to crawl (required, must be valid file URIs) |
@Required , @UriType{protocolType=FILE} , @CustomSize{maxKey=form.admin.max.input.size} |
| 10 | includedPaths | String |
The paths to include during crawling (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | excludedPaths | String |
The paths to exclude during crawling (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} |
| 12 | includedDocPaths | String |
The document paths to include in search results (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} |
| 13 | excludedDocPaths | String |
The document paths to exclude from search results (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} |
| 14 | configParameter | String |
Additional configuration parameters for the file crawler |
@CustomSize{maxKey=form.admin.max.input.size} |
| 15 | depth | Integer |
The maximum crawling depth (0 to 2147483647, 0 means unlimited) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 16 | maxAccessCount | Long |
The maximum number of documents to access during crawling (0 means unlimited) |
@Min{value=0} , @Max{value=9223372036854775807} , @ValidateTypeFailure |
| 17 | numOfThread | Integer |
The number of threads to use for crawling (required, 1 to 2147483647) |
@Required , @Min{value=1} , @Max{value=2147483647} , @ValidateTypeFailure |
| 18 | intervalTime | Integer |
The interval time between crawl requests in milliseconds (required, 0 to 2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 19 | boost | Float |
The boost value for search ranking (required) |
@Required , @ValidateTypeFailure |
| 20 | available | String |
Whether this configuration is available for crawling (required, maximum 5 characters) |
@Required , @Size{max=5} |
| 21 | permissions | String |
The permissions required to access documents from this configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 22 | virtualHosts | String |
The virtual hosts associated with this file configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 23 | sortOrder | Integer |
The sort order for this configuration (required, 0 to 2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 24 | createdBy | String |
The user who created this file configuration (maximum 1000 characters) |
@Size{max=1000} |
| 25 | createdTime | Long |
The timestamp when this file configuration was created |
@ValidateTypeFailure |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.fileconfig.AdminFileconfigAction#details()
annotations: @Execute @Secured{value=[admin-fileconfig, admin-fileconfig-view]}
Admin action for File Config management.
Displays the file configuration details page.
@param crudMode the CRUD mode
@param id the file configuration ID
@return HTML response for the details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD mode |
|
| 2 | id | String |
the file configuration ID |
implementations: asHtml(path_AdminFileconfig_AdminFileconfigDetailsJsp)
Execute Method: org.codelibs.fess.app.web.admin.fileconfig.AdminFileconfigAction#create()
annotations: @Execute @Secured{value=[admin-fileconfig]}
Admin action for File Config management.
Creates a new file configuration.
@param form the create form
@return HTML response after creation
The create form for File Config.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | labelTypeIds | String[] |
The IDs of label types associated with this file configuration |
|
| 2 | crudMode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure |
| 3 | name | String |
The name of the file configuration (required, maximum 200 characters) |
@Required , @Size{max=200} |
| 4 | description | String |
The description of the file configuration (maximum 1000 characters) |
@Size{max=1000} |
| 5 | paths | String |
The file paths to crawl (required, must be valid file URIs) |
@Required , @UriType{protocolType=FILE} , @CustomSize{maxKey=form.admin.max.input.size} |
| 6 | includedPaths | String |
The paths to include during crawling (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} |
| 7 | excludedPaths | String |
The paths to exclude during crawling (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} |
| 8 | includedDocPaths | String |
The document paths to include in search results (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} |
| 9 | excludedDocPaths | String |
The document paths to exclude from search results (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} |
| 10 | configParameter | String |
Additional configuration parameters for the file crawler |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | depth | Integer |
The maximum crawling depth (0 to 2147483647, 0 means unlimited) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 12 | maxAccessCount | Long |
The maximum number of documents to access during crawling (0 means unlimited) |
@Min{value=0} , @Max{value=9223372036854775807} , @ValidateTypeFailure |
| 13 | numOfThread | Integer |
The number of threads to use for crawling (required, 1 to 2147483647) |
@Required , @Min{value=1} , @Max{value=2147483647} , @ValidateTypeFailure |
| 14 | intervalTime | Integer |
The interval time between crawl requests in milliseconds (required, 0 to 2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 15 | boost | Float |
The boost value for search ranking (required) |
@Required , @ValidateTypeFailure |
| 16 | available | String |
Whether this configuration is available for crawling (required, maximum 5 characters) |
@Required , @Size{max=5} |
| 17 | permissions | String |
The permissions required to access documents from this configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 18 | virtualHosts | String |
The virtual hosts associated with this file configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 19 | sortOrder | Integer |
The sort order for this configuration (required, 0 to 2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 20 | createdBy | String |
The user who created this file configuration (maximum 1000 characters) |
@Size{max=1000} |
| 21 | createdTime | Long |
The timestamp when this file configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.fileconfig.AdminFileconfigAction#update()
annotations: @Execute @Secured{value=[admin-fileconfig]}
Admin action for File Config management.
Updates an existing file configuration.
@param form the edit form
@return HTML response after update
Form class for editing file crawling configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the file configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this file configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this file configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the file configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | labelTypeIds | String[] |
The IDs of label types associated with this file configuration |
|
| 6 | crudMode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure |
| 7 | name | String |
The name of the file configuration (required, maximum 200 characters) |
@Required , @Size{max=200} |
| 8 | description | String |
The description of the file configuration (maximum 1000 characters) |
@Size{max=1000} |
| 9 | paths | String |
The file paths to crawl (required, must be valid file URIs) |
@Required , @UriType{protocolType=FILE} , @CustomSize{maxKey=form.admin.max.input.size} |
| 10 | includedPaths | String |
The paths to include during crawling (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | excludedPaths | String |
The paths to exclude during crawling (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} |
| 12 | includedDocPaths | String |
The document paths to include in search results (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} |
| 13 | excludedDocPaths | String |
The document paths to exclude from search results (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} |
| 14 | configParameter | String |
Additional configuration parameters for the file crawler |
@CustomSize{maxKey=form.admin.max.input.size} |
| 15 | depth | Integer |
The maximum crawling depth (0 to 2147483647, 0 means unlimited) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 16 | maxAccessCount | Long |
The maximum number of documents to access during crawling (0 means unlimited) |
@Min{value=0} , @Max{value=9223372036854775807} , @ValidateTypeFailure |
| 17 | numOfThread | Integer |
The number of threads to use for crawling (required, 1 to 2147483647) |
@Required , @Min{value=1} , @Max{value=2147483647} , @ValidateTypeFailure |
| 18 | intervalTime | Integer |
The interval time between crawl requests in milliseconds (required, 0 to 2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 19 | boost | Float |
The boost value for search ranking (required) |
@Required , @ValidateTypeFailure |
| 20 | available | String |
Whether this configuration is available for crawling (required, maximum 5 characters) |
@Required , @Size{max=5} |
| 21 | permissions | String |
The permissions required to access documents from this configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 22 | virtualHosts | String |
The virtual hosts associated with this file configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 23 | sortOrder | Integer |
The sort order for this configuration (required, 0 to 2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 24 | createdBy | String |
The user who created this file configuration (maximum 1000 characters) |
@Size{max=1000} |
| 25 | createdTime | Long |
The timestamp when this file configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.fileconfig.AdminFileconfigAction#delete()
annotations: @Execute @Secured{value=[admin-fileconfig]}
Admin action for File Config management.
Deletes a file configuration.
@param form the edit form
@return HTML response after deletion
Form class for editing file crawling configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the file configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this file configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this file configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the file configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | labelTypeIds | String[] |
The IDs of label types associated with this file configuration |
|
| 6 | crudMode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure |
| 7 | name | String |
The name of the file configuration (required, maximum 200 characters) |
@Required , @Size{max=200} |
| 8 | description | String |
The description of the file configuration (maximum 1000 characters) |
@Size{max=1000} |
| 9 | paths | String |
The file paths to crawl (required, must be valid file URIs) |
@Required , @UriType{protocolType=FILE} , @CustomSize{maxKey=form.admin.max.input.size} |
| 10 | includedPaths | String |
The paths to include during crawling (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | excludedPaths | String |
The paths to exclude during crawling (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} |
| 12 | includedDocPaths | String |
The document paths to include in search results (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} |
| 13 | excludedDocPaths | String |
The document paths to exclude from search results (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} |
| 14 | configParameter | String |
Additional configuration parameters for the file crawler |
@CustomSize{maxKey=form.admin.max.input.size} |
| 15 | depth | Integer |
The maximum crawling depth (0 to 2147483647, 0 means unlimited) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 16 | maxAccessCount | Long |
The maximum number of documents to access during crawling (0 means unlimited) |
@Min{value=0} , @Max{value=9223372036854775807} , @ValidateTypeFailure |
| 17 | numOfThread | Integer |
The number of threads to use for crawling (required, 1 to 2147483647) |
@Required , @Min{value=1} , @Max{value=2147483647} , @ValidateTypeFailure |
| 18 | intervalTime | Integer |
The interval time between crawl requests in milliseconds (required, 0 to 2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 19 | boost | Float |
The boost value for search ranking (required) |
@Required , @ValidateTypeFailure |
| 20 | available | String |
Whether this configuration is available for crawling (required, maximum 5 characters) |
@Required , @Size{max=5} |
| 21 | permissions | String |
The permissions required to access documents from this configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 22 | virtualHosts | String |
The virtual hosts associated with this file configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 23 | sortOrder | Integer |
The sort order for this configuration (required, 0 to 2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 24 | createdBy | String |
The user who created this file configuration (maximum 1000 characters) |
@Size{max=1000} |
| 25 | createdTime | Long |
The timestamp when this file configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.general.AdminGeneralAction#index()
annotations: @Execute @Secured{value=[admin-general, admin-general-view]}
Admin action for General settings.
Displays the general settings index page.
@return HTML response for the general settings page
implementations: asHtml(path_AdminGeneral_AdminGeneralJsp)
Execute Method: org.codelibs.fess.app.web.admin.general.AdminGeneralAction#sendmail()
annotations: @Execute @Secured{value=[admin-general]}
Admin action for General settings.
Sends a test mail using the provided notification settings.
@param form the mail form containing notification settings
@return HTML response after sending test mail
The mail form for General settings.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | incrementalCrawling | String |
The incremental crawling setting |
|
| 2 | dayForCleanup | String |
The day for cleanup setting |
|
| 3 | crawlingThreadCount | String |
The crawling thread count setting |
|
| 4 | searchLog | String |
The search log setting |
|
| 5 | userInfo | String |
The user info setting |
|
| 6 | userFavorite | String |
The user favorite setting |
|
| 7 | webApiJson | String |
The web API JSON setting |
|
| 8 | defaultLabelValue | String |
The default label value setting |
|
| 9 | appendQueryParameter | String |
The append query parameter setting |
|
| 10 | loginRequired | String |
The login required setting |
|
| 11 | ignoreFailureType | String |
The ignore failure type setting |
|
| 12 | failureCountThreshold | String |
The failure count threshold setting |
|
| 13 | popularWord | String |
The popular word setting |
|
| 14 | csvFileEncoding | String |
The CSV file encoding setting |
|
| 15 | purgeSearchLogDay | String |
The purge search log day setting |
|
| 16 | purgeJobLogDay | String |
The purge job log day setting |
|
| 17 | purgeUserInfoDay | String |
The purge user info day setting |
|
| 18 | purgeByBots | String |
The purge by bots setting |
|
| 19 | notificationTo | String |
The notification recipient setting |
@Required , @Size{max=1000} |
| 20 | suggestSearchLog | String |
The suggest search log setting |
|
| 21 | suggestDocuments | String |
The suggest documents setting |
|
| 22 | purgeSuggestSearchLogDay | String |
The purge suggest search log day setting |
implementations: redirectByParam(AdminGeneralAction.class, "notificationTo", form.notificationTo)
Execute Method: org.codelibs.fess.app.web.admin.general.AdminGeneralAction#update()
annotations: @Execute @Secured{value=[admin-general]}
Admin action for General settings.
Updates the general system configuration settings.
@param form the edit form containing updated settings
@return HTML response after updating settings
Form class for editing general system settings in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | incrementalCrawling | String |
Enable or disable incremental crawling |
@Size{max=10} |
| 2 | dayForCleanup | Integer |
Number of days to keep crawled documents before cleanup |
@Required , @Min{value=-1} , @Max{value=1000} , @ValidateTypeFailure |
| 3 | crawlingThreadCount | Integer |
Number of threads to use for crawling operations |
@Required , @Min{value=0} , @Max{value=100} , @ValidateTypeFailure |
| 4 | searchLog | String |
Enable or disable search query logging |
@Size{max=10} |
| 5 | userInfo | String |
Enable or disable user information tracking |
@Size{max=10} |
| 6 | userFavorite | String |
Enable or disable user favorite functionality |
@Size{max=10} |
| 7 | webApiJson | String |
Enable or disable JSON Web API |
@Size{max=10} |
| 8 | appValue | String |
Application-specific value for custom configurations |
@Size{max=10000} |
| 9 | defaultLabelValue | String |
Default label value to use when no specific label is selected |
@Size{max=1000} |
| 10 | defaultSortValue | String |
Default sort order for search results |
@Size{max=1000} |
| 11 | virtualHostValue | String |
Virtual host configuration for multi-tenant setups |
@Size{max=10000} |
| 12 | appendQueryParameter | String |
Enable or disable appending query parameters to search URLs |
@Size{max=10} |
| 13 | loginRequired | String |
Enable or disable login requirement for search access |
@Size{max=10} |
| 14 | resultCollapsed | String |
Enable or disable result collapsing for similar documents |
@Size{max=10} |
| 15 | loginLink | String |
Enable or disable display of login link in the search interface |
@Size{max=10} |
| 16 | thumbnail | String |
Enable or disable thumbnail generation for documents |
@Size{max=10} |
| 17 | ignoreFailureType | String |
Types of crawling failures to ignore during crawling operations |
@Size{max=1000} |
| 18 | failureCountThreshold | Integer |
Threshold for failure count before stopping crawling of a URL |
@Required , @Min{value=-1} , @Max{value=10000} , @ValidateTypeFailure |
| 19 | popularWord | String |
Enable or disable popular word tracking and display |
@Size{max=10} |
| 20 | csvFileEncoding | String |
Character encoding to use for CSV file exports |
@Required , @Size{max=20} |
| 21 | purgeSearchLogDay | Integer |
Number of days to keep search logs before purging |
@Min{value=-1} , @Max{value=100000} , @ValidateTypeFailure |
| 22 | purgeJobLogDay | Integer |
Number of days to keep job logs before purging |
@Min{value=-1} , @Max{value=100000} , @ValidateTypeFailure |
| 23 | purgeUserInfoDay | Integer |
Number of days to keep user information before purging |
@Min{value=-1} , @Max{value=100000} , @ValidateTypeFailure |
| 24 | purgeByBots | String |
Bot user agents whose search logs should be purged |
@Size{max=10000} |
| 25 | notificationTo | String |
Email addresses to receive system notifications |
@Size{max=1000} |
| 26 | suggestSearchLog | String |
Enable or disable search suggestions based on search logs |
@Size{max=10} |
| 27 | suggestDocuments | String |
Enable or disable search suggestions based on document content |
@Size{max=10} |
| 28 | purgeSuggestSearchLogDay | Integer |
Number of days to keep suggestion search logs before purging |
@Min{value=0} , @Max{value=100000} , @ValidateTypeFailure |
| 29 | ldapProviderUrl | String |
LDAP server URL for authentication |
@Size{max=1000} |
| 30 | ldapSecurityPrincipal | String |
LDAP security principal for binding to the LDAP server |
@Size{max=1000} |
| 31 | ldapAdminSecurityPrincipal | String |
LDAP admin security principal for administrative operations |
@Size{max=1000} |
| 32 | ldapAdminSecurityCredentials | String |
LDAP admin security credentials (password) for administrative operations |
@Size{max=1000} |
| 33 | ldapBaseDn | String |
LDAP base DN (Distinguished Name) for user searches |
@Size{max=1000} |
| 34 | ldapAccountFilter | String |
LDAP filter for finding user accounts |
@Size{max=1000} |
| 35 | ldapGroupFilter | String |
LDAP filter for finding groups |
@Size{max=1000} |
| 36 | ldapMemberofAttribute | String |
LDAP attribute name for group membership |
@Size{max=100} |
| 37 | notificationLogin | String |
Notification message displayed on the login page |
@Size{max=3000} |
| 38 | notificationSearchTop | String |
Notification message displayed on the search top page |
@Size{max=3000} |
| 39 | logLevel | String |
System log level for controlling log verbosity |
@Size{max=10} |
| 40 | storageEndpoint | String |
Storage service endpoint URL for cloud storage integration |
@Size{max=1000} |
| 41 | storageAccessKey | String |
Access key for cloud storage authentication |
@Size{max=1000} |
| 42 | storageSecretKey | String |
Secret key for cloud storage authentication |
@Size{max=1000} |
| 43 | storageBucket | String |
Storage bucket name for cloud storage operations |
@Size{max=1000} |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.group.AdminGroupAction#index()
annotations: @Execute @Secured{value=[admin-group, admin-group-view]}
Admin action for Group management.
Displays the group list page.
@return HTML response for the list page
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.group.AdminGroupAction#list()
annotations: @Execute @Secured{value=[admin-group, admin-group-view]}
Admin action for Group management.
Displays the group list with pagination.
@param pageNumber the page number
@param form the search form
@return HTML response for the list page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
the page number |
The search form for Group.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching groups |
implementations: asHtml(path_AdminGroup_AdminGroupJsp)
Execute Method: org.codelibs.fess.app.web.admin.group.AdminGroupAction#search()
annotations: @Execute @Secured{value=[admin-group, admin-group-view]}
Admin action for Group management.
Searches groups based on the form criteria.
@param form the search form
@return HTML response for the search results
The search form for Group.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching groups |
implementations: asHtml(path_AdminGroup_AdminGroupJsp)
Execute Method: org.codelibs.fess.app.web.admin.group.AdminGroupAction#reset()
annotations: @Execute @Secured{value=[admin-group, admin-group-view]}
Admin action for Group management.
Resets the search criteria and displays the default list.
@param form the search form
@return HTML response for the reset list
The search form for Group.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching groups |
implementations: asHtml(path_AdminGroup_AdminGroupJsp)
Execute Method: org.codelibs.fess.app.web.admin.group.AdminGroupAction#createnew()
annotations: @Execute @Secured{value=[admin-group]}
Admin action for Group management.
Displays the create new group page.
@return HTML response for the create page
implementations: asHtml(path_AdminGroup_AdminGroupEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.group.AdminGroupAction#edit()
annotations: @Execute @Secured{value=[admin-group]}
Admin action for Group management.
Displays the edit group page.
@param form the edit form
@return HTML response for the edit page
Form class for editing user groups in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the group being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this group |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this group was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the group for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 6 | name | String |
The name of the group |
@Required , @Size{max=100} |
| 7 | attributes | Map<String, String> |
Additional attributes for the group |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.group.AdminGroupAction#details()
annotations: @Execute @Secured{value=[admin-group, admin-group-view]}
Admin action for Group management.
Displays the group details page.
@param crudMode the CRUD mode
@param id the group ID
@return HTML response for the details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD mode |
|
| 2 | id | String |
the group ID |
implementations: asHtml(path_AdminGroup_AdminGroupDetailsJsp)
Execute Method: org.codelibs.fess.app.web.admin.group.AdminGroupAction#create()
annotations: @Execute @Secured{value=[admin-group]}
Admin action for Group management.
Creates a new group.
@param form the create form
@return HTML response after creation
The create form for Group.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 2 | name | String |
The name of the group |
@Required , @Size{max=100} |
| 3 | attributes | Map<String, String> |
Additional attributes for the group |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.group.AdminGroupAction#update()
annotations: @Execute @Secured{value=[admin-group]}
Admin action for Group management.
Updates an existing group.
@param form the edit form
@return HTML response after update
Form class for editing user groups in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the group being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this group |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this group was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the group for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 6 | name | String |
The name of the group |
@Required , @Size{max=100} |
| 7 | attributes | Map<String, String> |
Additional attributes for the group |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.group.AdminGroupAction#delete()
annotations: @Execute @Secured{value=[admin-group]}
Admin action for Group management.
Deletes a group.
@param form the edit form
@return HTML response after deletion
Form class for editing user groups in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the group being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this group |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this group was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the group for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 6 | name | String |
The name of the group |
@Required , @Size{max=100} |
| 7 | attributes | Map<String, String> |
Additional attributes for the group |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.joblog.AdminJoblogAction#index()
annotations: @Execute @Secured{value=[admin-joblog, admin-joblog-view]}
Admin action for Job Log.
Displays the job log list page.
@param form the search form
@return HTML response for the list page
The search form for Job Log.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching job logs |
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.joblog.AdminJoblogAction#list()
annotations: @Execute @Secured{value=[admin-joblog, admin-joblog-view]}
Admin action for Job Log.
Displays the job log list with pagination.
@param pageNumber the page number
@param form the search form
@return HTML response for the list page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | Integer |
the page number |
The search form for Job Log.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching job logs |
implementations: asHtml(path_AdminJoblog_AdminJoblogJsp)
Execute Method: org.codelibs.fess.app.web.admin.joblog.AdminJoblogAction#search()
annotations: @Execute @Secured{value=[admin-joblog, admin-joblog-view]}
Admin action for Job Log.
Searches job logs based on the form criteria.
@param form the search form
@return HTML response for the search results
The search form for Job Log.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching job logs |
implementations: asHtml(path_AdminJoblog_AdminJoblogJsp)
Execute Method: org.codelibs.fess.app.web.admin.joblog.AdminJoblogAction#reset()
annotations: @Execute @Secured{value=[admin-joblog, admin-joblog-view]}
Admin action for Job Log.
Resets the search criteria and displays the default list.
@param form the search form
@return HTML response for the reset list
The search form for Job Log.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching job logs |
implementations: asHtml(path_AdminJoblog_AdminJoblogJsp)
Execute Method: org.codelibs.fess.app.web.admin.joblog.AdminJoblogAction#back()
annotations: @Execute @Secured{value=[admin-joblog, admin-joblog-view]}
Admin action for Job Log.
Returns to the job log list page.
@param form the search form
@return HTML response for the list page
The search form for Job Log.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching job logs |
implementations: asHtml(path_AdminJoblog_AdminJoblogJsp)
Execute Method: org.codelibs.fess.app.web.admin.joblog.AdminJoblogAction#details()
annotations: @Execute @Secured{value=[admin-joblog, admin-joblog-view]}
Admin action for Job Log.
Displays the job log details page.
@param crudMode the CRUD mode
@param id the job log ID
@return HTML response for the details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD mode |
|
| 2 | id | String |
the job log ID |
implementations: asHtml(path_AdminJoblog_AdminJoblogDetailsJsp)
Execute Method: org.codelibs.fess.app.web.admin.joblog.AdminJoblogAction#delete()
annotations: @Execute @Secured{value=[admin-joblog]}
Admin action for Job Log.
Deletes a job log.
@param form the edit form
@return HTML response after deletion
Form class for editing job log entries in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
The CRUD operation mode for this form |
@ValidateTypeFailure |
| 2 | id | String |
The unique identifier of the job log entry being edited |
@Required , @ValidateTypeFailure |
| 3 | jobName | String |
The name of the job that was executed |
@Required |
| 4 | jobStatus | String |
The execution status of the job |
@Required |
| 5 | target | String |
The target or scope of the job execution |
@Required |
| 6 | scriptType | String |
The type of script that was executed for this job |
@Required |
| 7 | scriptData | String |
The script data or code that was executed |
|
| 8 | scriptResult | String |
The result or output from the script execution |
|
| 9 | startTime | String |
The timestamp when the job started execution |
@Required |
| 10 | endTime | String |
The timestamp when the job completed execution |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.joblog.AdminJoblogAction#deleteall()
annotations: @Execute @Secured{value=[admin-joblog]}
Admin action for Job Log.
Deletes all job logs.
@return HTML response after deletion
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.keymatch.AdminKeymatchAction#index()
annotations: @Execute @Secured{value=[admin-keymatch, admin-keymatch-view]}
Admin action for Key Match management.
Displays the key match list page.
@param form the search form
@return HTML response for the list page
The search form for Key Match.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | term | String |
The search term field for key match configuration |
|
| 2 | query | String |
The query field for key match configuration |
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.keymatch.AdminKeymatchAction#list()
annotations: @Execute @Secured{value=[admin-keymatch, admin-keymatch-view]}
Admin action for Key Match management.
Displays the key match list with pagination.
@param pageNumber the page number
@param form the search form
@return HTML response for the list page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
the page number |
The search form for Key Match.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | term | String |
The search term field for key match configuration |
|
| 2 | query | String |
The query field for key match configuration |
implementations: asHtml(path_AdminKeymatch_AdminKeymatchJsp)
Execute Method: org.codelibs.fess.app.web.admin.keymatch.AdminKeymatchAction#search()
annotations: @Execute @Secured{value=[admin-keymatch, admin-keymatch-view]}
Admin action for Key Match management.
Searches key matches based on the form criteria.
@param form the search form
@return HTML response for the search results
The search form for Key Match.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | term | String |
The search term field for key match configuration |
|
| 2 | query | String |
The query field for key match configuration |
implementations: asHtml(path_AdminKeymatch_AdminKeymatchJsp)
Execute Method: org.codelibs.fess.app.web.admin.keymatch.AdminKeymatchAction#reset()
annotations: @Execute @Secured{value=[admin-keymatch, admin-keymatch-view]}
Admin action for Key Match management.
Resets the search criteria and displays the default list.
@param form the search form
@return HTML response for the reset list
The search form for Key Match.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | term | String |
The search term field for key match configuration |
|
| 2 | query | String |
The query field for key match configuration |
implementations: asHtml(path_AdminKeymatch_AdminKeymatchJsp)
Execute Method: org.codelibs.fess.app.web.admin.keymatch.AdminKeymatchAction#createnew()
annotations: @Execute @Secured{value=[admin-keymatch]}
Admin action for Key Match management.
Displays the create new key match page.
@return HTML response for the create page
implementations: asHtml(path_AdminKeymatch_AdminKeymatchEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.keymatch.AdminKeymatchAction#edit()
annotations: @Execute @Secured{value=[admin-keymatch]}
Admin action for Key Match management.
Displays the edit key match page.
@param form the edit form
@return HTML response for the edit page
Form class for editing key match configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the key match configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this key match configuration |
@Size{max=255} |
| 3 | updatedTime | Long |
The timestamp when this key match configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the key match configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 6 | term | String |
The search term that triggers the key match |
@Required , @Size{max=100} |
| 7 | query | String |
The query to execute when the term matches |
@Required , @CustomSize{maxKey=form.admin.max.input.size} |
| 8 | maxSize | Integer |
The maximum number of results to return |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 9 | boost | Float |
The boost score for matched results |
@Required , @ValidateTypeFailure |
| 10 | virtualHost | String |
The virtual host for the key match |
@Size{max=1000} |
| 11 | createdBy | String |
The user who created this key match |
@Size{max=255} |
| 12 | createdTime | Long |
The timestamp when this key match was created |
@ValidateTypeFailure |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.keymatch.AdminKeymatchAction#details()
annotations: @Execute @Secured{value=[admin-keymatch, admin-keymatch-view]}
Admin action for Key Match management.
Displays the key match details page with boosted documents.
@param crudMode the CRUD mode
@param id the key match ID
@return HTML response for the details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD mode |
|
| 2 | id | String |
the key match ID |
implementations: asHtml(path_AdminKeymatch_AdminKeymatchDetailsJsp)
Execute Method: org.codelibs.fess.app.web.admin.keymatch.AdminKeymatchAction#create()
annotations: @Execute @Secured{value=[admin-keymatch]}
Admin action for Key Match management.
Creates a new key match.
@param form the create form
@return HTML response after creation
The create form for Key Match.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 2 | term | String |
The search term that triggers the key match |
@Required , @Size{max=100} |
| 3 | query | String |
The query to execute when the term matches |
@Required , @CustomSize{maxKey=form.admin.max.input.size} |
| 4 | maxSize | Integer |
The maximum number of results to return |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 5 | boost | Float |
The boost score for matched results |
@Required , @ValidateTypeFailure |
| 6 | virtualHost | String |
The virtual host for the key match |
@Size{max=1000} |
| 7 | createdBy | String |
The user who created this key match |
@Size{max=255} |
| 8 | createdTime | Long |
The timestamp when this key match was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.keymatch.AdminKeymatchAction#update()
annotations: @Execute @Secured{value=[admin-keymatch]}
Admin action for Key Match management.
Updates an existing key match.
@param form the edit form
@return HTML response after update
Form class for editing key match configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the key match configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this key match configuration |
@Size{max=255} |
| 3 | updatedTime | Long |
The timestamp when this key match configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the key match configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 6 | term | String |
The search term that triggers the key match |
@Required , @Size{max=100} |
| 7 | query | String |
The query to execute when the term matches |
@Required , @CustomSize{maxKey=form.admin.max.input.size} |
| 8 | maxSize | Integer |
The maximum number of results to return |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 9 | boost | Float |
The boost score for matched results |
@Required , @ValidateTypeFailure |
| 10 | virtualHost | String |
The virtual host for the key match |
@Size{max=1000} |
| 11 | createdBy | String |
The user who created this key match |
@Size{max=255} |
| 12 | createdTime | Long |
The timestamp when this key match was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.keymatch.AdminKeymatchAction#delete()
annotations: @Execute @Secured{value=[admin-keymatch]}
Admin action for Key Match management.
Deletes a key match.
@param form the edit form
@return HTML response after deletion
Form class for editing key match configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the key match configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this key match configuration |
@Size{max=255} |
| 3 | updatedTime | Long |
The timestamp when this key match configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the key match configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 6 | term | String |
The search term that triggers the key match |
@Required , @Size{max=100} |
| 7 | query | String |
The query to execute when the term matches |
@Required , @CustomSize{maxKey=form.admin.max.input.size} |
| 8 | maxSize | Integer |
The maximum number of results to return |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 9 | boost | Float |
The boost score for matched results |
@Required , @ValidateTypeFailure |
| 10 | virtualHost | String |
The virtual host for the key match |
@Size{max=1000} |
| 11 | createdBy | String |
The user who created this key match |
@Size{max=255} |
| 12 | createdTime | Long |
The timestamp when this key match was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.labeltype.AdminLabeltypeAction#index()
annotations: @Execute @Secured{value=[admin-labeltype, admin-labeltype-view]}
Admin action for Label Type management.
Displays the label type list page.
@param form the search form
@return HTML response for the list page
The search form for Label Type.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
The name field for searching label types |
|
| 2 | value | String |
The value field for searching label types |
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.labeltype.AdminLabeltypeAction#list()
annotations: @Execute @Secured{value=[admin-labeltype, admin-labeltype-view]}
Admin action for Label Type management.
Displays the label type list with pagination.
@param pageNumber the page number
@param form the search form
@return HTML response for the list page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
the page number |
The search form for Label Type.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
The name field for searching label types |
|
| 2 | value | String |
The value field for searching label types |
implementations: asHtml(path_AdminLabeltype_AdminLabeltypeJsp)
Execute Method: org.codelibs.fess.app.web.admin.labeltype.AdminLabeltypeAction#search()
annotations: @Execute @Secured{value=[admin-labeltype, admin-labeltype-view]}
Admin action for Label Type management.
Searches label types based on the form criteria.
@param form the search form
@return HTML response for the search results
The search form for Label Type.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
The name field for searching label types |
|
| 2 | value | String |
The value field for searching label types |
implementations: asHtml(path_AdminLabeltype_AdminLabeltypeJsp)
Execute Method: org.codelibs.fess.app.web.admin.labeltype.AdminLabeltypeAction#reset()
annotations: @Execute @Secured{value=[admin-labeltype, admin-labeltype-view]}
Admin action for Label Type management.
Resets the search criteria and displays the default list.
@param form the search form
@return HTML response for the reset list
The search form for Label Type.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
The name field for searching label types |
|
| 2 | value | String |
The value field for searching label types |
implementations: asHtml(path_AdminLabeltype_AdminLabeltypeJsp)
Execute Method: org.codelibs.fess.app.web.admin.labeltype.AdminLabeltypeAction#createnew()
annotations: @Execute @Secured{value=[admin-labeltype]}
Admin action for Label Type management.
Displays the create new label type page.
@return HTML response for the create page
implementations: asHtml(path_AdminLabeltype_AdminLabeltypeEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.labeltype.AdminLabeltypeAction#edit()
annotations: @Execute @Secured{value=[admin-labeltype]}
Admin action for Label Type management.
Displays the edit label type page.
@param form the edit form
@return HTML response for the edit page
Form class for editing label types in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the label type being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this label type |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this label type was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the label type for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 6 | name | String |
The name of the label type |
@Required , @Size{max=100} |
| 7 | value | String |
The value of the label type (alphanumeric and underscore only) |
@Required , @Size{max=100} , @Pattern{regexp=^[a-zA-Z0-9_]+$} |
| 8 | includedPaths | String |
The paths to include for this label type |
@CustomSize{maxKey=form.admin.max.input.size} |
| 9 | excludedPaths | String |
The paths to exclude for this label type |
@CustomSize{maxKey=form.admin.max.input.size} |
| 10 | permissions | String |
The permissions required to view this label type |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | virtualHost | String |
The virtual host for the label type |
@Size{max=1000} |
| 12 | sortOrder | Integer |
The sort order for displaying this label type |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 13 | createdBy | String |
The user who created this label type |
@Size{max=1000} |
| 14 | createdTime | Long |
The timestamp when this label type was created |
@ValidateTypeFailure |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.labeltype.AdminLabeltypeAction#details()
annotations: @Execute @Secured{value=[admin-labeltype, admin-labeltype-view]}
Admin action for Label Type management.
Displays the label type details page.
@param crudMode the CRUD mode
@param id the label type ID
@return HTML response for the details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD mode |
|
| 2 | id | String |
the label type ID |
implementations: asHtml(path_AdminLabeltype_AdminLabeltypeDetailsJsp)
Execute Method: org.codelibs.fess.app.web.admin.labeltype.AdminLabeltypeAction#create()
annotations: @Execute @Secured{value=[admin-labeltype]}
Admin action for Label Type management.
Creates a new label type.
@param form the create form
@return HTML response after creation
The create form for Label Type.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 2 | name | String |
The name of the label type |
@Required , @Size{max=100} |
| 3 | value | String |
The value of the label type (alphanumeric and underscore only) |
@Required , @Size{max=100} , @Pattern{regexp=^[a-zA-Z0-9_]+$} |
| 4 | includedPaths | String |
The paths to include for this label type |
@CustomSize{maxKey=form.admin.max.input.size} |
| 5 | excludedPaths | String |
The paths to exclude for this label type |
@CustomSize{maxKey=form.admin.max.input.size} |
| 6 | permissions | String |
The permissions required to view this label type |
@CustomSize{maxKey=form.admin.max.input.size} |
| 7 | virtualHost | String |
The virtual host for the label type |
@Size{max=1000} |
| 8 | sortOrder | Integer |
The sort order for displaying this label type |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 9 | createdBy | String |
The user who created this label type |
@Size{max=1000} |
| 10 | createdTime | Long |
The timestamp when this label type was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.labeltype.AdminLabeltypeAction#update()
annotations: @Execute @Secured{value=[admin-labeltype]}
Admin action for Label Type management.
Updates an existing label type.
@param form the edit form
@return HTML response after update
Form class for editing label types in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the label type being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this label type |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this label type was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the label type for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 6 | name | String |
The name of the label type |
@Required , @Size{max=100} |
| 7 | value | String |
The value of the label type (alphanumeric and underscore only) |
@Required , @Size{max=100} , @Pattern{regexp=^[a-zA-Z0-9_]+$} |
| 8 | includedPaths | String |
The paths to include for this label type |
@CustomSize{maxKey=form.admin.max.input.size} |
| 9 | excludedPaths | String |
The paths to exclude for this label type |
@CustomSize{maxKey=form.admin.max.input.size} |
| 10 | permissions | String |
The permissions required to view this label type |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | virtualHost | String |
The virtual host for the label type |
@Size{max=1000} |
| 12 | sortOrder | Integer |
The sort order for displaying this label type |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 13 | createdBy | String |
The user who created this label type |
@Size{max=1000} |
| 14 | createdTime | Long |
The timestamp when this label type was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.labeltype.AdminLabeltypeAction#delete()
annotations: @Execute @Secured{value=[admin-labeltype]}
Admin action for Label Type management.
Deletes a label type.
@param form the edit form
@return HTML response after deletion
Form class for editing label types in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the label type being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this label type |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this label type was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the label type for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 6 | name | String |
The name of the label type |
@Required , @Size{max=100} |
| 7 | value | String |
The value of the label type (alphanumeric and underscore only) |
@Required , @Size{max=100} , @Pattern{regexp=^[a-zA-Z0-9_]+$} |
| 8 | includedPaths | String |
The paths to include for this label type |
@CustomSize{maxKey=form.admin.max.input.size} |
| 9 | excludedPaths | String |
The paths to exclude for this label type |
@CustomSize{maxKey=form.admin.max.input.size} |
| 10 | permissions | String |
The permissions required to view this label type |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | virtualHost | String |
The virtual host for the label type |
@Size{max=1000} |
| 12 | sortOrder | Integer |
The sort order for displaying this label type |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 13 | createdBy | String |
The user who created this label type |
@Size{max=1000} |
| 14 | createdTime | Long |
The timestamp when this label type was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.log.AdminLogAction#index()
annotations: @Execute @Secured{value=[admin-log, admin-log-view]}
Admin action for Log.
Displays the log management index page.
@return HTML response for the log list page
implementations: asIndexHtml()
Execute Method: org.codelibs.fess.app.web.admin.log.AdminLogAction#download()
annotations: @Execute @Secured{value=[admin-log, admin-log-view]}
Admin action for Log.
Downloads a log file by its encoded ID.
@param id the Base64 encoded filename of the log file to download
@return ActionResponse containing the log file stream
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the Base64 encoded filename of the log file to download |
Execute Method: org.codelibs.fess.app.web.admin.maintenance.AdminMaintenanceAction#index()
annotations: @Execute @Secured{value=[admin-maintenance, admin-maintenance-view]}
Admin action for maintenance operations including reindexing, log management,
and system diagnostics.
Displays the main maintenance page.
@return HTML response for the maintenance index page
implementations: asIndexHtml()
Execute Method: org.codelibs.fess.app.web.admin.maintenance.AdminMaintenanceAction#reindexOnly()
annotations: @Execute @Secured{value=[admin-maintenance]}
Admin action for maintenance operations including reindexing, log management,
and system diagnostics.
Starts a reindex operation based on the provided form parameters.
@param form the action form containing reindex configuration
@return HTML response redirecting to the maintenance page
The form for maintenance actions.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | replaceAliases | String |
The flag to replace aliases |
@Size{max=10} |
| 2 | resetDictionaries | String |
The flag to reset dictionaries |
@Size{max=10} |
| 3 | numberOfShardsForDoc | String |
The number of shards for doc |
@Size{max=10} |
| 4 | autoExpandReplicasForDoc | String |
The auto expand replicas for doc |
@Size{max=10} |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.maintenance.AdminMaintenanceAction#reloadDocIndex()
annotations: @Execute @Secured{value=[admin-maintenance]}
Admin action for maintenance operations including reindexing, log management,
and system diagnostics.
Reloads the document index by closing and reopening it.
@param form the action form (validated but not used for configuration)
@return HTML response redirecting to the maintenance page
The form for maintenance actions.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | replaceAliases | String |
The flag to replace aliases |
@Size{max=10} |
| 2 | resetDictionaries | String |
The flag to reset dictionaries |
@Size{max=10} |
| 3 | numberOfShardsForDoc | String |
The number of shards for doc |
@Size{max=10} |
| 4 | autoExpandReplicasForDoc | String |
The auto expand replicas for doc |
@Size{max=10} |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.maintenance.AdminMaintenanceAction#clearCrawlerIndex()
annotations: @Execute @Secured{value=[admin-maintenance]}
Admin action for maintenance operations including reindexing, log management,
and system diagnostics.
Clears all crawler indices including queue, data, and filter indices.
@param form the action form (validated but not used for configuration)
@return HTML response redirecting to the maintenance page
The form for maintenance actions.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | replaceAliases | String |
The flag to replace aliases |
@Size{max=10} |
| 2 | resetDictionaries | String |
The flag to reset dictionaries |
@Size{max=10} |
| 3 | numberOfShardsForDoc | String |
The number of shards for doc |
@Size{max=10} |
| 4 | autoExpandReplicasForDoc | String |
The auto expand replicas for doc |
@Size{max=10} |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.maintenance.AdminMaintenanceAction#downloadLogs()
annotations: @Execute @Secured{value=[admin-maintenance, admin-maintenance-view]}
Admin action for maintenance operations including reindexing, log management,
and system diagnostics.
Downloads diagnostic logs and system information as a ZIP file.
@param form the action form (validated but not used for configuration)
@return streaming response containing the diagnostic ZIP file
The form for maintenance actions.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | replaceAliases | String |
The flag to replace aliases |
@Size{max=10} |
| 2 | resetDictionaries | String |
The flag to reset dictionaries |
@Size{max=10} |
| 3 | numberOfShardsForDoc | String |
The number of shards for doc |
@Size{max=10} |
| 4 | autoExpandReplicasForDoc | String |
The auto expand replicas for doc |
@Size{max=10} |
Execute Method: org.codelibs.fess.app.web.admin.pathmap.AdminPathmapAction#index()
annotations: @Execute @Secured{value=[admin-pathmap, admin-pathmap-view]}
Admin action for Path Map management.
Displays the main path mapping administration page.
@param form the search form containing search criteria
@return HTML response for the path mapping list page
The search form for Path Map.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | regex | String |
The regular expression pattern field for path mapping |
|
| 2 | replacement | String |
The replacement string field for path mapping |
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.pathmap.AdminPathmapAction#list()
annotations: @Execute @Secured{value=[admin-pathmap, admin-pathmap-view]}
Admin action for Path Map management.
Displays the path mapping list with pagination support.
@param pageNumber the optional page number for pagination
@param form the search form containing search criteria
@return HTML response for the path mapping list page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
the optional page number for pagination |
The search form for Path Map.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | regex | String |
The regular expression pattern field for path mapping |
|
| 2 | replacement | String |
The replacement string field for path mapping |
implementations: asHtml(path_AdminPathmap_AdminPathmapJsp)
Execute Method: org.codelibs.fess.app.web.admin.pathmap.AdminPathmapAction#search()
annotations: @Execute @Secured{value=[admin-pathmap, admin-pathmap-view]}
Admin action for Path Map management.
Performs a search for path mappings based on the provided criteria.
@param form the search form containing search criteria
@return HTML response with search results
The search form for Path Map.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | regex | String |
The regular expression pattern field for path mapping |
|
| 2 | replacement | String |
The replacement string field for path mapping |
implementations: asHtml(path_AdminPathmap_AdminPathmapJsp)
Execute Method: org.codelibs.fess.app.web.admin.pathmap.AdminPathmapAction#reset()
annotations: @Execute @Secured{value=[admin-pathmap, admin-pathmap-view]}
Admin action for Path Map management.
Resets the search criteria and displays all path mappings.
@param form the search form to be reset
@return HTML response for the path mapping list page
The search form for Path Map.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | regex | String |
The regular expression pattern field for path mapping |
|
| 2 | replacement | String |
The replacement string field for path mapping |
implementations: asHtml(path_AdminPathmap_AdminPathmapJsp)
Execute Method: org.codelibs.fess.app.web.admin.pathmap.AdminPathmapAction#createnew()
annotations: @Execute @Secured{value=[admin-pathmap]}
Admin action for Path Map management.
Displays the form for creating a new path mapping.
@return HTML response for the path mapping creation form
implementations: asHtml(path_AdminPathmap_AdminPathmapEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.pathmap.AdminPathmapAction#edit()
annotations: @Execute @Secured{value=[admin-pathmap]}
Admin action for Path Map management.
Displays the form for editing an existing path mapping.
@param form the edit form containing the path mapping ID and data
@return HTML response for the path mapping edit form
Form class for editing path mapping configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the path mapping configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this path mapping configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this path mapping configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the path mapping configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure |
| 6 | regex | String |
The regular expression pattern to match request paths |
@Required , @Size{max=1000} |
| 7 | replacement | String |
The replacement pattern for matched paths |
@Size{max=1000} |
| 8 | processType | String |
The processing type for path mapping |
@Required |
| 9 | sortOrder | Integer |
The sort order for this path mapping (0-2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 10 | createdBy | String |
The username who created this path mapping |
@Size{max=1000} |
| 11 | createdTime | Long |
The timestamp when this path mapping was created |
@ValidateTypeFailure |
| 12 | userAgent | String |
The user agent string for this path mapping |
@Size{max=1000} |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.pathmap.AdminPathmapAction#details()
annotations: @Execute @Secured{value=[admin-pathmap, admin-pathmap-view]}
Admin action for Path Map management.
Displays the details of a specific path mapping.
@param crudMode the CRUD operation mode
@param id the ID of the path mapping to display
@return HTML response for the path mapping details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD operation mode |
|
| 2 | id | String |
the ID of the path mapping to display |
implementations: asHtml(path_AdminPathmap_AdminPathmapDetailsJsp)
Execute Method: org.codelibs.fess.app.web.admin.pathmap.AdminPathmapAction#create()
annotations: @Execute @Secured{value=[admin-pathmap]}
Admin action for Path Map management.
Creates a new path mapping based on the provided form data.
@param form the create form containing the new path mapping data
@return HTML response redirecting to the path mapping list page
The create form for Path Map.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure |
| 2 | regex | String |
The regular expression pattern to match request paths |
@Required , @Size{max=1000} |
| 3 | replacement | String |
The replacement pattern for matched paths |
@Size{max=1000} |
| 4 | processType | String |
The processing type for path mapping |
@Required |
| 5 | sortOrder | Integer |
The sort order for this path mapping (0-2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 6 | createdBy | String |
The username who created this path mapping |
@Size{max=1000} |
| 7 | createdTime | Long |
The timestamp when this path mapping was created |
@ValidateTypeFailure |
| 8 | userAgent | String |
The user agent string for this path mapping |
@Size{max=1000} |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.pathmap.AdminPathmapAction#update()
annotations: @Execute @Secured{value=[admin-pathmap]}
Admin action for Path Map management.
Updates an existing path mapping with the provided form data.
@param form the edit form containing the updated path mapping data
@return HTML response redirecting to the path mapping list page
Form class for editing path mapping configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the path mapping configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this path mapping configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this path mapping configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the path mapping configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure |
| 6 | regex | String |
The regular expression pattern to match request paths |
@Required , @Size{max=1000} |
| 7 | replacement | String |
The replacement pattern for matched paths |
@Size{max=1000} |
| 8 | processType | String |
The processing type for path mapping |
@Required |
| 9 | sortOrder | Integer |
The sort order for this path mapping (0-2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 10 | createdBy | String |
The username who created this path mapping |
@Size{max=1000} |
| 11 | createdTime | Long |
The timestamp when this path mapping was created |
@ValidateTypeFailure |
| 12 | userAgent | String |
The user agent string for this path mapping |
@Size{max=1000} |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.pathmap.AdminPathmapAction#delete()
annotations: @Execute @Secured{value=[admin-pathmap]}
Admin action for Path Map management.
Deletes a path mapping based on the provided form data.
@param form the edit form containing the path mapping ID to delete
@return HTML response redirecting to the path mapping list page
Form class for editing path mapping configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the path mapping configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this path mapping configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this path mapping configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the path mapping configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure |
| 6 | regex | String |
The regular expression pattern to match request paths |
@Required , @Size{max=1000} |
| 7 | replacement | String |
The replacement pattern for matched paths |
@Size{max=1000} |
| 8 | processType | String |
The processing type for path mapping |
@Required |
| 9 | sortOrder | Integer |
The sort order for this path mapping (0-2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 10 | createdBy | String |
The username who created this path mapping |
@Size{max=1000} |
| 11 | createdTime | Long |
The timestamp when this path mapping was created |
@ValidateTypeFailure |
| 12 | userAgent | String |
The user agent string for this path mapping |
@Size{max=1000} |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.plugin.AdminPluginAction#index()
annotations: @Execute @Secured{value=[admin-plugin, admin-plugin-view]}
Admin action for Plugin management.
This class provides functionality for installing, deleting, and managing plugins in the Fess system.
Displays the plugin management index page.
@return HTML response for the index page
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.plugin.AdminPluginAction#delete()
annotations: @Execute @Secured{value=[admin-plugin]}
Admin action for Plugin management.
This class provides functionality for installing, deleting, and managing plugins in the Fess system.
Deletes the specified plugin.
@param form the delete form containing plugin information
@return HTML response redirecting to the plugin list
Form class for plugin deletion operations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
The name of the plugin to delete |
@Required , @Size{max=100} |
| 2 | version | String |
The version of the plugin to delete |
@Size{max=100} |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.plugin.AdminPluginAction#install()
annotations: @Execute @Secured{value=[admin-plugin]}
Admin action for Plugin management.
This class provides functionality for installing, deleting, and managing plugins in the Fess system.
Installs a plugin from either an uploaded JAR file or from the available artifacts.
@param form the install form containing plugin installation details
@return HTML response redirecting to the plugin list
Form for plugin installation through the admin web interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
Plugin identifier (required, max 400 characters) |
@Required , @Size{max=400} |
| 2 | jarFile | MultipartFormFile |
JAR file containing the plugin to install |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.plugin.AdminPluginAction#installplugin()
annotations: @Execute @Secured{value=[admin-plugin]}
Admin action for Plugin management.
This class provides functionality for installing, deleting, and managing plugins in the Fess system.
Displays the plugin installation page with available plugins.
@return HTML response for the plugin installation page
implementations: asHtml(path_AdminPlugin_AdminPluginInstallpluginJsp)
Execute Method: org.codelibs.fess.app.web.admin.relatedcontent.AdminRelatedcontentAction#index()
annotations: @Execute @Secured{value=[admin-relatedcontent, admin-relatedcontent-view]}
Admin action for Related Content management.
Displays the related content management index page.
@return HTML response for the related content list page
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.relatedcontent.AdminRelatedcontentAction#list()
annotations: @Execute @Secured{value=[admin-relatedcontent, admin-relatedcontent-view]}
Admin action for Related Content management.
Displays a paginated list of related content items.
@param pageNumber the page number to display (optional)
@param form the search form containing filter criteria
@return HTML response with the related content list
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
the page number to display |
The search form for Related Content.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | term | String |
The search term field for related content |
|
| 2 | content | String |
The content field for searching related content |
implementations: asHtml(path_AdminRelatedcontent_AdminRelatedcontentJsp)
Execute Method: org.codelibs.fess.app.web.admin.relatedcontent.AdminRelatedcontentAction#search()
annotations: @Execute @Secured{value=[admin-relatedcontent, admin-relatedcontent-view]}
Admin action for Related Content management.
Searches for related content items based on the provided search criteria.
@param form the search form containing search criteria
@return HTML response with filtered related content results
The search form for Related Content.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | term | String |
The search term field for related content |
|
| 2 | content | String |
The content field for searching related content |
implementations: asHtml(path_AdminRelatedcontent_AdminRelatedcontentJsp)
Execute Method: org.codelibs.fess.app.web.admin.relatedcontent.AdminRelatedcontentAction#reset()
annotations: @Execute @Secured{value=[admin-relatedcontent, admin-relatedcontent-view]}
Admin action for Related Content management.
Resets the search criteria and displays all related content items.
@param form the search form to reset
@return HTML response with the reset related content list
The search form for Related Content.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | term | String |
The search term field for related content |
|
| 2 | content | String |
The content field for searching related content |
implementations: asHtml(path_AdminRelatedcontent_AdminRelatedcontentJsp)
Execute Method: org.codelibs.fess.app.web.admin.relatedcontent.AdminRelatedcontentAction#createnew()
annotations: @Execute @Secured{value=[admin-relatedcontent]}
Admin action for Related Content management.
Displays the form for creating a new related content item.
@return HTML response for the create form
implementations: asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.relatedcontent.AdminRelatedcontentAction#edit()
annotations: @Execute @Secured{value=[admin-relatedcontent]}
Admin action for Related Content management.
Displays the form for editing an existing related content item.
@param form the edit form containing the ID of the item to edit
@return HTML response for the edit form
Form class for editing related content configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the related content configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this related content configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this related content configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the related content configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure |
| 6 | term | String |
The search term for which related content is shown |
@Required , @Size{max=10000} |
| 7 | content | String |
The related content to be displayed |
@Required , @Size{max=10000} |
| 8 | virtualHost | String |
The virtual host for which this related content applies |
@Size{max=1000} |
| 9 | sortOrder | Integer |
The sort order for this related content (0-2147483647) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 10 | createdBy | String |
The username who created this related content |
@Size{max=1000} |
| 11 | createdTime | Long |
The timestamp when this related content was created |
@ValidateTypeFailure |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.relatedcontent.AdminRelatedcontentAction#details()
annotations: @Execute @Secured{value=[admin-relatedcontent, admin-relatedcontent-view]}
Admin action for Related Content management.
Displays the details of a related content item.
@param crudMode the CRUD mode for the operation
@param id the ID of the related content item to display
@return HTML response for the details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD mode for the operation |
|
| 2 | id | String |
the ID of the related content item to display |
implementations: asDetailsHtml()
Execute Method: org.codelibs.fess.app.web.admin.relatedcontent.AdminRelatedcontentAction#create()
annotations: @Execute @Secured{value=[admin-relatedcontent]}
Admin action for Related Content management.
Creates a new related content item.
@param form the create form containing the new item data
@return HTML response redirecting to the list page after creation
The create form for managing related content.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure |
| 2 | term | String |
The search term for which related content is shown |
@Required , @Size{max=10000} |
| 3 | content | String |
The related content to be displayed |
@Required , @Size{max=10000} |
| 4 | virtualHost | String |
The virtual host for which this related content applies |
@Size{max=1000} |
| 5 | sortOrder | Integer |
The sort order for this related content (0-2147483647) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 6 | createdBy | String |
The username who created this related content |
@Size{max=1000} |
| 7 | createdTime | Long |
The timestamp when this related content was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.relatedcontent.AdminRelatedcontentAction#update()
annotations: @Execute @Secured{value=[admin-relatedcontent]}
Admin action for Related Content management.
Updates an existing related content item.
@param form the edit form containing the updated item data
@return HTML response redirecting to the list page after update
Form class for editing related content configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the related content configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this related content configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this related content configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the related content configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure |
| 6 | term | String |
The search term for which related content is shown |
@Required , @Size{max=10000} |
| 7 | content | String |
The related content to be displayed |
@Required , @Size{max=10000} |
| 8 | virtualHost | String |
The virtual host for which this related content applies |
@Size{max=1000} |
| 9 | sortOrder | Integer |
The sort order for this related content (0-2147483647) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 10 | createdBy | String |
The username who created this related content |
@Size{max=1000} |
| 11 | createdTime | Long |
The timestamp when this related content was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.relatedcontent.AdminRelatedcontentAction#delete()
annotations: @Execute @Secured{value=[admin-relatedcontent]}
Admin action for Related Content management.
Deletes a related content item.
@param form the edit form containing the ID of the item to delete
@return HTML response redirecting to the list page after deletion
Form class for editing related content configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the related content configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this related content configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this related content configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the related content configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure |
| 6 | term | String |
The search term for which related content is shown |
@Required , @Size{max=10000} |
| 7 | content | String |
The related content to be displayed |
@Required , @Size{max=10000} |
| 8 | virtualHost | String |
The virtual host for which this related content applies |
@Size{max=1000} |
| 9 | sortOrder | Integer |
The sort order for this related content (0-2147483647) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 10 | createdBy | String |
The username who created this related content |
@Size{max=1000} |
| 11 | createdTime | Long |
The timestamp when this related content was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.relatedquery.AdminRelatedqueryAction#index()
annotations: @Execute @Secured{value=[admin-relatedquery, admin-relatedquery-view]}
Admin action for Related Query management.
Displays the related query management index page.
@return HTML response for the related query list page
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.relatedquery.AdminRelatedqueryAction#list()
annotations: @Execute @Secured{value=[admin-relatedquery, admin-relatedquery-view]}
Admin action for Related Query management.
Displays a paginated list of related query items.
@param pageNumber the page number to display (optional)
@param form the search form containing filter criteria
@return HTML response with the related query list
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
the page number to display |
The search form for Related Query.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | term | String |
The search term field for related queries |
|
| 2 | queries | String |
The queries field for searching related queries |
implementations: asHtml(path_AdminRelatedquery_AdminRelatedqueryJsp)
Execute Method: org.codelibs.fess.app.web.admin.relatedquery.AdminRelatedqueryAction#search()
annotations: @Execute @Secured{value=[admin-relatedquery, admin-relatedquery-view]}
Admin action for Related Query management.
Searches for related query items based on the provided search criteria.
@param form the search form containing search criteria
@return HTML response with filtered related query results
The search form for Related Query.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | term | String |
The search term field for related queries |
|
| 2 | queries | String |
The queries field for searching related queries |
implementations: asHtml(path_AdminRelatedquery_AdminRelatedqueryJsp)
Execute Method: org.codelibs.fess.app.web.admin.relatedquery.AdminRelatedqueryAction#reset()
annotations: @Execute @Secured{value=[admin-relatedquery, admin-relatedquery-view]}
Admin action for Related Query management.
Resets the search criteria and displays all related query items.
@param form the search form to reset
@return HTML response with the reset related query list
The search form for Related Query.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | term | String |
The search term field for related queries |
|
| 2 | queries | String |
The queries field for searching related queries |
implementations: asHtml(path_AdminRelatedquery_AdminRelatedqueryJsp)
Execute Method: org.codelibs.fess.app.web.admin.relatedquery.AdminRelatedqueryAction#createnew()
annotations: @Execute @Secured{value=[admin-relatedquery]}
Admin action for Related Query management.
Displays the form for creating a new related query item.
@return HTML response for the create form
implementations: asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.relatedquery.AdminRelatedqueryAction#edit()
annotations: @Execute @Secured{value=[admin-relatedquery]}
Admin action for Related Query management.
Displays the form for editing an existing related query item.
@param form the edit form containing the ID of the item to edit
@return HTML response for the edit form
The edit form for Related Query.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
Unique identifier for the related query entry |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
Username of the user who last updated this entry |
@Size{max=1000} |
| 3 | updatedTime | Long |
Timestamp when this entry was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
Version number for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure |
| 6 | term | String |
The search term for which related queries are shown |
@Required , @Size{max=10000} |
| 7 | queries | String |
The related queries to be suggested (one per line) |
@Required , @Size{max=10000} |
| 8 | virtualHost | String |
The virtual host for which these related queries apply |
@Size{max=1000} |
| 9 | createdBy | String |
The username who created these related queries |
@Size{max=1000} |
| 10 | createdTime | Long |
The timestamp when these related queries were created |
@ValidateTypeFailure |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.relatedquery.AdminRelatedqueryAction#details()
annotations: @Execute @Secured{value=[admin-relatedquery, admin-relatedquery-view]}
Admin action for Related Query management.
Displays the details of a related query item.
@param crudMode the CRUD mode for the operation
@param id the ID of the related query item to display
@return HTML response for the details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD mode for the operation |
|
| 2 | id | String |
the ID of the related query item to display |
implementations: asDetailsHtml()
Execute Method: org.codelibs.fess.app.web.admin.relatedquery.AdminRelatedqueryAction#create()
annotations: @Execute @Secured{value=[admin-relatedquery]}
Admin action for Related Query management.
Creates a new related query item.
@param form the create form containing the new item data
@return HTML response redirecting to the list page after creation
The create form for managing related queries.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure |
| 2 | term | String |
The search term for which related queries are shown |
@Required , @Size{max=10000} |
| 3 | queries | String |
The related queries to be suggested (one per line) |
@Required , @Size{max=10000} |
| 4 | virtualHost | String |
The virtual host for which these related queries apply |
@Size{max=1000} |
| 5 | createdBy | String |
The username who created these related queries |
@Size{max=1000} |
| 6 | createdTime | Long |
The timestamp when these related queries were created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.relatedquery.AdminRelatedqueryAction#update()
annotations: @Execute @Secured{value=[admin-relatedquery]}
Admin action for Related Query management.
Updates an existing related query item.
@param form the edit form containing the updated item data
@return HTML response redirecting to the list page after update
The edit form for Related Query.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
Unique identifier for the related query entry |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
Username of the user who last updated this entry |
@Size{max=1000} |
| 3 | updatedTime | Long |
Timestamp when this entry was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
Version number for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure |
| 6 | term | String |
The search term for which related queries are shown |
@Required , @Size{max=10000} |
| 7 | queries | String |
The related queries to be suggested (one per line) |
@Required , @Size{max=10000} |
| 8 | virtualHost | String |
The virtual host for which these related queries apply |
@Size{max=1000} |
| 9 | createdBy | String |
The username who created these related queries |
@Size{max=1000} |
| 10 | createdTime | Long |
The timestamp when these related queries were created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.relatedquery.AdminRelatedqueryAction#delete()
annotations: @Execute @Secured{value=[admin-relatedquery]}
Admin action for Related Query management.
Deletes a related query item.
@param form the edit form containing the ID of the item to delete
@return HTML response redirecting to the list page after deletion
The edit form for Related Query.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
Unique identifier for the related query entry |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
Username of the user who last updated this entry |
@Size{max=1000} |
| 3 | updatedTime | Long |
Timestamp when this entry was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
Version number for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure |
| 6 | term | String |
The search term for which related queries are shown |
@Required , @Size{max=10000} |
| 7 | queries | String |
The related queries to be suggested (one per line) |
@Required , @Size{max=10000} |
| 8 | virtualHost | String |
The virtual host for which these related queries apply |
@Size{max=1000} |
| 9 | createdBy | String |
The username who created these related queries |
@Size{max=1000} |
| 10 | createdTime | Long |
The timestamp when these related queries were created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.reqheader.AdminReqheaderAction#index()
annotations: @Execute @Secured{value=[admin-reqheader, admin-reqheader-view]}
Admin action for Request Header management.
Displays the request header management index page.
@param form the search form for filtering
@return HTML response for the request header list page
The search form for Request Header.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching request headers |
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.reqheader.AdminReqheaderAction#list()
annotations: @Execute @Secured{value=[admin-reqheader, admin-reqheader-view]}
Admin action for Request Header management.
Displays a paginated list of request header items.
@param pageNumber the page number to display (optional)
@param form the search form containing filter criteria
@return HTML response with the request header list
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
the page number to display |
The search form for Request Header.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching request headers |
implementations: asHtml(path_AdminReqheader_AdminReqheaderJsp)
Execute Method: org.codelibs.fess.app.web.admin.reqheader.AdminReqheaderAction#search()
annotations: @Execute @Secured{value=[admin-reqheader, admin-reqheader-view]}
Admin action for Request Header management.
Searches for request header items based on the provided search criteria.
@param form the search form containing search criteria
@return HTML response with filtered request header results
The search form for Request Header.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching request headers |
implementations: asHtml(path_AdminReqheader_AdminReqheaderJsp)
Execute Method: org.codelibs.fess.app.web.admin.reqheader.AdminReqheaderAction#reset()
annotations: @Execute @Secured{value=[admin-reqheader, admin-reqheader-view]}
Admin action for Request Header management.
Resets the search criteria and displays all request header items.
@param form the search form to reset
@return HTML response with the reset request header list
The search form for Request Header.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching request headers |
implementations: asHtml(path_AdminReqheader_AdminReqheaderJsp)
Execute Method: org.codelibs.fess.app.web.admin.reqheader.AdminReqheaderAction#createnew()
annotations: @Execute @Secured{value=[admin-reqheader]}
Admin action for Request Header management.
Displays the form for creating a new request header item.
@return HTML response for the create form
implementations: asHtml(path_AdminReqheader_AdminReqheaderEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.reqheader.AdminReqheaderAction#edit()
annotations: @Execute @Secured{value=[admin-reqheader]}
Admin action for Request Header management.
Displays the form for editing an existing request header item.
@param form the edit form containing the ID of the item to edit
@return HTML response for the edit form
Form class for editing request header configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the request header configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this request header configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this request header configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the request header configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 6 | name | String |
The name of the request header |
@Required , @Size{max=100} |
| 7 | value | String |
The value of the request header |
@Required , @Size{max=1000} |
| 8 | webConfigId | String |
The web configuration ID associated with this request header |
@Required , @Size{max=1000} |
| 9 | createdBy | String |
The username of who created this request header |
@Size{max=1000} |
| 10 | createdTime | Long |
The timestamp when this request header was created |
@ValidateTypeFailure |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.reqheader.AdminReqheaderAction#details()
annotations: @Execute @Secured{value=[admin-reqheader, admin-reqheader-view]}
Admin action for Request Header management.
Displays the details of a request header item.
@param crudMode the CRUD mode for the operation
@param id the ID of the request header item to display
@return HTML response for the details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD mode for the operation |
|
| 2 | id | String |
the ID of the request header item to display |
implementations: asDetailsHtml()
Execute Method: org.codelibs.fess.app.web.admin.reqheader.AdminReqheaderAction#create()
annotations: @Execute @Secured{value=[admin-reqheader]}
Admin action for Request Header management.
Creates a new request header item.
@param form the create form containing the new item data
@return HTML response redirecting to the list page after creation
The create form for Request Header.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 2 | name | String |
The name of the request header |
@Required , @Size{max=100} |
| 3 | value | String |
The value of the request header |
@Required , @Size{max=1000} |
| 4 | webConfigId | String |
The web configuration ID associated with this request header |
@Required , @Size{max=1000} |
| 5 | createdBy | String |
The username of who created this request header |
@Size{max=1000} |
| 6 | createdTime | Long |
The timestamp when this request header was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.reqheader.AdminReqheaderAction#update()
annotations: @Execute @Secured{value=[admin-reqheader]}
Admin action for Request Header management.
Updates an existing request header item.
@param form the edit form containing the updated item data
@return HTML response redirecting to the list page after update
Form class for editing request header configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the request header configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this request header configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this request header configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the request header configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 6 | name | String |
The name of the request header |
@Required , @Size{max=100} |
| 7 | value | String |
The value of the request header |
@Required , @Size{max=1000} |
| 8 | webConfigId | String |
The web configuration ID associated with this request header |
@Required , @Size{max=1000} |
| 9 | createdBy | String |
The username of who created this request header |
@Size{max=1000} |
| 10 | createdTime | Long |
The timestamp when this request header was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.reqheader.AdminReqheaderAction#delete()
annotations: @Execute @Secured{value=[admin-reqheader]}
Admin action for Request Header management.
Deletes a request header item.
@param form the edit form containing the ID of the item to delete
@return HTML response redirecting to the list page after deletion
Form class for editing request header configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the request header configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this request header configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this request header configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the request header configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 6 | name | String |
The name of the request header |
@Required , @Size{max=100} |
| 7 | value | String |
The value of the request header |
@Required , @Size{max=1000} |
| 8 | webConfigId | String |
The web configuration ID associated with this request header |
@Required , @Size{max=1000} |
| 9 | createdBy | String |
The username of who created this request header |
@Size{max=1000} |
| 10 | createdTime | Long |
The timestamp when this request header was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.role.AdminRoleAction#index()
annotations: @Execute @Secured{value=[admin-role, admin-role-view]}
Admin action for Role management.
Displays the role management index page.
@param form the search form for filtering
@return HTML response for the role list page
The search form for Role.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching roles |
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.role.AdminRoleAction#list()
annotations: @Execute @Secured{value=[admin-role, admin-role-view]}
Admin action for Role management.
Displays a paginated list of role items.
@param pageNumber the page number to display (optional)
@param form the search form containing filter criteria
@return HTML response with the role list
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
the page number to display |
The search form for Role.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching roles |
implementations: asHtml(path_AdminRole_AdminRoleJsp)
Execute Method: org.codelibs.fess.app.web.admin.role.AdminRoleAction#search()
annotations: @Execute @Secured{value=[admin-role, admin-role-view]}
Admin action for Role management.
Searches for role items based on the provided search criteria.
@param form the search form containing search criteria
@return HTML response with filtered role results
The search form for Role.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching roles |
implementations: asHtml(path_AdminRole_AdminRoleJsp)
Execute Method: org.codelibs.fess.app.web.admin.role.AdminRoleAction#reset()
annotations: @Execute @Secured{value=[admin-role, admin-role-view]}
Admin action for Role management.
Resets the search criteria and displays all role items.
@param form the search form to reset
@return HTML response with the reset role list
The search form for Role.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching roles |
implementations: asHtml(path_AdminRole_AdminRoleJsp)
Execute Method: org.codelibs.fess.app.web.admin.role.AdminRoleAction#createnew()
annotations: @Execute @Secured{value=[admin-role]}
Admin action for Role management.
Displays the form for creating a new role item.
@return HTML response for the create form
implementations: asHtml(path_AdminRole_AdminRoleEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.role.AdminRoleAction#details()
annotations: @Execute @Secured{value=[admin-role, admin-role-view]}
Admin action for Role management.
Displays the details of a role item.
@param crudMode the CRUD mode for the operation
@param id the ID of the role item to display
@return HTML response for the details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD mode for the operation |
|
| 2 | id | String |
the ID of the role item to display |
implementations: asHtml(path_AdminRole_AdminRoleDetailsJsp)
Execute Method: org.codelibs.fess.app.web.admin.role.AdminRoleAction#create()
annotations: @Execute @Secured{value=[admin-role]}
Admin action for Role management.
Creates a new role item.
@param form the create form containing the new item data
@return HTML response redirecting to the list page after creation
The create form for Role.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 2 | name | String |
The name of the role |
@Required , @Size{max=100} |
| 3 | attributes | Map<String, String> |
The attributes map for the role |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.role.AdminRoleAction#delete()
annotations: @Execute @Secured{value=[admin-role]}
Admin action for Role management.
Deletes a role item.
@param form the edit form containing the ID of the item to delete
@return HTML response redirecting to the list page after deletion
Form class for editing user roles in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the role being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this role |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this role was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the role for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 6 | name | String |
The name of the role |
@Required , @Size{max=100} |
| 7 | attributes | Map<String, String> |
The attributes map for the role |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.scheduler.AdminSchedulerAction#index()
annotations: @Execute @Secured{value=[admin-scheduler, admin-scheduler-view]}
Admin action for Scheduler management.
Displays the scheduler management index page.
@param form the search form for filtering
@return HTML response for the scheduler list page
The search form for Scheduler.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching scheduled jobs |
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.scheduler.AdminSchedulerAction#list()
annotations: @Execute @Secured{value=[admin-scheduler, admin-scheduler-view]}
Admin action for Scheduler management.
Displays a paginated list of scheduled jobs.
@param pageNumber the page number to display (optional)
@param form the search form containing filter criteria
@return HTML response with the scheduled job list
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
the page number to display |
The search form for Scheduler.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching scheduled jobs |
implementations: asHtml(path_AdminScheduler_AdminSchedulerJsp)
Execute Method: org.codelibs.fess.app.web.admin.scheduler.AdminSchedulerAction#search()
annotations: @Execute @Secured{value=[admin-scheduler, admin-scheduler-view]}
Admin action for Scheduler management.
Searches for scheduled jobs based on the provided search criteria.
@param form the search form containing search criteria
@return HTML response with filtered scheduled job results
The search form for Scheduler.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching scheduled jobs |
implementations: asHtml(path_AdminScheduler_AdminSchedulerJsp)
Execute Method: org.codelibs.fess.app.web.admin.scheduler.AdminSchedulerAction#reset()
annotations: @Execute @Secured{value=[admin-scheduler, admin-scheduler-view]}
Admin action for Scheduler management.
Resets the search criteria and displays all scheduled jobs.
@param form the search form to reset
@return HTML response with the reset scheduled job list
The search form for Scheduler.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching scheduled jobs |
implementations: asHtml(path_AdminScheduler_AdminSchedulerJsp)
Execute Method: org.codelibs.fess.app.web.admin.scheduler.AdminSchedulerAction#createnewjob()
annotations: @Execute @Secured{value=[admin-scheduler]}
Admin action for Scheduler management.
Creates a new scheduled job from a crawler configuration.
@param type the crawler type (web, file, or data)
@param id the crawler configuration ID
@param name the name for the new job (base64 encoded)
@return HTML response for the job creation form
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | type | String |
the crawler type |
|
| 2 | id | String |
the crawler configuration ID |
|
| 3 | name | String |
the name for the new job |
implementations: asHtml(path_AdminScheduler_AdminSchedulerEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.scheduler.AdminSchedulerAction#createnew()
annotations: @Execute @Secured{value=[admin-scheduler]}
Admin action for Scheduler management.
Displays the form for creating a new scheduled job.
@return HTML response for the job creation form
implementations: asHtml(path_AdminScheduler_AdminSchedulerEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.scheduler.AdminSchedulerAction#edit()
annotations: @Execute @Secured{value=[admin-scheduler]}
Admin action for Scheduler management.
Displays the form for editing an existing scheduled job.
@param form the edit form containing the ID of the job to edit
@return HTML response for the job edit form
Form class for editing scheduled job configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the scheduler being edited |
@Required , @Size{max=1000} |
| 2 | versionNo | Integer |
The version number of the scheduler for optimistic locking |
@Required , @ValidateTypeFailure |
| 3 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 4 | name | String |
The name of the scheduled job |
@Required , @Size{max=100} |
| 5 | target | String |
The target class for the scheduled job |
@Required , @Size{max=100} |
| 6 | cronExpression | String |
The cron expression defining when the job should run |
@Size{max=100} , @CronExpression |
| 7 | scriptType | String |
The type of script for the scheduled job |
@Required , @Size{max=100} |
| 8 | scriptData | String |
The script data or code for the scheduled job |
@CustomSize{maxKey=form.admin.max.input.size} |
| 9 | crawler | String |
Whether this job is related to crawling |
|
| 10 | jobLogging | String |
Whether job logging is enabled |
|
| 11 | available | String |
Whether the scheduled job is available/enabled |
|
| 12 | sortOrder | Integer |
The sort order for displaying this scheduled job |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 13 | createdBy | String |
The username of who created this scheduled job |
@Size{max=1000} |
| 14 | createdTime | Long |
The timestamp when this scheduled job was created |
@ValidateTypeFailure |
implementations: asDetailsHtml(id),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.scheduler.AdminSchedulerAction#details()
annotations: @Execute @Secured{value=[admin-scheduler, admin-scheduler-view]}
Admin action for Scheduler management.
Displays the details of a scheduled job.
@param crudMode the CRUD mode for the operation
@param id the ID of the scheduled job to display
@return HTML response for the job details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD mode for the operation |
|
| 2 | id | String |
the ID of the scheduled job to display |
implementations: asHtml(path_AdminScheduler_AdminSchedulerDetailsJsp)
Execute Method: org.codelibs.fess.app.web.admin.scheduler.AdminSchedulerAction#create()
annotations: @Execute @Secured{value=[admin-scheduler]}
Admin action for Scheduler management.
Creates a new scheduled job.
@param form the create form containing the new job data
@return HTML response redirecting to the list page after creation
The create form for Scheduler.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 2 | name | String |
The name of the scheduled job |
@Required , @Size{max=100} |
| 3 | target | String |
The target class for the scheduled job |
@Required , @Size{max=100} |
| 4 | cronExpression | String |
The cron expression defining when the job should run |
@Size{max=100} , @CronExpression |
| 5 | scriptType | String |
The type of script for the scheduled job |
@Required , @Size{max=100} |
| 6 | scriptData | String |
The script data or code for the scheduled job |
@CustomSize{maxKey=form.admin.max.input.size} |
| 7 | crawler | String |
Whether this job is related to crawling |
|
| 8 | jobLogging | String |
Whether job logging is enabled |
|
| 9 | available | String |
Whether the scheduled job is available/enabled |
|
| 10 | sortOrder | Integer |
The sort order for displaying this scheduled job |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 11 | createdBy | String |
The username of who created this scheduled job |
@Size{max=1000} |
| 12 | createdTime | Long |
The timestamp when this scheduled job was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.scheduler.AdminSchedulerAction#update()
annotations: @Execute @Secured{value=[admin-scheduler]}
Admin action for Scheduler management.
Updates an existing scheduled job.
@param form the edit form containing the updated job data
@return HTML response redirecting to the list page after update
Form class for editing scheduled job configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the scheduler being edited |
@Required , @Size{max=1000} |
| 2 | versionNo | Integer |
The version number of the scheduler for optimistic locking |
@Required , @ValidateTypeFailure |
| 3 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 4 | name | String |
The name of the scheduled job |
@Required , @Size{max=100} |
| 5 | target | String |
The target class for the scheduled job |
@Required , @Size{max=100} |
| 6 | cronExpression | String |
The cron expression defining when the job should run |
@Size{max=100} , @CronExpression |
| 7 | scriptType | String |
The type of script for the scheduled job |
@Required , @Size{max=100} |
| 8 | scriptData | String |
The script data or code for the scheduled job |
@CustomSize{maxKey=form.admin.max.input.size} |
| 9 | crawler | String |
Whether this job is related to crawling |
|
| 10 | jobLogging | String |
Whether job logging is enabled |
|
| 11 | available | String |
Whether the scheduled job is available/enabled |
|
| 12 | sortOrder | Integer |
The sort order for displaying this scheduled job |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 13 | createdBy | String |
The username of who created this scheduled job |
@Size{max=1000} |
| 14 | createdTime | Long |
The timestamp when this scheduled job was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.scheduler.AdminSchedulerAction#delete()
annotations: @Execute @Secured{value=[admin-scheduler]}
Admin action for Scheduler management.
Deletes a scheduled job.
@param form the edit form containing the ID of the job to delete
@return HTML response redirecting to the list page after deletion
Form class for editing scheduled job configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the scheduler being edited |
@Required , @Size{max=1000} |
| 2 | versionNo | Integer |
The version number of the scheduler for optimistic locking |
@Required , @ValidateTypeFailure |
| 3 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 4 | name | String |
The name of the scheduled job |
@Required , @Size{max=100} |
| 5 | target | String |
The target class for the scheduled job |
@Required , @Size{max=100} |
| 6 | cronExpression | String |
The cron expression defining when the job should run |
@Size{max=100} , @CronExpression |
| 7 | scriptType | String |
The type of script for the scheduled job |
@Required , @Size{max=100} |
| 8 | scriptData | String |
The script data or code for the scheduled job |
@CustomSize{maxKey=form.admin.max.input.size} |
| 9 | crawler | String |
Whether this job is related to crawling |
|
| 10 | jobLogging | String |
Whether job logging is enabled |
|
| 11 | available | String |
Whether the scheduled job is available/enabled |
|
| 12 | sortOrder | Integer |
The sort order for displaying this scheduled job |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 13 | createdBy | String |
The username of who created this scheduled job |
@Size{max=1000} |
| 14 | createdTime | Long |
The timestamp when this scheduled job was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.scheduler.AdminSchedulerAction#start()
annotations: @Execute @Secured{value=[admin-scheduler]}
Admin action for Scheduler management.
Starts a scheduled job.
@param form the edit form containing the ID of the job to start
@return HTML response redirecting to the list page after starting
Form class for editing scheduled job configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the scheduler being edited |
@Required , @Size{max=1000} |
| 2 | versionNo | Integer |
The version number of the scheduler for optimistic locking |
@Required , @ValidateTypeFailure |
| 3 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 4 | name | String |
The name of the scheduled job |
@Required , @Size{max=100} |
| 5 | target | String |
The target class for the scheduled job |
@Required , @Size{max=100} |
| 6 | cronExpression | String |
The cron expression defining when the job should run |
@Size{max=100} , @CronExpression |
| 7 | scriptType | String |
The type of script for the scheduled job |
@Required , @Size{max=100} |
| 8 | scriptData | String |
The script data or code for the scheduled job |
@CustomSize{maxKey=form.admin.max.input.size} |
| 9 | crawler | String |
Whether this job is related to crawling |
|
| 10 | jobLogging | String |
Whether job logging is enabled |
|
| 11 | available | String |
Whether the scheduled job is available/enabled |
|
| 12 | sortOrder | Integer |
The sort order for displaying this scheduled job |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 13 | createdBy | String |
The username of who created this scheduled job |
@Size{max=1000} |
| 14 | createdTime | Long |
The timestamp when this scheduled job was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.scheduler.AdminSchedulerAction#stop()
annotations: @Execute @Secured{value=[admin-scheduler]}
Admin action for Scheduler management.
Stops a running scheduled job.
@param form the edit form containing the ID of the job to stop
@return HTML response redirecting to the list page after stopping
Form class for editing scheduled job configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the scheduler being edited |
@Required , @Size{max=1000} |
| 2 | versionNo | Integer |
The version number of the scheduler for optimistic locking |
@Required , @ValidateTypeFailure |
| 3 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 4 | name | String |
The name of the scheduled job |
@Required , @Size{max=100} |
| 5 | target | String |
The target class for the scheduled job |
@Required , @Size{max=100} |
| 6 | cronExpression | String |
The cron expression defining when the job should run |
@Size{max=100} , @CronExpression |
| 7 | scriptType | String |
The type of script for the scheduled job |
@Required , @Size{max=100} |
| 8 | scriptData | String |
The script data or code for the scheduled job |
@CustomSize{maxKey=form.admin.max.input.size} |
| 9 | crawler | String |
Whether this job is related to crawling |
|
| 10 | jobLogging | String |
Whether job logging is enabled |
|
| 11 | available | String |
Whether the scheduled job is available/enabled |
|
| 12 | sortOrder | Integer |
The sort order for displaying this scheduled job |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 13 | createdBy | String |
The username of who created this scheduled job |
@Size{max=1000} |
| 14 | createdTime | Long |
The timestamp when this scheduled job was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.searchlist.AdminSearchlistAction#index()
annotations: @Execute @Secured{value=[admin-searchlist, admin-searchlist-view]}
Web-specific implementation of SearchRenderData for rendering search results in the admin interface.
Displays the search list management index page.
@param form the list form for filtering
@return HTML response for the search list page
The list form for Search List.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | q | String |
The search query string |
@Size{max=1000} |
| 2 | sort | String |
The sort field and direction |
|
| 3 | start | Integer |
The start position for search results |
@ValidateTypeFailure |
| 4 | offset | Integer |
The offset for pagination |
@ValidateTypeFailure |
| 5 | pn | Integer |
The page number |
@ValidateTypeFailure |
| 6 | num | Integer |
The number of results to display |
@ValidateTypeFailure |
| 7 | lang | String[] |
The languages |
|
| 8 | fields | Map<String, String[]> |
The fields |
|
| 9 | as | Map<String, String[]> |
The conditions |
|
| 10 | ex_q | String[] |
The extra queries |
|
| 11 | sdh | String |
The similar document hash |
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.searchlist.AdminSearchlistAction#search()
annotations: @Execute @Secured{value=[admin-searchlist, admin-searchlist-view]}
Web-specific implementation of SearchRenderData for rendering search results in the admin interface.
Executes a search based on the provided search criteria.
@param form the list form containing search criteria
@return HTML response with search results
The list form for Search List.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | q | String |
The search query string |
@Size{max=1000} |
| 2 | sort | String |
The sort field and direction |
|
| 3 | start | Integer |
The start position for search results |
@ValidateTypeFailure |
| 4 | offset | Integer |
The offset for pagination |
@ValidateTypeFailure |
| 5 | pn | Integer |
The page number |
@ValidateTypeFailure |
| 6 | num | Integer |
The number of results to display |
@ValidateTypeFailure |
| 7 | lang | String[] |
The languages |
|
| 8 | fields | Map<String, String[]> |
The fields |
|
| 9 | as | Map<String, String[]> |
The conditions |
|
| 10 | ex_q | String[] |
The extra queries |
|
| 11 | sdh | String |
The similar document hash |
implementations: doSearch(form)
Execute Method: org.codelibs.fess.app.web.admin.searchlist.AdminSearchlistAction#prev()
annotations: @Execute @Secured{value=[admin-searchlist, admin-searchlist-view]}
Web-specific implementation of SearchRenderData for rendering search results in the admin interface.
Navigates to the previous page of search results.
@param form the list form containing current search criteria
@return HTML response with previous page results
The list form for Search List.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | q | String |
The search query string |
@Size{max=1000} |
| 2 | sort | String |
The sort field and direction |
|
| 3 | start | Integer |
The start position for search results |
@ValidateTypeFailure |
| 4 | offset | Integer |
The offset for pagination |
@ValidateTypeFailure |
| 5 | pn | Integer |
The page number |
@ValidateTypeFailure |
| 6 | num | Integer |
The number of results to display |
@ValidateTypeFailure |
| 7 | lang | String[] |
The languages |
|
| 8 | fields | Map<String, String[]> |
The fields |
|
| 9 | as | Map<String, String[]> |
The conditions |
|
| 10 | ex_q | String[] |
The extra queries |
|
| 11 | sdh | String |
The similar document hash |
implementations: doMove(form, -1)
Execute Method: org.codelibs.fess.app.web.admin.searchlist.AdminSearchlistAction#next()
annotations: @Execute @Secured{value=[admin-searchlist, admin-searchlist-view]}
Web-specific implementation of SearchRenderData for rendering search results in the admin interface.
Navigates to the next page of search results.
@param form the list form containing current search criteria
@return HTML response with next page results
The list form for Search List.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | q | String |
The search query string |
@Size{max=1000} |
| 2 | sort | String |
The sort field and direction |
|
| 3 | start | Integer |
The start position for search results |
@ValidateTypeFailure |
| 4 | offset | Integer |
The offset for pagination |
@ValidateTypeFailure |
| 5 | pn | Integer |
The page number |
@ValidateTypeFailure |
| 6 | num | Integer |
The number of results to display |
@ValidateTypeFailure |
| 7 | lang | String[] |
The languages |
|
| 8 | fields | Map<String, String[]> |
The fields |
|
| 9 | as | Map<String, String[]> |
The conditions |
|
| 10 | ex_q | String[] |
The extra queries |
|
| 11 | sdh | String |
The similar document hash |
implementations: doMove(form, 1)
Execute Method: org.codelibs.fess.app.web.admin.searchlist.AdminSearchlistAction#move()
annotations: @Execute @Secured{value=[admin-searchlist, admin-searchlist-view]}
Web-specific implementation of SearchRenderData for rendering search results in the admin interface.
Navigates to a specific page of search results.
@param form the list form containing target page information
@return HTML response with specified page results
The list form for Search List.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | q | String |
The search query string |
@Size{max=1000} |
| 2 | sort | String |
The sort field and direction |
|
| 3 | start | Integer |
The start position for search results |
@ValidateTypeFailure |
| 4 | offset | Integer |
The offset for pagination |
@ValidateTypeFailure |
| 5 | pn | Integer |
The page number |
@ValidateTypeFailure |
| 6 | num | Integer |
The number of results to display |
@ValidateTypeFailure |
| 7 | lang | String[] |
The languages |
|
| 8 | fields | Map<String, String[]> |
The fields |
|
| 9 | as | Map<String, String[]> |
The conditions |
|
| 10 | ex_q | String[] |
The extra queries |
|
| 11 | sdh | String |
The similar document hash |
implementations: doMove(form, 0)
Execute Method: org.codelibs.fess.app.web.admin.searchlist.AdminSearchlistAction#delete()
annotations: @Execute @Secured{value=[admin-searchlist]}
Web-specific implementation of SearchRenderData for rendering search results in the admin interface.
Deletes a single document from the search index.
@param form the delete form containing document ID
@return HTML response redirecting to the list page
Form class for deleting documents from search results in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | q | String |
The search query used to find the document |
@Size{max=1000} |
| 2 | docId | String |
The document ID of the document to delete |
@Required |
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.searchlist.AdminSearchlistAction#deleteall()
annotations: @Execute @Secured{value=[admin-searchlist, admin-searchlist-view]}
Web-specific implementation of SearchRenderData for rendering search results in the admin interface.
Deletes all documents matching the current search query.
@param form the list form containing search criteria
@return HTML response redirecting to the list page
The list form for Search List.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | q | String |
The search query string |
@Size{max=1000} |
| 2 | sort | String |
The sort field and direction |
|
| 3 | start | Integer |
The start position for search results |
@ValidateTypeFailure |
| 4 | offset | Integer |
The offset for pagination |
@ValidateTypeFailure |
| 5 | pn | Integer |
The page number |
@ValidateTypeFailure |
| 6 | num | Integer |
The number of results to display |
@ValidateTypeFailure |
| 7 | lang | String[] |
The languages |
|
| 8 | fields | Map<String, String[]> |
The fields |
|
| 9 | as | Map<String, String[]> |
The conditions |
|
| 10 | ex_q | String[] |
The extra queries |
|
| 11 | sdh | String |
The similar document hash |
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.searchlist.AdminSearchlistAction#createnew()
annotations: @Execute @Secured{value=[admin-searchlist]}
Web-specific implementation of SearchRenderData for rendering search results in the admin interface.
Displays the form for creating a new document.
@param form the create form
@return HTML response for the document creation form
The create form for Search List.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 2 | doc | Map<String, Object> |
The document data for search list operations |
|
| 3 | q | String |
The search query string |
implementations: asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.searchlist.AdminSearchlistAction#edit()
annotations: @Execute @Secured{value=[admin-searchlist]}
Web-specific implementation of SearchRenderData for rendering search results in the admin interface.
Displays the form for editing an existing document.
@param form the edit form containing document ID
@return HTML response for the document edit form
The edit form for Search List.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
Unique identifier for the search list entry |
|
| 2 | seqNo | Long |
Sequence number for ordering search list entries |
@ValidateTypeFailure |
| 3 | primaryTerm | Long |
Primary term value for search list configuration |
@ValidateTypeFailure |
| 4 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 5 | doc | Map<String, Object> |
The document data for search list operations |
|
| 6 | q | String |
The search query string |
implementations: asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.searchlist.AdminSearchlistAction#create()
annotations: @Execute @Secured{value=[admin-searchlist]}
Web-specific implementation of SearchRenderData for rendering search results in the admin interface.
Creates a new document in the search index.
@param form the create form containing document data
@return HTML response redirecting to the list page after creation
The create form for Search List.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 2 | doc | Map<String, Object> |
The document data for search list operations |
|
| 3 | q | String |
The search query string |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.searchlist.AdminSearchlistAction#update()
annotations: @Execute @Secured{value=[admin-searchlist]}
Web-specific implementation of SearchRenderData for rendering search results in the admin interface.
Updates an existing document in the search index.
@param form the edit form containing updated document data
@return HTML response redirecting to the search results after update
The edit form for Search List.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
Unique identifier for the search list entry |
|
| 2 | seqNo | Long |
Sequence number for ordering search list entries |
@ValidateTypeFailure |
| 3 | primaryTerm | Long |
Primary term value for search list configuration |
@ValidateTypeFailure |
| 4 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 5 | doc | Map<String, Object> |
The document data for search list operations |
|
| 6 | q | String |
The search query string |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.searchlog.AdminSearchlogAction#index()
annotations: @Execute @Secured{value=[admin-searchlog, admin-searchlog-view]}
Admin action for Search Log.
Displays the search log management index page.
@return HTML response for the search log list page
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.searchlog.AdminSearchlogAction#list()
annotations: @Execute @Secured{value=[admin-searchlog, admin-searchlog-view]}
Admin action for Search Log.
Displays a paginated list of search log entries.
@param pageNumber the page number to display
@param form the search form containing filter criteria
@return HTML response with the search log list
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | Integer |
the page number to display |
The search form for Search Log.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | logType | String |
The log type field for filtering search logs |
|
| 2 | queryId | String |
The query ID field for searching specific queries |
|
| 3 | userSessionId | String |
The user session ID field for filtering logs by session |
|
| 4 | requestedTimeRange | String |
The requested time range field for filtering logs by date |
|
| 5 | accessType | String |
The access type field for filtering logs by access method |
|
| 6 | size | String |
The size field for controlling page size |
implementations: asHtml(path_AdminSearchlog_AdminSearchlogJsp)
Execute Method: org.codelibs.fess.app.web.admin.searchlog.AdminSearchlogAction#search()
annotations: @Execute @Secured{value=[admin-searchlog, admin-searchlog-view]}
Admin action for Search Log.
Searches for search log entries based on the provided search criteria.
@param form the search form containing search criteria
@return HTML response with filtered search log results
The search form for Search Log.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | logType | String |
The log type field for filtering search logs |
|
| 2 | queryId | String |
The query ID field for searching specific queries |
|
| 3 | userSessionId | String |
The user session ID field for filtering logs by session |
|
| 4 | requestedTimeRange | String |
The requested time range field for filtering logs by date |
|
| 5 | accessType | String |
The access type field for filtering logs by access method |
|
| 6 | size | String |
The size field for controlling page size |
implementations: asHtml(path_AdminSearchlog_AdminSearchlogJsp)
Execute Method: org.codelibs.fess.app.web.admin.searchlog.AdminSearchlogAction#reset()
annotations: @Execute @Secured{value=[admin-searchlog, admin-searchlog-view]}
Admin action for Search Log.
Resets the search criteria and displays all search log entries.
@param form the search form to reset
@return HTML response with the reset search log list
The search form for Search Log.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | logType | String |
The log type field for filtering search logs |
|
| 2 | queryId | String |
The query ID field for searching specific queries |
|
| 3 | userSessionId | String |
The user session ID field for filtering logs by session |
|
| 4 | requestedTimeRange | String |
The requested time range field for filtering logs by date |
|
| 5 | accessType | String |
The access type field for filtering logs by access method |
|
| 6 | size | String |
The size field for controlling page size |
implementations: asHtml(path_AdminSearchlog_AdminSearchlogJsp)
Execute Method: org.codelibs.fess.app.web.admin.searchlog.AdminSearchlogAction#back()
annotations: @Execute @Secured{value=[admin-searchlog, admin-searchlog-view]}
Admin action for Search Log.
Returns to the search log list from a detail view.
@param form the search form containing current state
@return HTML response for the search log list page
The search form for Search Log.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | logType | String |
The log type field for filtering search logs |
|
| 2 | queryId | String |
The query ID field for searching specific queries |
|
| 3 | userSessionId | String |
The user session ID field for filtering logs by session |
|
| 4 | requestedTimeRange | String |
The requested time range field for filtering logs by date |
|
| 5 | accessType | String |
The access type field for filtering logs by access method |
|
| 6 | size | String |
The size field for controlling page size |
implementations: asHtml(path_AdminSearchlog_AdminSearchlogJsp)
Execute Method: org.codelibs.fess.app.web.admin.searchlog.AdminSearchlogAction#details()
annotations: @Execute @Secured{value=[admin-searchlog, admin-searchlog-view]}
Admin action for Search Log.
Displays the details of a specific search log entry.
@param crudMode the CRUD mode for the operation
@param logType the type of log entry
@param id the ID of the search log entry to display
@return HTML response for the search log details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD mode for the operation |
|
| 2 | logType | String |
the type of log entry |
|
| 3 | id | String |
the ID of the search log entry to display |
implementations: asDetailsHtml()
Execute Method: org.codelibs.fess.app.web.admin.searchlog.AdminSearchlogAction#delete()
annotations: @Execute @Secured{value=[admin-searchlog]}
Admin action for Search Log.
Deletes a specific search log entry.
@param form the edit form containing the log entry information
@return HTML response redirecting to the list page after deletion
The edit form for Search Log.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
CRUD operation mode indicator |
@ValidateTypeFailure |
| 2 | logType | String |
Type of the search log entry |
@Required , @Size{max=10} |
| 3 | id | String |
Unique identifier for the search log entry |
@Required , @Size{max=1000} |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.searchlog.AdminSearchlogAction#deleteall()
annotations: @Execute @Secured{value=[admin-searchlog]}
Admin action for Search Log.
Deletes all search log entries.
@return HTML response redirecting to the list page after deletion
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.sereq.AdminSereqAction#index()
annotations: @Execute @Secured{value=[admin-sereq, admin-sereq-view]}
Admin action for Search Request.
Displays the search request management index page.
@return HTML response for the search request page
implementations: asListHtml(this::saveToken)
Execute Method: org.codelibs.fess.app.web.admin.sereq.AdminSereqAction#upload()
annotations: @Execute @Secured{value=[admin-sereq]}
Admin action for Search Request.
Processes uploaded search request files and executes them against the search engine.
@param form the upload form containing the request file
@return action response with the search results or error page
Form for uploading search request files to the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | requestFile | MultipartFormFile |
The multipart file containing the search request configurations to be uploaded |
@Required |
Execute Method: org.codelibs.fess.app.web.admin.storage.AdminStorageAction#index()
annotations: @Execute @Secured{value=[admin-storage, admin-storage-view]}
Container class for path information containing separate path and name components.
Displays the storage management index page.
@return HTML response for the storage list page
implementations: asListHtml(StringUtil.EMPTY)
Execute Method: org.codelibs.fess.app.web.admin.storage.AdminStorageAction#list()
annotations: @Execute @Secured{value=[admin-storage, admin-storage-view]}
Container class for path information containing separate path and name components.
Displays a list of files and directories in the specified path.
@param id the encoded path ID to list (optional)
@return action response with the storage list or redirect
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | OptionalThing<String> |
the encoded path ID to list |
Execute Method: org.codelibs.fess.app.web.admin.storage.AdminStorageAction#upload()
annotations: @Execute @Secured{value=[admin-storage]}
Container class for path information containing separate path and name components.
Uploads a file to the storage system.
@param form the item form containing file and path information
@return HTML response redirecting to the storage list after upload
Form class for storage item operations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | path | String |
The path of the storage item |
|
| 2 | name | String |
The name of the storage item, limited to 100 characters |
@Size{max=100} |
| 3 | uploadFile | MultipartFormFile |
The file to be uploaded for the storage item |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.storage.AdminStorageAction#download()
annotations: @Execute @Secured{value=[admin-storage, admin-storage-view]}
Container class for path information containing separate path and name components.
Downloads a file from the storage system.
@param id the encoded ID of the file to download
@return action response with the file stream for download
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the encoded ID of the file to download |
Execute Method: org.codelibs.fess.app.web.admin.storage.AdminStorageAction#delete()
annotations: @Execute @Secured{value=[admin-storage]}
Container class for path information containing separate path and name components.
Deletes a file from the storage system.
@param id the encoded ID of the file to delete
@return HTML response redirecting to the storage list after deletion
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the encoded ID of the file to delete |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.storage.AdminStorageAction#createDir()
annotations: @Execute @Secured{value=[admin-storage]}
Container class for path information containing separate path and name components.
Creates a new directory in the storage system.
@param form the item form containing directory information
@return HTML response redirecting to the new directory
Form class for storage item operations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | path | String |
The path of the storage item |
|
| 2 | name | String |
The name of the storage item, limited to 100 characters |
@Size{max=100} |
| 3 | uploadFile | MultipartFormFile |
The file to be uploaded for the storage item |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.storage.AdminStorageAction#editTags()
annotations: @Execute @Secured{value=[admin-storage]}
Container class for path information containing separate path and name components.
Displays the form for editing object tags.
@param form the tag form containing object information
@return HTML response for the tag editing form
Form class for handling tag operations in storage management.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | path | String |
The file or directory path associated with this tag |
@Required |
| 2 | name | String |
The name of the tag with a maximum length of 100 characters |
@Required , @Size{max=100} |
| 3 | tags | Map<String, String> |
A map containing additional tag metadata as key-value pairs |
implementations: asEditTagsHtml(form.path, form.name)
Execute Method: org.codelibs.fess.app.web.admin.storage.AdminStorageAction#updateTags()
annotations: @Execute @Secured{value=[admin-storage]}
Container class for path information containing separate path and name components.
Updates the tags for a storage object.
@param form the tag form containing updated tag information
@return HTML response redirecting to the storage list after update
Form class for handling tag operations in storage management.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | path | String |
The file or directory path associated with this tag |
@Required |
| 2 | name | String |
The name of the tag with a maximum length of 100 characters |
@Required , @Size{max=100} |
| 3 | tags | Map<String, String> |
A map containing additional tag metadata as key-value pairs |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.suggest.AdminSuggestAction#index()
annotations: @Execute @Secured{value=[admin-suggest, admin-suggest-view]}
Admin action for suggest management.
Displays the suggest management index page.
@return HTML response for the suggest management page
implementations: asHtml(path_AdminSuggest_AdminSuggestJsp)
Execute Method: org.codelibs.fess.app.web.admin.suggest.AdminSuggestAction#deleteAllWords()
annotations: @Execute @Secured{value=[admin-suggest]}
Admin action for suggest management.
Deletes all suggest words from the suggest index.
@return HTML response redirecting to the index page
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.suggest.AdminSuggestAction#deleteDocumentWords()
annotations: @Execute @Secured{value=[admin-suggest]}
Admin action for suggest management.
Deletes document-based suggest words from the suggest index.
@return HTML response redirecting to the index page
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.suggest.AdminSuggestAction#deleteQueryWords()
annotations: @Execute @Secured{value=[admin-suggest]}
Admin action for suggest management.
Deletes query-based suggest words from the suggest index.
@return HTML response redirecting to the index page
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.systeminfo.AdminSysteminfoAction#index()
annotations: @Execute @Secured{value=[admin-systeminfo, admin-systeminfo-view]}
Admin action for System Info.
Displays the system information page with environment, properties, and configuration details.
@return HTML response for the system info page
implementations: asHtml(path_AdminSysteminfo_AdminSysteminfoJsp)
Execute Method: org.codelibs.fess.app.web.admin.user.AdminUserAction#index()
annotations: @Execute @Secured{value=[admin-user, admin-user-view]}
Admin action for User management.
Displays the user management index page.
@return HTML response for the user list page
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.user.AdminUserAction#list()
annotations: @Execute @Secured{value=[admin-user, admin-user-view]}
Admin action for User management.
Displays a paginated list of users.
@param pageNumber the page number to display (optional)
@param form the search form containing filter criteria
@return HTML response with the user list
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
the page number to display |
The search form for User.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching users |
implementations: asHtml(path_AdminUser_AdminUserJsp)
Execute Method: org.codelibs.fess.app.web.admin.user.AdminUserAction#search()
annotations: @Execute @Secured{value=[admin-user, admin-user-view]}
Admin action for User management.
Searches for users based on the provided search criteria.
@param form the search form containing search criteria
@return HTML response with filtered user results
The search form for User.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching users |
implementations: asHtml(path_AdminUser_AdminUserJsp)
Execute Method: org.codelibs.fess.app.web.admin.user.AdminUserAction#reset()
annotations: @Execute @Secured{value=[admin-user, admin-user-view]}
Admin action for User management.
Resets the search criteria and displays all users.
@param form the search form to reset
@return HTML response with the reset user list
The search form for User.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching users |
implementations: asHtml(path_AdminUser_AdminUserJsp)
Execute Method: org.codelibs.fess.app.web.admin.user.AdminUserAction#createnew()
annotations: @Execute @Secured{value=[admin-user]}
Admin action for User management.
Displays the form for creating a new user.
@return HTML response for the user creation form
implementations: asHtml(path_AdminUser_AdminUserEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.user.AdminUserAction#edit()
annotations: @Execute @Secured{value=[admin-user]}
Admin action for User management.
Displays the form for editing an existing user.
@param form the edit form containing user ID
@return HTML response for the user edit form
Form class for editing users in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the user being edited |
@Required , @Size{max=1000} |
| 2 | versionNo | Integer |
The version number of the user for optimistic locking |
@Required , @ValidateTypeFailure |
| 3 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 4 | name | String |
The username of the user |
@Required , @Size{max=100} |
| 5 | password | String |
The password for the user |
@Size{max=100} |
| 6 | confirmPassword | String |
The password confirmation field |
@Size{max=100} |
| 7 | attributes | Map<String, String> |
The attributes map for the user |
|
| 8 | roles | String[] |
The roles assigned to the user |
|
| 9 | groups | String[] |
The groups assigned to the user |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.user.AdminUserAction#details()
annotations: @Execute @Secured{value=[admin-user, admin-user-view]}
Admin action for User management.
Displays the details of a user.
@param crudMode the CRUD mode for the operation
@param id the ID of the user to display
@return HTML response for the user details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD mode for the operation |
|
| 2 | id | String |
the ID of the user to display |
implementations: asHtml(path_AdminUser_AdminUserDetailsJsp)
Execute Method: org.codelibs.fess.app.web.admin.user.AdminUserAction#create()
annotations: @Execute @Secured{value=[admin-user]}
Admin action for User management.
Creates a new user.
@param form the create form containing the new user data
@return HTML response redirecting to the list page after creation
The create form for User.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 2 | name | String |
The username of the user |
@Required , @Size{max=100} |
| 3 | password | String |
The password for the user |
@Size{max=100} |
| 4 | confirmPassword | String |
The password confirmation field |
@Size{max=100} |
| 5 | attributes | Map<String, String> |
The attributes map for the user |
|
| 6 | roles | String[] |
The roles assigned to the user |
|
| 7 | groups | String[] |
The groups assigned to the user |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.user.AdminUserAction#update()
annotations: @Execute @Secured{value=[admin-user]}
Admin action for User management.
Updates an existing user.
@param form the edit form containing the updated user data
@return HTML response redirecting to the list page after update
Form class for editing users in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the user being edited |
@Required , @Size{max=1000} |
| 2 | versionNo | Integer |
The version number of the user for optimistic locking |
@Required , @ValidateTypeFailure |
| 3 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 4 | name | String |
The username of the user |
@Required , @Size{max=100} |
| 5 | password | String |
The password for the user |
@Size{max=100} |
| 6 | confirmPassword | String |
The password confirmation field |
@Size{max=100} |
| 7 | attributes | Map<String, String> |
The attributes map for the user |
|
| 8 | roles | String[] |
The roles assigned to the user |
|
| 9 | groups | String[] |
The groups assigned to the user |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.user.AdminUserAction#delete()
annotations: @Execute @Secured{value=[admin-user]}
Admin action for User management.
Deletes a user.
@param form the edit form containing the ID of the user to delete
@return HTML response redirecting to the list page after deletion
Form class for editing users in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the user being edited |
@Required , @Size{max=1000} |
| 2 | versionNo | Integer |
The version number of the user for optimistic locking |
@Required , @ValidateTypeFailure |
| 3 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 4 | name | String |
The username of the user |
@Required , @Size{max=100} |
| 5 | password | String |
The password for the user |
@Size{max=100} |
| 6 | confirmPassword | String |
The password confirmation field |
@Size{max=100} |
| 7 | attributes | Map<String, String> |
The attributes map for the user |
|
| 8 | roles | String[] |
The roles assigned to the user |
|
| 9 | groups | String[] |
The groups assigned to the user |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.webauth.AdminWebauthAction#index()
annotations: @Execute @Secured{value=[admin-webauth, admin-webauth-view]}
Admin action for Web Authentication management.
Displays the web authentication management index page.
@param form the search form for filtering
@return HTML response for the web authentication list page
The search form for Web Authentication.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching web authentication settings |
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.webauth.AdminWebauthAction#list()
annotations: @Execute @Secured{value=[admin-webauth, admin-webauth-view]}
Admin action for Web Authentication management.
Displays a paginated list of web authentication configurations.
@param pageNumber the page number to display (optional)
@param form the search form containing filter criteria
@return HTML response with the web authentication list
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
the page number to display |
The search form for Web Authentication.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching web authentication settings |
implementations: asHtml(path_AdminWebauth_AdminWebauthJsp)
Execute Method: org.codelibs.fess.app.web.admin.webauth.AdminWebauthAction#search()
annotations: @Execute @Secured{value=[admin-webauth, admin-webauth-view]}
Admin action for Web Authentication management.
Searches for web authentication configurations based on the provided search criteria.
@param form the search form containing search criteria
@return HTML response with filtered web authentication results
The search form for Web Authentication.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching web authentication settings |
implementations: asHtml(path_AdminWebauth_AdminWebauthJsp)
Execute Method: org.codelibs.fess.app.web.admin.webauth.AdminWebauthAction#reset()
annotations: @Execute @Secured{value=[admin-webauth, admin-webauth-view]}
Admin action for Web Authentication management.
Resets the search criteria and displays all web authentication configurations.
@param form the search form to reset
@return HTML response with the reset web authentication list
The search form for Web Authentication.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID field for searching web authentication settings |
implementations: asHtml(path_AdminWebauth_AdminWebauthJsp)
Execute Method: org.codelibs.fess.app.web.admin.webauth.AdminWebauthAction#createnew()
annotations: @Execute @Secured{value=[admin-webauth]}
Admin action for Web Authentication management.
Displays the form for creating a new web authentication configuration.
@return HTML response for the web authentication creation form
implementations: asHtml(path_AdminWebauth_AdminWebauthEditJsp)
Execute Method: org.codelibs.fess.app.web.admin.webauth.AdminWebauthAction#edit()
annotations: @Execute @Secured{value=[admin-webauth]}
Admin action for Web Authentication management.
Displays the form for editing an existing web authentication configuration.
@param form the edit form containing web authentication ID
@return HTML response for the web authentication edit form
Form class for editing web authentication configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the web authentication configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this web authentication configuration |
@Size{max=255} |
| 3 | updatedTime | Long |
The timestamp when this web authentication configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the web authentication configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 6 | hostname | String |
The hostname for the web authentication |
@Size{max=100} |
| 7 | port | Integer |
The port number for the web authentication |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 8 | authRealm | String |
The authentication realm |
@Size{max=100} |
| 9 | protocolScheme | String |
The protocol scheme (http, https) |
@Size{max=10} |
| 10 | username | String |
The username for authentication |
@Required , @Size{max=100} |
| 11 | password | String |
The password for authentication |
@Size{max=100} |
| 12 | parameters | String |
Additional parameters for the authentication |
@Size{max=1000} |
| 13 | webConfigId | String |
The web configuration ID this authentication is associated with |
@Required , @Size{max=1000} |
| 14 | createdBy | String |
The user who created this authentication configuration |
@Size{max=1000} |
| 15 | createdTime | Long |
The timestamp when this authentication configuration was created |
@ValidateTypeFailure |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.webauth.AdminWebauthAction#details()
annotations: @Execute @Secured{value=[admin-webauth, admin-webauth-view]}
Admin action for Web Authentication management.
Displays the details of a web authentication configuration.
@param crudMode the CRUD mode for the operation
@param id the ID of the web authentication to display
@return HTML response for the web authentication details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD mode for the operation |
|
| 2 | id | String |
the ID of the web authentication to display |
implementations: asHtml(path_AdminWebauth_AdminWebauthDetailsJsp)
Execute Method: org.codelibs.fess.app.web.admin.webauth.AdminWebauthAction#create()
annotations: @Execute @Secured{value=[admin-webauth]}
Admin action for Web Authentication management.
Creates a new web authentication configuration.
@param form the create form containing the new web authentication data
@return HTML response redirecting to the list page after creation
The create form for Web Authentication.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 2 | hostname | String |
The hostname for the web authentication |
@Size{max=100} |
| 3 | port | Integer |
The port number for the web authentication |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 4 | authRealm | String |
The authentication realm |
@Size{max=100} |
| 5 | protocolScheme | String |
The protocol scheme (http, https) |
@Size{max=10} |
| 6 | username | String |
The username for authentication |
@Required , @Size{max=100} |
| 7 | password | String |
The password for authentication |
@Size{max=100} |
| 8 | parameters | String |
Additional parameters for the authentication |
@Size{max=1000} |
| 9 | webConfigId | String |
The web configuration ID this authentication is associated with |
@Required , @Size{max=1000} |
| 10 | createdBy | String |
The user who created this authentication configuration |
@Size{max=1000} |
| 11 | createdTime | Long |
The timestamp when this authentication configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.webauth.AdminWebauthAction#update()
annotations: @Execute @Secured{value=[admin-webauth]}
Admin action for Web Authentication management.
Updates an existing web authentication configuration.
@param form the edit form containing the updated web authentication data
@return HTML response redirecting to the list page after update
Form class for editing web authentication configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the web authentication configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this web authentication configuration |
@Size{max=255} |
| 3 | updatedTime | Long |
The timestamp when this web authentication configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the web authentication configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 6 | hostname | String |
The hostname for the web authentication |
@Size{max=100} |
| 7 | port | Integer |
The port number for the web authentication |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 8 | authRealm | String |
The authentication realm |
@Size{max=100} |
| 9 | protocolScheme | String |
The protocol scheme (http, https) |
@Size{max=10} |
| 10 | username | String |
The username for authentication |
@Required , @Size{max=100} |
| 11 | password | String |
The password for authentication |
@Size{max=100} |
| 12 | parameters | String |
Additional parameters for the authentication |
@Size{max=1000} |
| 13 | webConfigId | String |
The web configuration ID this authentication is associated with |
@Required , @Size{max=1000} |
| 14 | createdBy | String |
The user who created this authentication configuration |
@Size{max=1000} |
| 15 | createdTime | Long |
The timestamp when this authentication configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.webauth.AdminWebauthAction#delete()
annotations: @Execute @Secured{value=[admin-webauth]}
Admin action for Web Authentication management.
Deletes a web authentication configuration.
@param form the edit form containing the ID of the web authentication to delete
@return HTML response redirecting to the list page after deletion
Form class for editing web authentication configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the web authentication configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this web authentication configuration |
@Size{max=255} |
| 3 | updatedTime | Long |
The timestamp when this web authentication configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the web authentication configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 6 | hostname | String |
The hostname for the web authentication |
@Size{max=100} |
| 7 | port | Integer |
The port number for the web authentication |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 8 | authRealm | String |
The authentication realm |
@Size{max=100} |
| 9 | protocolScheme | String |
The protocol scheme (http, https) |
@Size{max=10} |
| 10 | username | String |
The username for authentication |
@Required , @Size{max=100} |
| 11 | password | String |
The password for authentication |
@Size{max=100} |
| 12 | parameters | String |
Additional parameters for the authentication |
@Size{max=1000} |
| 13 | webConfigId | String |
The web configuration ID this authentication is associated with |
@Required , @Size{max=1000} |
| 14 | createdBy | String |
The user who created this authentication configuration |
@Size{max=1000} |
| 15 | createdTime | Long |
The timestamp when this authentication configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.webconfig.AdminWebconfigAction#index()
annotations: @Execute @Secured{value=[admin-webconfig, admin-webconfig-view]}
Admin action for Web Config management.
Displays the web config management index page.
@param form the search form for filtering
@return HTML response for the web config list page
The search form for Web Config.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
The name field for searching web configurations |
|
| 2 | urls | String |
The URLs field for searching web configurations |
|
| 3 | description | String |
The description field for searching web configurations |
implementations: asListHtml()
Execute Method: org.codelibs.fess.app.web.admin.webconfig.AdminWebconfigAction#list()
annotations: @Execute @Secured{value=[admin-webconfig, admin-webconfig-view]}
Admin action for Web Config management.
Displays a paginated list of web crawler configurations.
@param pageNumber the page number to display (optional)
@param form the search form containing filter criteria
@return HTML response with the web config list
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | pageNumber | OptionalThing<Integer> |
the page number to display |
The search form for Web Config.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
The name field for searching web configurations |
|
| 2 | urls | String |
The URLs field for searching web configurations |
|
| 3 | description | String |
The description field for searching web configurations |
implementations: asHtml(path_AdminWebconfig_AdminWebconfigJsp)
Execute Method: org.codelibs.fess.app.web.admin.webconfig.AdminWebconfigAction#search()
annotations: @Execute @Secured{value=[admin-webconfig, admin-webconfig-view]}
Admin action for Web Config management.
Searches for web crawler configurations based on the provided search criteria.
@param form the search form containing search criteria
@return HTML response with filtered web config results
The search form for Web Config.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
The name field for searching web configurations |
|
| 2 | urls | String |
The URLs field for searching web configurations |
|
| 3 | description | String |
The description field for searching web configurations |
implementations: asHtml(path_AdminWebconfig_AdminWebconfigJsp)
Execute Method: org.codelibs.fess.app.web.admin.webconfig.AdminWebconfigAction#reset()
annotations: @Execute @Secured{value=[admin-webconfig, admin-webconfig-view]}
Admin action for Web Config management.
Resets the search criteria and displays all web crawler configurations.
@param form the search form to reset
@return HTML response with the reset web config list
The search form for Web Config.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
The name field for searching web configurations |
|
| 2 | urls | String |
The URLs field for searching web configurations |
|
| 3 | description | String |
The description field for searching web configurations |
implementations: asHtml(path_AdminWebconfig_AdminWebconfigJsp)
Execute Method: org.codelibs.fess.app.web.admin.webconfig.AdminWebconfigAction#createnew()
annotations: @Execute @Secured{value=[admin-webconfig]}
Admin action for Web Config management.
Displays the form for creating a new web crawler configuration.
@return HTML response for the web config creation form
implementations: asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.webconfig.AdminWebconfigAction#edit()
annotations: @Execute @Secured{value=[admin-webconfig]}
Admin action for Web Config management.
Displays the form for editing an existing web crawler configuration.
@param form the edit form containing web config ID
@return HTML response for the web config edit form
Form class for editing web crawling configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the web configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this web configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this web configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the web configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | labelTypeIds | String[] |
The label type IDs associated with this web configuration |
|
| 6 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 7 | name | String |
The name of the web configuration |
@Required , @Size{max=200} |
| 8 | description | String |
The description of the web configuration |
@Size{max=1000} |
| 9 | urls | String |
The URLs to be crawled by this web configuration |
@Required , @UriType{protocolType=WEB} , @CustomSize{maxKey=form.admin.max.input.size} |
| 10 | includedUrls | String |
URL patterns to include during crawling |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | excludedUrls | String |
URL patterns to exclude during crawling |
@CustomSize{maxKey=form.admin.max.input.size} |
| 12 | includedDocUrls | String |
Document URL patterns to include in search index |
@CustomSize{maxKey=form.admin.max.input.size} |
| 13 | excludedDocUrls | String |
Document URL patterns to exclude from search index |
@CustomSize{maxKey=form.admin.max.input.size} |
| 14 | configParameter | String |
Additional configuration parameters for the crawler |
@CustomSize{maxKey=form.admin.max.input.size} |
| 15 | depth | Integer |
The maximum crawling depth from the starting URLs |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 16 | maxAccessCount | Long |
The maximum number of URLs to access during crawling |
@Min{value=0} , @Max{value=9223372036854775807} , @ValidateTypeFailure |
| 17 | userAgent | String |
The user agent string to use during crawling |
@Required , @Size{max=200} |
| 18 | numOfThread | Integer |
The number of crawler threads to use |
@Required , @Min{value=1} , @Max{value=2147483647} , @ValidateTypeFailure |
| 19 | intervalTime | Integer |
The interval time between requests in milliseconds |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 20 | boost | Float |
The boost value for documents from this web configuration |
@Required , @ValidateTypeFailure |
| 21 | available | String |
Whether this web configuration is available for crawling |
@Required , @Size{max=5} |
| 22 | permissions | String |
Permissions required to access documents from this configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 23 | virtualHosts | String |
Virtual host names for this web configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 24 | sortOrder | Integer |
The sort order for this web configuration |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 25 | createdBy | String |
The user who created this web configuration |
@Size{max=1000} |
| 26 | createdTime | Long |
The timestamp when this web configuration was created |
@ValidateTypeFailure |
implementations: asDetailsHtml(),asEditHtml()
Execute Method: org.codelibs.fess.app.web.admin.webconfig.AdminWebconfigAction#details()
annotations: @Execute @Secured{value=[admin-webconfig, admin-webconfig-view]}
Admin action for Web Config management.
Displays the details of a web crawler configuration.
@param crudMode the CRUD mode for the operation
@param id the ID of the web config to display
@return HTML response for the web config details page
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crudMode | int |
the CRUD mode for the operation |
|
| 2 | id | String |
the ID of the web config to display |
implementations: asDetailsHtml()
Execute Method: org.codelibs.fess.app.web.admin.webconfig.AdminWebconfigAction#create()
annotations: @Execute @Secured{value=[admin-webconfig]}
Admin action for Web Config management.
Creates a new web crawler configuration.
@param form the create form containing the new web config data
@return HTML response redirecting to the list page after creation
The create form for Web Config.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | labelTypeIds | String[] |
The label type IDs associated with this web configuration |
|
| 2 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 3 | name | String |
The name of the web configuration |
@Required , @Size{max=200} |
| 4 | description | String |
The description of the web configuration |
@Size{max=1000} |
| 5 | urls | String |
The URLs to be crawled by this web configuration |
@Required , @UriType{protocolType=WEB} , @CustomSize{maxKey=form.admin.max.input.size} |
| 6 | includedUrls | String |
URL patterns to include during crawling |
@CustomSize{maxKey=form.admin.max.input.size} |
| 7 | excludedUrls | String |
URL patterns to exclude during crawling |
@CustomSize{maxKey=form.admin.max.input.size} |
| 8 | includedDocUrls | String |
Document URL patterns to include in search index |
@CustomSize{maxKey=form.admin.max.input.size} |
| 9 | excludedDocUrls | String |
Document URL patterns to exclude from search index |
@CustomSize{maxKey=form.admin.max.input.size} |
| 10 | configParameter | String |
Additional configuration parameters for the crawler |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | depth | Integer |
The maximum crawling depth from the starting URLs |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 12 | maxAccessCount | Long |
The maximum number of URLs to access during crawling |
@Min{value=0} , @Max{value=9223372036854775807} , @ValidateTypeFailure |
| 13 | userAgent | String |
The user agent string to use during crawling |
@Required , @Size{max=200} |
| 14 | numOfThread | Integer |
The number of crawler threads to use |
@Required , @Min{value=1} , @Max{value=2147483647} , @ValidateTypeFailure |
| 15 | intervalTime | Integer |
The interval time between requests in milliseconds |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 16 | boost | Float |
The boost value for documents from this web configuration |
@Required , @ValidateTypeFailure |
| 17 | available | String |
Whether this web configuration is available for crawling |
@Required , @Size{max=5} |
| 18 | permissions | String |
Permissions required to access documents from this configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 19 | virtualHosts | String |
Virtual host names for this web configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 20 | sortOrder | Integer |
The sort order for this web configuration |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 21 | createdBy | String |
The user who created this web configuration |
@Size{max=1000} |
| 22 | createdTime | Long |
The timestamp when this web configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.webconfig.AdminWebconfigAction#update()
annotations: @Execute @Secured{value=[admin-webconfig]}
Admin action for Web Config management.
Updates an existing web crawler configuration.
@param form the edit form containing the updated web config data
@return HTML response redirecting to the list page after update
Form class for editing web crawling configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the web configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this web configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this web configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the web configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | labelTypeIds | String[] |
The label type IDs associated with this web configuration |
|
| 6 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 7 | name | String |
The name of the web configuration |
@Required , @Size{max=200} |
| 8 | description | String |
The description of the web configuration |
@Size{max=1000} |
| 9 | urls | String |
The URLs to be crawled by this web configuration |
@Required , @UriType{protocolType=WEB} , @CustomSize{maxKey=form.admin.max.input.size} |
| 10 | includedUrls | String |
URL patterns to include during crawling |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | excludedUrls | String |
URL patterns to exclude during crawling |
@CustomSize{maxKey=form.admin.max.input.size} |
| 12 | includedDocUrls | String |
Document URL patterns to include in search index |
@CustomSize{maxKey=form.admin.max.input.size} |
| 13 | excludedDocUrls | String |
Document URL patterns to exclude from search index |
@CustomSize{maxKey=form.admin.max.input.size} |
| 14 | configParameter | String |
Additional configuration parameters for the crawler |
@CustomSize{maxKey=form.admin.max.input.size} |
| 15 | depth | Integer |
The maximum crawling depth from the starting URLs |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 16 | maxAccessCount | Long |
The maximum number of URLs to access during crawling |
@Min{value=0} , @Max{value=9223372036854775807} , @ValidateTypeFailure |
| 17 | userAgent | String |
The user agent string to use during crawling |
@Required , @Size{max=200} |
| 18 | numOfThread | Integer |
The number of crawler threads to use |
@Required , @Min{value=1} , @Max{value=2147483647} , @ValidateTypeFailure |
| 19 | intervalTime | Integer |
The interval time between requests in milliseconds |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 20 | boost | Float |
The boost value for documents from this web configuration |
@Required , @ValidateTypeFailure |
| 21 | available | String |
Whether this web configuration is available for crawling |
@Required , @Size{max=5} |
| 22 | permissions | String |
Permissions required to access documents from this configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 23 | virtualHosts | String |
Virtual host names for this web configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 24 | sortOrder | Integer |
The sort order for this web configuration |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 25 | createdBy | String |
The user who created this web configuration |
@Size{max=1000} |
| 26 | createdTime | Long |
The timestamp when this web configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.webconfig.AdminWebconfigAction#delete()
annotations: @Execute @Secured{value=[admin-webconfig]}
Admin action for Web Config management.
Deletes a web crawler configuration.
@param form the edit form containing the ID of the web config to delete
@return HTML response redirecting to the list page after deletion
Form class for editing web crawling configurations in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the web configuration being edited |
@Required , @Size{max=1000} |
| 2 | updatedBy | String |
The username of the user who last updated this web configuration |
@Size{max=1000} |
| 3 | updatedTime | Long |
The timestamp when this web configuration was last updated |
@ValidateTypeFailure |
| 4 | versionNo | Integer |
The version number of the web configuration for optimistic locking |
@Required , @ValidateTypeFailure |
| 5 | labelTypeIds | String[] |
The label type IDs associated with this web configuration |
|
| 6 | crudMode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure |
| 7 | name | String |
The name of the web configuration |
@Required , @Size{max=200} |
| 8 | description | String |
The description of the web configuration |
@Size{max=1000} |
| 9 | urls | String |
The URLs to be crawled by this web configuration |
@Required , @UriType{protocolType=WEB} , @CustomSize{maxKey=form.admin.max.input.size} |
| 10 | includedUrls | String |
URL patterns to include during crawling |
@CustomSize{maxKey=form.admin.max.input.size} |
| 11 | excludedUrls | String |
URL patterns to exclude during crawling |
@CustomSize{maxKey=form.admin.max.input.size} |
| 12 | includedDocUrls | String |
Document URL patterns to include in search index |
@CustomSize{maxKey=form.admin.max.input.size} |
| 13 | excludedDocUrls | String |
Document URL patterns to exclude from search index |
@CustomSize{maxKey=form.admin.max.input.size} |
| 14 | configParameter | String |
Additional configuration parameters for the crawler |
@CustomSize{maxKey=form.admin.max.input.size} |
| 15 | depth | Integer |
The maximum crawling depth from the starting URLs |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 16 | maxAccessCount | Long |
The maximum number of URLs to access during crawling |
@Min{value=0} , @Max{value=9223372036854775807} , @ValidateTypeFailure |
| 17 | userAgent | String |
The user agent string to use during crawling |
@Required , @Size{max=200} |
| 18 | numOfThread | Integer |
The number of crawler threads to use |
@Required , @Min{value=1} , @Max{value=2147483647} , @ValidateTypeFailure |
| 19 | intervalTime | Integer |
The interval time between requests in milliseconds |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 20 | boost | Float |
The boost value for documents from this web configuration |
@Required , @ValidateTypeFailure |
| 21 | available | String |
Whether this web configuration is available for crawling |
@Required , @Size{max=5} |
| 22 | permissions | String |
Permissions required to access documents from this configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 23 | virtualHosts | String |
Virtual host names for this web configuration |
@CustomSize{maxKey=form.admin.max.input.size} |
| 24 | sortOrder | Integer |
The sort order for this web configuration |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 25 | createdBy | String |
The user who created this web configuration |
@Size{max=1000} |
| 26 | createdTime | Long |
The timestamp when this web configuration was created |
@ValidateTypeFailure |
implementations: redirect(getClass()
Execute Method: org.codelibs.fess.app.web.admin.wizard.AdminWizardAction#index()
annotations: @Execute @Secured{value=[admin-wizard, admin-wizard-view]}
Admin action for configuration wizard.
Displays the wizard index page.
@return HTML response for the wizard main page
implementations: asIndexHtml()
Execute Method: org.codelibs.fess.app.web.admin.wizard.AdminWizardAction#crawlingConfigForm()
annotations: @Execute @Secured{value=[admin-wizard]}
Admin action for configuration wizard.
Displays the crawling configuration form.
@return HTML response for the crawling config form
implementations: asHtml(path_AdminWizard_AdminWizardConfigJsp)
Execute Method: org.codelibs.fess.app.web.admin.wizard.AdminWizardAction#crawlingConfig()
annotations: @Execute @Secured{value=[admin-wizard]}
Admin action for configuration wizard.
Creates a crawling configuration and returns to the config form.
@param form the form containing crawling configuration data
@return HTML response redirecting to the config form
Form class for crawling configuration wizard in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crawlingConfigName | String |
Name of the crawling configuration |
@Required , @Size{max=200} |
| 2 | crawlingConfigPath | String |
Path or URL to be crawled by this configuration |
@Required , @Size{max=1000} |
| 3 | depth | Integer |
Maximum depth for crawling (how many levels deep to follow links) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 4 | maxAccessCount | Long |
Maximum number of pages/documents to access during crawling |
@Min{value=0} , @Max{value=9223372036854775807} , @ValidateTypeFailure |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.wizard.AdminWizardAction#crawlingConfigNext()
annotations: @Execute @Secured{value=[admin-wizard]}
Admin action for configuration wizard.
Creates a crawling configuration and proceeds to the start crawling form.
@param form the form containing crawling configuration data
@return HTML response redirecting to the start crawling form
Form class for crawling configuration wizard in the admin interface.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | crawlingConfigName | String |
Name of the crawling configuration |
@Required , @Size{max=200} |
| 2 | crawlingConfigPath | String |
Path or URL to be crawled by this configuration |
@Required , @Size{max=1000} |
| 3 | depth | Integer |
Maximum depth for crawling (how many levels deep to follow links) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure |
| 4 | maxAccessCount | Long |
Maximum number of pages/documents to access during crawling |
@Min{value=0} , @Max{value=9223372036854775807} , @ValidateTypeFailure |
implementations: redirectWith(getClass()
Execute Method: org.codelibs.fess.app.web.admin.wizard.AdminWizardAction#startCrawlingForm()
annotations: @Execute @Secured{value=[admin-wizard]}
Admin action for configuration wizard.
Displays the start crawling form.
@return HTML response for the start crawling form
implementations: asHtml(path_AdminWizard_AdminWizardStartJsp)
Execute Method: org.codelibs.fess.app.web.admin.wizard.AdminWizardAction#startCrawling()
annotations: @Execute @Secured{value=[admin-wizard]}
Admin action for configuration wizard.
Starts the crawling process for all configured crawlers.
@param form the start crawling form
@return HTML response redirecting to the wizard index
Form class for starting crawling operations in the admin wizard.
Return as: HtmlResponseimplementations: redirect(AdminWizardAction.class)
Execute Method: org.codelibs.fess.app.web.api.admin.accesstoken.ApiAdminAccesstokenAction#settings()
annotations: @Execute
API action for admin access token.
Retrieves a list of access token settings.
@param body the search body containing filter criteria
@return JSON response with access token list
Search request body for access token administration.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The access token ID to search for |
|
| 2 | size | Integer |
The page size for search results |
|
| 3 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.accesstoken.ApiAdminAccesstokenAction#get$setting()
annotations: @Execute
API action for admin access token.
Retrieves a specific access token setting by ID.
@param id the access token ID to retrieve
@return JSON response with the access token setting
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the access token ID to retrieve |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.accesstoken.ApiAdminAccesstokenAction#post$setting()
annotations: @Execute
API action for admin access token.
Creates a new access token setting.
@param body the create body containing access token data
@return JSON response with the created access token ID
Request body for creating access token via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure | crudMode |
| 2 | name | String |
The name of the access token |
@Required , @Size{max=1000} | name |
| 3 | token | String |
The actual access token string |
@Size{max=10000} | token |
| 4 | permissions | String |
The permissions associated with this access token |
@CustomSize{maxKey=form.admin.max.input.size} | permissions |
| 5 | parameter_name | String |
The parameter name for the access token |
@Size{max=10000} | parameterName |
| 6 | expires | String |
The expiration date and time for the access token |
@Pattern{regexp=[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]T[0-9][0-9]:[0-9][0-9]:[0-9][0-9]} | expires |
| 7 | created_by | String |
The username of the user who created this access token |
@Size{max=1000} | createdBy |
| 8 | created_time | Long |
The timestamp when this access token was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.accesstoken.ApiAdminAccesstokenAction#put$setting()
annotations: @Execute
API action for admin access token.
Updates an existing access token setting.
@param body the edit body containing updated access token data
@return JSON response with the updated access token ID
Request body class for access token edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the access token being edited |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
The username of the user who last updated this access token |
@Size{max=1000} | updatedBy |
| 3 | updated_time | Long |
The timestamp when this access token was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Integer |
The version number of the access token for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | crud_mode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure | crudMode |
| 6 | name | String |
The name of the access token |
@Required , @Size{max=1000} | name |
| 7 | token | String |
The actual access token string |
@Size{max=10000} | token |
| 8 | permissions | String |
The permissions associated with this access token |
@CustomSize{maxKey=form.admin.max.input.size} | permissions |
| 9 | parameter_name | String |
The parameter name for the access token |
@Size{max=10000} | parameterName |
| 10 | expires | String |
The expiration date and time for the access token |
@Pattern{regexp=[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]T[0-9][0-9]:[0-9][0-9]:[0-9][0-9]} | expires |
| 11 | created_by | String |
The username of the user who created this access token |
@Size{max=1000} | createdBy |
| 12 | created_time | Long |
The timestamp when this access token was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.accesstoken.ApiAdminAccesstokenAction#delete$setting()
annotations: @Execute
API action for admin access token.
Deletes an access token setting by ID.
@param id the access token ID to delete
@return JSON response confirming deletion
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the access token ID to delete |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.backup.ApiAdminBackupAction#files()
annotations: @Execute
API action for admin backup.
Return as: JsonResponse<ApiResult>| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.backup.ApiAdminBackupAction#get$file()
annotations: @Execute
API action for admin backup.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
Execute Method: org.codelibs.fess.app.web.api.admin.badword.ApiAdminBadwordAction#settings()
annotations: @Execute
API action for admin bad word management.
Provides REST endpoints for managing bad words in the Fess search engine.
Search request body for bad word administration.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The bad word ID to search for |
|
| 2 | size | Integer |
The page size for search results |
|
| 3 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.badword.ApiAdminBadwordAction#get$setting()
annotations: @Execute
API action for admin bad word management.
Provides REST endpoints for managing bad words in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.badword.ApiAdminBadwordAction#post$setting()
annotations: @Execute
API action for admin bad word management.
Provides REST endpoints for managing bad words in the Fess search engine.
Creates a new bad word setting.
@param body the request body containing bad word information
@return JSON response with result status
Request body for creating bad word via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
The CRUD mode for form processing (create, update, delete operations) |
@ValidateTypeFailure | crudMode |
| 2 | suggest_word | String |
The bad word to be filtered from search suggestions |
@Required , @Pattern{regexp=[^\s]+} | suggestWord |
| 3 | created_by | String |
The username of the user who created this bad word entry |
@Size{max=1000} | createdBy |
| 4 | created_time | Long |
The timestamp when this bad word entry was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.badword.ApiAdminBadwordAction#put$setting()
annotations: @Execute
API action for admin bad word management.
Provides REST endpoints for managing bad words in the Fess search engine.
Updates an existing bad word setting.
@param body the request body containing updated bad word information
@return JSON response with result status
Request body class for bad word edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the bad word entry being edited |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
The username of the user who last updated this bad word entry |
@Size{max=1000} | updatedBy |
| 3 | updated_time | Long |
The timestamp when this bad word entry was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Long |
The version number of the bad word entry for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | crud_mode | Integer |
The CRUD mode for form processing (create, update, delete operations) |
@ValidateTypeFailure | crudMode |
| 6 | suggest_word | String |
The bad word to be filtered from search suggestions |
@Required , @Pattern{regexp=[^\s]+} | suggestWord |
| 7 | created_by | String |
The username of the user who created this bad word entry |
@Size{max=1000} | createdBy |
| 8 | created_time | Long |
The timestamp when this bad word entry was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.badword.ApiAdminBadwordAction#delete$setting()
annotations: @Execute
API action for admin bad word management.
Provides REST endpoints for managing bad words in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.badword.ApiAdminBadwordAction#put$upload()
annotations: @Execute
API action for admin bad word management.
Provides REST endpoints for managing bad words in the Fess search engine.
Uploads bad words from a CSV file.
@param body the upload form containing the CSV file
@return JSON response with result status
Form for uploading bad word files to the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | badWordFile | MultipartFormFile |
The multipart file containing bad words to be uploaded |
@Required |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.badword.ApiAdminBadwordAction#get$download()
annotations: @Execute
API action for admin bad word management.
Provides REST endpoints for managing bad words in the Fess search engine.
Download body for Bad Word API operations.
Return as: StreamResponseExecute Method: org.codelibs.fess.app.web.api.admin.boostdoc.ApiAdminBoostdocAction#settings()
annotations: @Execute
API action for admin boost doc.
Form or Body: SearchBodySearch request body for boost document administration.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | url_expr | String |
The URL expression pattern to search for in boost documents |
urlExpr | |
| 2 | boost_expr | String |
The boost expression to search for in boost documents |
boostExpr | |
| 3 | size | Integer |
The page size for search results |
size | |
| 4 | page | Integer |
The page number for search results |
page |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.boostdoc.ApiAdminBoostdocAction#get$setting()
annotations: @Execute
API action for admin boost doc.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.boostdoc.ApiAdminBoostdocAction#post$setting()
annotations: @Execute
API action for admin boost doc.
Form or Body: CreateBodyRequest body for creating boost document via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure | crudMode |
| 2 | url_expr | String |
URL expression pattern to match documents for boosting |
@Required , @Size{max=10000} | urlExpr |
| 3 | boost_expr | String |
Boost expression to apply to matching documents |
@Required , @Size{max=10000} | boostExpr |
| 4 | sort_order | Integer |
Sort order for displaying boost configurations |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 5 | created_by | String |
User who created this configuration |
@Size{max=1000} | createdBy |
| 6 | created_time | Long |
Timestamp when this configuration was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.boostdoc.ApiAdminBoostdocAction#put$setting()
annotations: @Execute
API action for admin boost doc.
Form or Body: EditBodyRequest body class for boost document edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the boost document configuration being edited |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
The username of the user who last updated this boost document configuration |
@Size{max=1000} | updatedBy |
| 3 | updated_time | Long |
The timestamp when this boost document configuration was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Integer |
The version number of the boost document configuration for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | crud_mode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure | crudMode |
| 6 | url_expr | String |
URL expression pattern to match documents for boosting |
@Required , @Size{max=10000} | urlExpr |
| 7 | boost_expr | String |
Boost expression to apply to matching documents |
@Required , @Size{max=10000} | boostExpr |
| 8 | sort_order | Integer |
Sort order for displaying boost configurations |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 9 | created_by | String |
User who created this configuration |
@Size{max=1000} | createdBy |
| 10 | created_time | Long |
Timestamp when this configuration was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.boostdoc.ApiAdminBoostdocAction#delete$setting()
annotations: @Execute
API action for admin boost doc.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.crawlinginfo.ApiAdminCrawlinginfoAction#logs()
annotations: @Execute
API action for admin crawling info.
Form or Body: SearchBodySearch request body for crawling information administration.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | session_id | String |
The crawling session ID to search for |
sessionId | |
| 2 | size | Integer |
The page size for search results |
size | |
| 3 | page | Integer |
The page number for search results |
page |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.crawlinginfo.ApiAdminCrawlinginfoAction#get$log()
annotations: @Execute
API action for admin crawling info.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.crawlinginfo.ApiAdminCrawlinginfoAction#delete$log()
annotations: @Execute
API action for admin crawling info.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.crawlinginfo.ApiAdminCrawlinginfoAction#delete$all()
annotations: @Execute
API action for admin crawling info.
Return as: JsonResponse<ApiResult>| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dataconfig.ApiAdminDataconfigAction#settings()
annotations: @Execute
API action for admin data config.
Form or Body: SearchBodySearch request body for data configuration administration.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | name | String |
The data configuration name to search for |
name | |
| 2 | handler_name | String |
The handler name to search for in data configurations |
handlerName | |
| 3 | description | String |
The description to search for in data configurations |
description | |
| 4 | size | Integer |
The page size for search results |
size | |
| 5 | page | Integer |
The page number for search results |
page |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dataconfig.ApiAdminDataconfigAction#get$setting()
annotations: @Execute
API action for admin data config.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dataconfig.ApiAdminDataconfigAction#post$setting()
annotations: @Execute
API action for admin data config.
Form or Body: CreateBodyRequest body for creating data config via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure | crudMode |
| 2 | name | String |
Configuration name for identifying this data source |
@Required , @Size{max=200} | name |
| 3 | description | String |
Optional description of this data configuration |
@Size{max=1000} | description |
| 4 | handler_name | String |
Handler class name for processing this data source |
@Required , @CustomSize{maxKey=form.admin.max.input.size} | handlerName |
| 5 | handler_parameter | String |
Parameters passed to the data handler |
@CustomSize{maxKey=form.admin.max.input.size} | handlerParameter |
| 6 | handler_script | String |
Script for custom data processing logic |
@CustomSize{maxKey=form.admin.max.input.size} | handlerScript |
| 7 | boost | Float |
Boost value for documents from this data source |
@Required , @ValidateTypeFailure | boost |
| 8 | available | String |
Whether this configuration is enabled (true/false) |
@Required , @Size{max=5} | available |
| 9 | permissions | String |
Access permissions for documents from this data source |
@CustomSize{maxKey=form.admin.max.input.size} | permissions |
| 10 | virtual_hosts | String |
Virtual hosts where this configuration applies |
@CustomSize{maxKey=form.admin.max.input.size} | virtualHosts |
| 11 | sort_order | Integer |
Sort order for displaying configurations |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 12 | created_by | String |
User who created this configuration |
@Size{max=1000} | createdBy |
| 13 | created_time | Long |
Timestamp when this configuration was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dataconfig.ApiAdminDataconfigAction#put$setting()
annotations: @Execute
API action for admin data config.
Form or Body: EditBodyRequest body class for data config edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the data configuration being edited |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
The username of the user who last updated this data configuration |
@Size{max=1000} | updatedBy |
| 3 | updated_time | Long |
The timestamp when this data configuration was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Integer |
The version number of the data configuration for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | crud_mode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure | crudMode |
| 6 | name | String |
Configuration name for identifying this data source |
@Required , @Size{max=200} | name |
| 7 | description | String |
Optional description of this data configuration |
@Size{max=1000} | description |
| 8 | handler_name | String |
Handler class name for processing this data source |
@Required , @CustomSize{maxKey=form.admin.max.input.size} | handlerName |
| 9 | handler_parameter | String |
Parameters passed to the data handler |
@CustomSize{maxKey=form.admin.max.input.size} | handlerParameter |
| 10 | handler_script | String |
Script for custom data processing logic |
@CustomSize{maxKey=form.admin.max.input.size} | handlerScript |
| 11 | boost | Float |
Boost value for documents from this data source |
@Required , @ValidateTypeFailure | boost |
| 12 | available | String |
Whether this configuration is enabled (true/false) |
@Required , @Size{max=5} | available |
| 13 | permissions | String |
Access permissions for documents from this data source |
@CustomSize{maxKey=form.admin.max.input.size} | permissions |
| 14 | virtual_hosts | String |
Virtual hosts where this configuration applies |
@CustomSize{maxKey=form.admin.max.input.size} | virtualHosts |
| 15 | sort_order | Integer |
Sort order for displaying configurations |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 16 | created_by | String |
User who created this configuration |
@Size{max=1000} | createdBy |
| 17 | created_time | Long |
Timestamp when this configuration was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dataconfig.ApiAdminDataconfigAction#delete$setting()
annotations: @Execute
API action for admin data config.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.ApiAdminDictAction#get$index()
annotations: @Execute
API action for admin dictionary management.
Provides REST endpoints for managing dictionaries in the Fess search engine.
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.kuromoji.ApiAdminDictKuromojiAction#get$settings()
annotations: @Execute
API action for admin Kuromoji dictionary management.
Provides REST endpoints for managing Kuromoji dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Search request body for Kuromoji dictionary administration.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
The dictionary ID for the search operation |
@Required | dictId |
| 2 | size | Integer |
The page size for search results |
size | |
| 3 | page | Integer |
The page number for search results |
page |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.kuromoji.ApiAdminDictKuromojiAction#get$setting()
annotations: @Execute
API action for admin Kuromoji dictionary management.
Provides REST endpoints for managing Kuromoji dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
||
| 2 | id | long |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.kuromoji.ApiAdminDictKuromojiAction#post$setting()
annotations: @Execute
API action for admin Kuromoji dictionary management.
Provides REST endpoints for managing Kuromoji dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Request body for creating kuromoji dictionary via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
Dictionary identifier |
@Required | dictId |
| 2 | crud_mode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure | crudMode |
| 3 | token | String |
Token (word) to be added to the dictionary |
@Required , @Size{max=1000} | token |
| 4 | segmentation | String |
Segmentation information for the token |
@Required , @Size{max=1000} | segmentation |
| 5 | reading | String |
Reading (pronunciation) of the token in katakana |
@Required , @Size{max=1000} | reading |
| 6 | pos | String |
Part of speech tag for the token |
@Required , @Size{max=1000} | pos |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.kuromoji.ApiAdminDictKuromojiAction#put$setting()
annotations: @Execute
API action for admin Kuromoji dictionary management.
Provides REST endpoints for managing Kuromoji dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Request body class for Kuromoji dictionary edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the Kuromoji dictionary entry being edited |
@Required , @ValidateTypeFailure | id |
| 2 | dict_id | String |
Dictionary identifier |
@Required | dictId |
| 3 | crud_mode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure | crudMode |
| 4 | token | String |
Token (word) to be added to the dictionary |
@Required , @Size{max=1000} | token |
| 5 | segmentation | String |
Segmentation information for the token |
@Required , @Size{max=1000} | segmentation |
| 6 | reading | String |
Reading (pronunciation) of the token in katakana |
@Required , @Size{max=1000} | reading |
| 7 | pos | String |
Part of speech tag for the token |
@Required , @Size{max=1000} | pos |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.kuromoji.ApiAdminDictKuromojiAction#delete$setting()
annotations: @Execute
API action for admin Kuromoji dictionary management.
Provides REST endpoints for managing Kuromoji dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
||
| 2 | id | long |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.kuromoji.ApiAdminDictKuromojiAction#put$upload()
annotations: @Execute
API action for admin Kuromoji dictionary management.
Provides REST endpoints for managing Kuromoji dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Form for uploading Kuromoji dictionary files to the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID that identifies which Kuromoji dictionary configuration to update |
@Required |
| 2 | kuromojiFile | MultipartFormFile |
The multipart file containing the Kuromoji user dictionary to be uploaded |
@Required |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.kuromoji.ApiAdminDictKuromojiAction#get$download()
annotations: @Execute
API action for admin Kuromoji dictionary management.
Provides REST endpoints for managing Kuromoji dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Download body for Kuromoji dictionary API operations.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
Dictionary ID for identifying the Kuromoji dictionary to download |
@Required | dictId |
Execute Method: org.codelibs.fess.app.web.api.admin.dict.mapping.ApiAdminDictMappingAction#get$settings()
annotations: @Execute
API action for CRUD and file operations on dictionary character mappings.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Search request body for mapping dictionary administration.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
The dictionary ID for the search operation |
@Required | dictId |
| 2 | size | Integer |
The page size for search results |
size | |
| 3 | page | Integer |
The page number for search results |
page |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.mapping.ApiAdminDictMappingAction#get$setting()
annotations: @Execute
API action for CRUD and file operations on dictionary character mappings.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
||
| 2 | id | long |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.mapping.ApiAdminDictMappingAction#post$setting()
annotations: @Execute
API action for CRUD and file operations on dictionary character mappings.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Request body for creating mapping dictionary via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
Dictionary identifier |
@Required | dictId |
| 2 | crud_mode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure | crudMode |
| 3 | inputs | String |
Input terms (comma-separated) that will be mapped to the output term |
@Required , @Size{max=1000} | inputs |
| 4 | output | String |
Output term that input terms will be mapped to |
@Size{max=1000, min=1} | output |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.mapping.ApiAdminDictMappingAction#put$setting()
annotations: @Execute
API action for CRUD and file operations on dictionary character mappings.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Request body class for mapping dictionary edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the mapping dictionary entry being edited |
@Required , @ValidateTypeFailure | id |
| 2 | dict_id | String |
Dictionary identifier |
@Required | dictId |
| 3 | crud_mode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure | crudMode |
| 4 | inputs | String |
Input terms (comma-separated) that will be mapped to the output term |
@Required , @Size{max=1000} | inputs |
| 5 | output | String |
Output term that input terms will be mapped to |
@Size{max=1000, min=1} | output |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.mapping.ApiAdminDictMappingAction#delete$setting()
annotations: @Execute
API action for CRUD and file operations on dictionary character mappings.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
||
| 2 | id | long |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.mapping.ApiAdminDictMappingAction#put$upload()
annotations: @Execute
API action for CRUD and file operations on dictionary character mappings.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Form for uploading character mapping files to the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID that identifies which character mapping dictionary configuration to update |
@Required |
| 2 | charMappingFile | MultipartFormFile |
The multipart file containing the character mapping rules to be uploaded |
@Required |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.mapping.ApiAdminDictMappingAction#get$download()
annotations: @Execute
API action for CRUD and file operations on dictionary character mappings.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Download body for mapping dictionary API operations.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
Dictionary ID for identifying the mapping dictionary to download |
@Required | dictId |
Execute Method: org.codelibs.fess.app.web.api.admin.dict.protwords.ApiAdminDictProtwordsAction#get$settings()
annotations: @Execute
API action for CRUD and file operations on dictionary protected words (protwords).
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Search request body for protected words dictionary administration.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
The dictionary ID for the search operation |
@Required | dictId |
| 2 | size | Integer |
The page size for search results |
size | |
| 3 | page | Integer |
The page number for search results |
page |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.protwords.ApiAdminDictProtwordsAction#get$setting()
annotations: @Execute
API action for CRUD and file operations on dictionary protected words (protwords).
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
||
| 2 | id | long |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.protwords.ApiAdminDictProtwordsAction#post$setting()
annotations: @Execute
API action for CRUD and file operations on dictionary protected words (protwords).
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Request body for creating protected words dictionary via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
Dictionary identifier |
@Required | dictId |
| 2 | crud_mode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure | crudMode |
| 3 | input | String |
Word or phrase to be protected from analysis |
@Required , @Size{max=1000} | input |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.protwords.ApiAdminDictProtwordsAction#put$setting()
annotations: @Execute
API action for CRUD and file operations on dictionary protected words (protwords).
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Request body class for protected words dictionary edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the protected words dictionary entry being edited |
@Required , @ValidateTypeFailure | id |
| 2 | dict_id | String |
Dictionary identifier |
@Required | dictId |
| 3 | crud_mode | Integer |
CRUD operation mode (CREATE, EDIT, etc |
@ValidateTypeFailure | crudMode |
| 4 | input | String |
Word or phrase to be protected from analysis |
@Required , @Size{max=1000} | input |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.protwords.ApiAdminDictProtwordsAction#delete$setting()
annotations: @Execute
API action for CRUD and file operations on dictionary protected words (protwords).
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
||
| 2 | id | long |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.protwords.ApiAdminDictProtwordsAction#put$upload()
annotations: @Execute
API action for CRUD and file operations on dictionary protected words (protwords).
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Form for uploading protected words files to the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID that identifies which protected words dictionary configuration to update |
@Required |
| 2 | protwordsFile | MultipartFormFile |
The multipart file containing the protected words to be uploaded |
@Required |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.protwords.ApiAdminDictProtwordsAction#get$download()
annotations: @Execute
API action for CRUD and file operations on dictionary protected words (protwords).
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Download body for protected words dictionary API operations.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
Dictionary ID for identifying the protected words dictionary to download |
@Required | dictId |
Execute Method: org.codelibs.fess.app.web.api.admin.dict.stemmeroverride.ApiAdminDictStemmeroverrideAction#get$settings()
annotations: @Execute
API action for admin Stemmer Override dictionary management.
Provides REST endpoints for managing stemmer override dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Search request body for stemmer override dictionary administration.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
The dictionary ID for the search operation |
@Required | dictId |
| 2 | size | Integer |
The page size for search results |
size | |
| 3 | page | Integer |
The page number for search results |
page |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.stemmeroverride.ApiAdminDictStemmeroverrideAction#get$setting()
annotations: @Execute
API action for admin Stemmer Override dictionary management.
Provides REST endpoints for managing stemmer override dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
||
| 2 | id | long |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.stemmeroverride.ApiAdminDictStemmeroverrideAction#post$setting()
annotations: @Execute
API action for admin Stemmer Override dictionary management.
Provides REST endpoints for managing stemmer override dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Request body for creating stemmer override dictionary via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
The dictionary ID to which this stemmer override entry belongs |
@Required | dictId |
| 2 | crud_mode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure | crudMode |
| 3 | input | String |
The input word that should be stemmed differently |
@Required , @Size{max=1000} | input |
| 4 | output | String |
The desired stem output for the input word |
@Required , @Size{max=1000} | output |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.stemmeroverride.ApiAdminDictStemmeroverrideAction#put$setting()
annotations: @Execute
API action for admin Stemmer Override dictionary management.
Provides REST endpoints for managing stemmer override dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Request body class for stemmer override dictionary edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the stemmer override dictionary entry being edited |
@Required , @ValidateTypeFailure | id |
| 2 | dict_id | String |
The dictionary ID to which this stemmer override entry belongs |
@Required | dictId |
| 3 | crud_mode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure | crudMode |
| 4 | input | String |
The input word that should be stemmed differently |
@Required , @Size{max=1000} | input |
| 5 | output | String |
The desired stem output for the input word |
@Required , @Size{max=1000} | output |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.stemmeroverride.ApiAdminDictStemmeroverrideAction#delete$setting()
annotations: @Execute
API action for admin Stemmer Override dictionary management.
Provides REST endpoints for managing stemmer override dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
||
| 2 | id | long |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.stemmeroverride.ApiAdminDictStemmeroverrideAction#put$upload()
annotations: @Execute
API action for admin Stemmer Override dictionary management.
Provides REST endpoints for managing stemmer override dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Form for uploading stemmer override files to the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID that identifies which stemmer override dictionary configuration to update |
@Required |
| 2 | stemmerOverrideFile | MultipartFormFile |
The multipart file containing the stemmer override rules to be uploaded |
@Required |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.stemmeroverride.ApiAdminDictStemmeroverrideAction#get$download()
annotations: @Execute
API action for admin Stemmer Override dictionary management.
Provides REST endpoints for managing stemmer override dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Download body for stemmer override dictionary API operations.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
Dictionary ID for identifying the stemmer override dictionary to download |
@Required | dictId |
Execute Method: org.codelibs.fess.app.web.api.admin.dict.stopwords.ApiAdminDictStopwordsAction#get$settings()
annotations: @Execute
API action for admin Stopwords dictionary management.
Provides REST endpoints for managing stopwords dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Search request body for stop words dictionary administration.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
The dictionary ID for the search operation |
@Required | dictId |
| 2 | size | Integer |
The page size for search results |
size | |
| 3 | page | Integer |
The page number for search results |
page |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.stopwords.ApiAdminDictStopwordsAction#get$setting()
annotations: @Execute
API action for admin Stopwords dictionary management.
Provides REST endpoints for managing stopwords dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
||
| 2 | id | long |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.stopwords.ApiAdminDictStopwordsAction#post$setting()
annotations: @Execute
API action for admin Stopwords dictionary management.
Provides REST endpoints for managing stopwords dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Request body for creating stop words dictionary via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
The dictionary ID to which this stopword entry belongs |
@Required | dictId |
| 2 | crud_mode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure | crudMode |
| 3 | input | String |
The stopword to be added to the dictionary |
@Required , @Size{max=1000} | input |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.stopwords.ApiAdminDictStopwordsAction#put$setting()
annotations: @Execute
API action for admin Stopwords dictionary management.
Provides REST endpoints for managing stopwords dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Request body class for stop words dictionary edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the stopwords dictionary entry being edited |
@Required , @ValidateTypeFailure | id |
| 2 | dict_id | String |
The dictionary ID to which this stopword entry belongs |
@Required | dictId |
| 3 | crud_mode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure | crudMode |
| 4 | input | String |
The stopword to be added to the dictionary |
@Required , @Size{max=1000} | input |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.stopwords.ApiAdminDictStopwordsAction#delete$setting()
annotations: @Execute
API action for admin Stopwords dictionary management.
Provides REST endpoints for managing stopwords dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
||
| 2 | id | long |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.stopwords.ApiAdminDictStopwordsAction#put$upload()
annotations: @Execute
API action for admin Stopwords dictionary management.
Provides REST endpoints for managing stopwords dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Form for uploading stopwords files to the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID that identifies which stopwords dictionary configuration to update |
@Required |
| 2 | stopwordsFile | MultipartFormFile |
The multipart file containing the stopwords to be uploaded |
@Required |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.stopwords.ApiAdminDictStopwordsAction#get$download()
annotations: @Execute
API action for admin Stopwords dictionary management.
Provides REST endpoints for managing stopwords dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Download body for stop words dictionary API operations.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
Dictionary ID for identifying the stop words dictionary to download |
@Required | dictId |
Execute Method: org.codelibs.fess.app.web.api.admin.dict.synonym.ApiAdminDictSynonymAction#get$settings()
annotations: @Execute
API action for admin Synonym dictionary management.
Provides REST endpoints for managing synonym dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Search request body for synonym dictionary administration.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
The dictionary ID for the search operation |
@Required | dictId |
| 2 | size | Integer |
The page size for search results |
size | |
| 3 | page | Integer |
The page number for search results |
page |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.synonym.ApiAdminDictSynonymAction#get$setting()
annotations: @Execute
API action for admin Synonym dictionary management.
Provides REST endpoints for managing synonym dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
||
| 2 | id | long |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.synonym.ApiAdminDictSynonymAction#post$setting()
annotations: @Execute
API action for admin Synonym dictionary management.
Provides REST endpoints for managing synonym dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Request body for creating synonym dictionary via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
The dictionary ID to which this synonym entry belongs |
@Required | dictId |
| 2 | crud_mode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure | crudMode |
| 3 | inputs | String |
The input terms that should be considered synonymous |
@Required , @Size{max=1000} | inputs |
| 4 | outputs | String |
The output synonyms that should be matched for the input terms |
@Required , @Size{max=1000} | outputs |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.synonym.ApiAdminDictSynonymAction#put$setting()
annotations: @Execute
API action for admin Synonym dictionary management.
Provides REST endpoints for managing synonym dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Request body class for synonym dictionary edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | Long |
The unique identifier of the synonym dictionary entry being edited |
@Required , @ValidateTypeFailure | id |
| 2 | dict_id | String |
The dictionary ID to which this synonym entry belongs |
@Required | dictId |
| 3 | crud_mode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure | crudMode |
| 4 | inputs | String |
The input terms that should be considered synonymous |
@Required , @Size{max=1000} | inputs |
| 5 | outputs | String |
The output synonyms that should be matched for the input terms |
@Required , @Size{max=1000} | outputs |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.synonym.ApiAdminDictSynonymAction#delete$setting()
annotations: @Execute
API action for admin Synonym dictionary management.
Provides REST endpoints for managing synonym dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
||
| 2 | id | long |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.synonym.ApiAdminDictSynonymAction#put$upload()
annotations: @Execute
API action for admin Synonym dictionary management.
Provides REST endpoints for managing synonym dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Form for uploading synonym files to the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
The dictionary ID that identifies which synonym dictionary configuration to update |
@Required |
| 2 | synonymFile | MultipartFormFile |
The multipart file containing the synonym mappings to be uploaded |
@Required |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.dict.synonym.ApiAdminDictSynonymAction#get$download()
annotations: @Execute
API action for admin Synonym dictionary management.
Provides REST endpoints for managing synonym dictionary items in the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | dictId | String |
Download body for synonym dictionary API operations.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | dict_id | String |
Dictionary ID for identifying the synonym dictionary to download |
@Required | dictId |
Execute Method: org.codelibs.fess.app.web.api.admin.documents.ApiAdminDocumentsAction#put$bulk()
annotations: @Execute
API action for admin document management.
Provides RESTful API endpoints for bulk document operations in the Fess search engine.
Supports indexing multiple documents with automatic field validation and default value assignment.
Request body for bulk document operations containing a list of documents.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | documents | List<String, Object>> |
List of documents to be processed in bulk operations |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.duplicatehost.ApiAdminDuplicatehostAction#settings()
annotations: @Execute
API action for admin duplicate host management.
Provides RESTful API endpoints for managing duplicate host settings in the Fess search engine.
Duplicate host settings help prevent indexing the same content from multiple similar URLs.
Returns list of duplicate host settings.
Supports both GET and PUT requests for retrieving paginated duplicate host configurations.
@param body search parameters for filtering and pagination
@return JSON response containing duplicate host settings list with pagination info
Search request body for duplicate host administration.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | regular_name | String |
The regular host name to search for |
regularName | |
| 2 | duplicate_host_name | String |
The duplicate host name to search for |
duplicateHostName | |
| 3 | size | Integer |
The page size for search results |
size | |
| 4 | page | Integer |
The page number for search results |
page |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.duplicatehost.ApiAdminDuplicatehostAction#get$setting()
annotations: @Execute
API action for admin duplicate host management.
Provides RESTful API endpoints for managing duplicate host settings in the Fess search engine.
Duplicate host settings help prevent indexing the same content from multiple similar URLs.
Returns specific duplicate host setting by ID.
@param id the duplicate host setting ID
@return JSON response containing the duplicate host setting details
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the duplicate host setting ID |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.duplicatehost.ApiAdminDuplicatehostAction#post$setting()
annotations: @Execute
API action for admin duplicate host management.
Provides RESTful API endpoints for managing duplicate host settings in the Fess search engine.
Duplicate host settings help prevent indexing the same content from multiple similar URLs.
Creates a new duplicate host setting.
@param body duplicate host setting data to create
@return JSON response with created setting ID and status
Request body for creating duplicate host via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure | crudMode |
| 2 | regular_name | String |
The regular canonical hostname that should be used |
@Required , @Size{max=1000} | regularName |
| 3 | duplicate_host_name | String |
The duplicate hostname that should be redirected to the regular name |
@Required , @Size{max=1000} | duplicateHostName |
| 4 | sort_order | Integer |
The sort order for displaying this duplicate host entry |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 5 | created_by | String |
The username of who created this duplicate host entry |
@Size{max=1000} | createdBy |
| 6 | created_time | Long |
The timestamp when this duplicate host entry was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.duplicatehost.ApiAdminDuplicatehostAction#put$setting()
annotations: @Execute
API action for admin duplicate host management.
Provides RESTful API endpoints for managing duplicate host settings in the Fess search engine.
Duplicate host settings help prevent indexing the same content from multiple similar URLs.
Updates an existing duplicate host setting.
@param body duplicate host setting data to update
@return JSON response with updated setting ID and status
Request body class for duplicate host edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the duplicate host configuration being edited |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
The username of the user who last updated this duplicate host configuration |
@Size{max=1000} | updatedBy |
| 3 | updated_time | Long |
The timestamp when this duplicate host configuration was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Integer |
The version number of the duplicate host configuration for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | crud_mode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure | crudMode |
| 6 | regular_name | String |
The regular canonical hostname that should be used |
@Required , @Size{max=1000} | regularName |
| 7 | duplicate_host_name | String |
The duplicate hostname that should be redirected to the regular name |
@Required , @Size{max=1000} | duplicateHostName |
| 8 | sort_order | Integer |
The sort order for displaying this duplicate host entry |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 9 | created_by | String |
The username of who created this duplicate host entry |
@Size{max=1000} | createdBy |
| 10 | created_time | Long |
The timestamp when this duplicate host entry was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.duplicatehost.ApiAdminDuplicatehostAction#delete$setting()
annotations: @Execute
API action for admin duplicate host management.
Provides RESTful API endpoints for managing duplicate host settings in the Fess search engine.
Duplicate host settings help prevent indexing the same content from multiple similar URLs.
Deletes a specific duplicate host setting.
@param id the duplicate host setting ID to delete
@return JSON response with deletion status
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the duplicate host setting ID to delete |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.elevateword.ApiAdminElevatewordAction#settings()
annotations: @Execute
API action for admin elevate word management.
Provides RESTful API endpoints for managing elevate word settings in the Fess search engine.
Elevate words boost specific search terms to appear higher in search results.
Returns list of elevate word settings.
Supports both GET and PUT requests for retrieving paginated elevate word configurations.
@param body search parameters for filtering and pagination
@return JSON response containing elevate word settings list with pagination info
Search request body for elevate word administration.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The elevate word ID to search for |
|
| 2 | size | Integer |
The page size for search results |
|
| 3 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.elevateword.ApiAdminElevatewordAction#get$setting()
annotations: @Execute
API action for admin elevate word management.
Provides RESTful API endpoints for managing elevate word settings in the Fess search engine.
Elevate words boost specific search terms to appear higher in search results.
Retrieves a specific elevate word setting by ID.
@param id the ID of the elevate word to retrieve
@return JSON response containing the elevate word configuration
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the ID of the elevate word to retrieve |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.elevateword.ApiAdminElevatewordAction#post$setting()
annotations: @Execute
API action for admin elevate word management.
Provides RESTful API endpoints for managing elevate word settings in the Fess search engine.
Elevate words boost specific search terms to appear higher in search results.
Creates a new elevate word setting.
Also adds the elevate word to the suggest helper for search enhancement.
@param body elevate word setting data to create
@return JSON response with created setting ID and status
Request body for creating elevate word via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | label_type_ids | String[] |
The label type IDs associated with this elevate word entry |
labelTypeIds | |
| 2 | crud_mode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure | crudMode |
| 3 | suggest_word | String |
The word that should trigger document elevation in search results |
@Required | suggestWord |
| 4 | reading | String |
The reading/pronunciation of the suggest word for language analysis |
reading | |
| 5 | target_label | String |
The target label for filtering documents to be elevated |
targetLabel | |
| 6 | permissions | String |
The permission settings for accessing this elevate word configuration |
@CustomSize{maxKey=form.admin.max.input.size} | permissions |
| 7 | boost | Float |
The boost score multiplier applied to elevated documents |
@Required , @ValidateTypeFailure | boost |
| 8 | created_by | String |
The username of who created this elevate word entry |
@Size{max=1000} | createdBy |
| 9 | created_time | Long |
The timestamp when this elevate word entry was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.elevateword.ApiAdminElevatewordAction#put$setting()
annotations: @Execute
API action for admin elevate word management.
Provides RESTful API endpoints for managing elevate word settings in the Fess search engine.
Elevate words boost specific search terms to appear higher in search results.
Updates an existing elevate word setting.
Refreshes all elevate words in the suggest helper to maintain consistency.
@param body elevate word setting data to update
@return JSON response with updated setting ID and status
Request body class for elevate word edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the elevate word configuration being edited |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
The username of the user who last updated this elevate word configuration |
@Size{max=1000} | updatedBy |
| 3 | updated_time | Long |
The timestamp when this elevate word configuration was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Long |
The version number of the elevate word configuration for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | label_type_ids | String[] |
The label type IDs associated with this elevate word entry |
labelTypeIds | |
| 6 | crud_mode | Integer |
The CRUD operation mode for form processing |
@ValidateTypeFailure | crudMode |
| 7 | suggest_word | String |
The word that should trigger document elevation in search results |
@Required | suggestWord |
| 8 | reading | String |
The reading/pronunciation of the suggest word for language analysis |
reading | |
| 9 | target_label | String |
The target label for filtering documents to be elevated |
targetLabel | |
| 10 | permissions | String |
The permission settings for accessing this elevate word configuration |
@CustomSize{maxKey=form.admin.max.input.size} | permissions |
| 11 | boost | Float |
The boost score multiplier applied to elevated documents |
@Required , @ValidateTypeFailure | boost |
| 12 | created_by | String |
The username of who created this elevate word entry |
@Size{max=1000} | createdBy |
| 13 | created_time | Long |
The timestamp when this elevate word entry was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.elevateword.ApiAdminElevatewordAction#delete$setting()
annotations: @Execute
API action for admin elevate word management.
Provides RESTful API endpoints for managing elevate word settings in the Fess search engine.
Elevate words boost specific search terms to appear higher in search results.
Deletes a specific elevate word setting.
Also removes the elevate word from the suggest helper.
@param id the elevate word setting ID to delete
@return JSON response with deletion status
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the elevate word setting ID to delete |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.elevateword.ApiAdminElevatewordAction#put$upload()
annotations: @Execute
API action for admin elevate word management.
Provides RESTful API endpoints for managing elevate word settings in the Fess search engine.
Elevate words boost specific search terms to appear higher in search results.
Uploads and imports elevate words from a CSV file.
Processes the file asynchronously and updates the suggest helper.
@param body upload form containing the CSV file
@return JSON response with upload status
Form for uploading elevate word files to the Fess search engine.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | elevateWordFile | MultipartFormFile |
The multipart file containing the elevate word configurations to be uploaded |
@Required |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.elevateword.ApiAdminElevatewordAction#get$download()
annotations: @Execute
API action for admin elevate word management.
Provides RESTful API endpoints for managing elevate word settings in the Fess search engine.
Elevate words boost specific search terms to appear higher in search results.
Downloads all elevate words as a CSV file.
Creates a temporary file with the exported data for download.
@param body download parameters
@return stream response containing the CSV file
Download body for elevate word API operations.
Return as: StreamResponseExecute Method: org.codelibs.fess.app.web.api.admin.failureurl.ApiAdminFailureurlAction#logs()
annotations: @Execute
API action for admin failure URL.
Retrieves failure URL logs with pagination.
@param body the search criteria
@return JSON response containing the failure URL logs
Search request body for failure URL administration API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | url | String |
The URL that failed during crawling |
url | |
| 2 | error_count_min | Integer |
Minimum error count filter |
errorCountMin | |
| 3 | error_count_max | Integer |
Maximum error count filter |
errorCountMax | |
| 4 | error_name | String |
Name or type of the error |
errorName | |
| 5 | size | Integer |
The page size for search results |
size | |
| 6 | page | Integer |
The page number for search results |
page |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.failureurl.ApiAdminFailureurlAction#get$log()
annotations: @Execute
API action for admin failure URL.
Retrieves a specific failure URL log by ID.
@param id the failure URL log ID
@return JSON response containing the failure URL log
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the failure URL log ID |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.failureurl.ApiAdminFailureurlAction#delete$log()
annotations: @Execute
API action for admin failure URL.
Deletes a failure URL log by ID.
@param id the failure URL log ID to delete
@return JSON response with result status
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the failure URL log ID to delete |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.failureurl.ApiAdminFailureurlAction#delete$all()
annotations: @Execute
API action for admin failure URL.
Deletes all failure URL logs.
@return JSON response with result status
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.fileauth.ApiAdminFileauthAction#settings()
annotations: @Execute
API action for admin file authentication management.
Provides RESTful API endpoints for managing file authentication settings in the Fess search engine.
File authentication settings define access credentials and permissions for file-based crawling.
Returns list of file authentication settings.
Supports both GET and PUT requests for retrieving paginated file authentication configurations.
@param body search parameters for filtering and pagination
@return JSON response containing file authentication settings list with pagination info
Search request body for file authentication administration API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
File authentication configuration ID |
|
| 2 | size | Integer |
The page size for search results |
|
| 3 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.fileauth.ApiAdminFileauthAction#get$setting()
annotations: @Execute
API action for admin file authentication management.
Provides RESTful API endpoints for managing file authentication settings in the Fess search engine.
File authentication settings define access credentials and permissions for file-based crawling.
Returns specific file authentication setting by ID.
@param id the file authentication setting ID
@return JSON response containing the file authentication setting details
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the file authentication setting ID |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.fileauth.ApiAdminFileauthAction#post$setting()
annotations: @Execute
API action for admin file authentication management.
Provides RESTful API endpoints for managing file authentication settings in the Fess search engine.
File authentication settings define access credentials and permissions for file-based crawling.
Creates a new file authentication setting.
Validates that the associated file config ID is valid before creation.
@param body file authentication setting data to create
@return JSON response with created setting ID and status
Request body for creating file authentication via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure | crudMode |
| 2 | hostname | String |
The hostname of the file server (maximum 100 characters) |
@Size{max=100} | hostname |
| 3 | port | Integer |
The port number of the file server (0 to 2147483647) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | port |
| 4 | protocol_scheme | String |
The protocol scheme for file access (maximum 10 characters) |
@Size{max=10} | protocolScheme |
| 5 | username | String |
The username for file authentication (required, maximum 100 characters) |
@Required , @Size{max=100} | username |
| 6 | password | String |
The password for file authentication (maximum 100 characters) |
@Size{max=100} | password |
| 7 | parameters | String |
Additional parameters for file authentication (maximum 1000 characters) |
@Size{max=1000} | parameters |
| 8 | file_config_id | String |
The ID of the associated file configuration (required, maximum 1000 characters) |
@Required , @Size{max=1000} | fileConfigId |
| 9 | created_by | String |
The user who created this file authentication configuration (maximum 1000 characters) |
@Size{max=1000} | createdBy |
| 10 | created_time | Long |
The timestamp when this file authentication configuration was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.fileauth.ApiAdminFileauthAction#put$setting()
annotations: @Execute
API action for admin file authentication management.
Provides RESTful API endpoints for managing file authentication settings in the Fess search engine.
File authentication settings define access credentials and permissions for file-based crawling.
Updates an existing file authentication setting.
@param body file authentication setting data to update
@return JSON response with updated setting ID and status
Request body class for file authentication edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the file authentication configuration being edited |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
The username of the user who last updated this file authentication configuration |
@Size{max=255} | updatedBy |
| 3 | updated_time | Long |
The timestamp when this file authentication configuration was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Integer |
The version number of the file authentication configuration for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | crud_mode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure | crudMode |
| 6 | hostname | String |
The hostname of the file server (maximum 100 characters) |
@Size{max=100} | hostname |
| 7 | port | Integer |
The port number of the file server (0 to 2147483647) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | port |
| 8 | protocol_scheme | String |
The protocol scheme for file access (maximum 10 characters) |
@Size{max=10} | protocolScheme |
| 9 | username | String |
The username for file authentication (required, maximum 100 characters) |
@Required , @Size{max=100} | username |
| 10 | password | String |
The password for file authentication (maximum 100 characters) |
@Size{max=100} | password |
| 11 | parameters | String |
Additional parameters for file authentication (maximum 1000 characters) |
@Size{max=1000} | parameters |
| 12 | file_config_id | String |
The ID of the associated file configuration (required, maximum 1000 characters) |
@Required , @Size{max=1000} | fileConfigId |
| 13 | created_by | String |
The user who created this file authentication configuration (maximum 1000 characters) |
@Size{max=1000} | createdBy |
| 14 | created_time | Long |
The timestamp when this file authentication configuration was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.fileauth.ApiAdminFileauthAction#delete$setting()
annotations: @Execute
API action for admin file authentication management.
Provides RESTful API endpoints for managing file authentication settings in the Fess search engine.
File authentication settings define access credentials and permissions for file-based crawling.
Deletes a specific file authentication setting.
@param id the file authentication setting ID to delete
@return JSON response with deletion status
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the file authentication setting ID to delete |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.fileconfig.ApiAdminFileconfigAction#settings()
annotations: @Execute
API action for admin file configuration management.
Provides RESTful API endpoints for managing file crawling configuration settings in the Fess search engine.
File configurations define settings for crawling file systems, FTP servers, and other file-based data sources.
Returns list of file configuration settings.
Supports both GET and PUT requests for retrieving paginated file configuration settings.
@param body search parameters for filtering and pagination
@return JSON response containing file configuration settings list with pagination info
Search request body for file crawling configuration administration API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
Name of the file crawling configuration |
|
| 2 | paths | String |
File paths to crawl |
|
| 3 | description | String |
Description of the file crawling configuration |
|
| 4 | size | Integer |
The page size for search results |
|
| 5 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.fileconfig.ApiAdminFileconfigAction#get$setting()
annotations: @Execute
API action for admin file configuration management.
Provides RESTful API endpoints for managing file crawling configuration settings in the Fess search engine.
File configurations define settings for crawling file systems, FTP servers, and other file-based data sources.
Returns specific file configuration setting by ID.
@param id the file configuration setting ID
@return JSON response containing the file configuration setting details
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the file configuration setting ID |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.fileconfig.ApiAdminFileconfigAction#post$setting()
annotations: @Execute
API action for admin file configuration management.
Provides RESTful API endpoints for managing file crawling configuration settings in the Fess search engine.
File configurations define settings for crawling file systems, FTP servers, and other file-based data sources.
Creates a new file configuration setting.
@param body file configuration setting data to create
@return JSON response with created setting ID and status
Request body for creating file configuration via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | label_type_ids | String[] |
The IDs of label types associated with this file configuration |
labelTypeIds | |
| 2 | crud_mode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure | crudMode |
| 3 | name | String |
The name of the file configuration (required, maximum 200 characters) |
@Required , @Size{max=200} | name |
| 4 | description | String |
The description of the file configuration (maximum 1000 characters) |
@Size{max=1000} | description |
| 5 | paths | String |
The file paths to crawl (required, must be valid file URIs) |
@Required , @UriType{protocolType=FILE} , @CustomSize{maxKey=form.admin.max.input.size} | paths |
| 6 | included_paths | String |
The paths to include during crawling (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} | includedPaths |
| 7 | excluded_paths | String |
The paths to exclude during crawling (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} | excludedPaths |
| 8 | included_doc_paths | String |
The document paths to include in search results (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} | includedDocPaths |
| 9 | excluded_doc_paths | String |
The document paths to exclude from search results (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} | excludedDocPaths |
| 10 | config_parameter | String |
Additional configuration parameters for the file crawler |
@CustomSize{maxKey=form.admin.max.input.size} | configParameter |
| 11 | depth | Integer |
The maximum crawling depth (0 to 2147483647, 0 means unlimited) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | depth |
| 12 | max_access_count | Long |
The maximum number of documents to access during crawling (0 means unlimited) |
@Min{value=0} , @Max{value=9223372036854775807} , @ValidateTypeFailure | maxAccessCount |
| 13 | num_of_thread | Integer |
The number of threads to use for crawling (required, 1 to 2147483647) |
@Required , @Min{value=1} , @Max{value=2147483647} , @ValidateTypeFailure | numOfThread |
| 14 | interval_time | Integer |
The interval time between crawl requests in milliseconds (required, 0 to 2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | intervalTime |
| 15 | boost | Float |
The boost value for search ranking (required) |
@Required , @ValidateTypeFailure | boost |
| 16 | available | String |
Whether this configuration is available for crawling (required, maximum 5 characters) |
@Required , @Size{max=5} | available |
| 17 | permissions | String |
The permissions required to access documents from this configuration |
@CustomSize{maxKey=form.admin.max.input.size} | permissions |
| 18 | virtual_hosts | String |
The virtual hosts associated with this file configuration |
@CustomSize{maxKey=form.admin.max.input.size} | virtualHosts |
| 19 | sort_order | Integer |
The sort order for this configuration (required, 0 to 2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 20 | created_by | String |
The user who created this file configuration (maximum 1000 characters) |
@Size{max=1000} | createdBy |
| 21 | created_time | Long |
The timestamp when this file configuration was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.fileconfig.ApiAdminFileconfigAction#put$setting()
annotations: @Execute
API action for admin file configuration management.
Provides RESTful API endpoints for managing file crawling configuration settings in the Fess search engine.
File configurations define settings for crawling file systems, FTP servers, and other file-based data sources.
Updates an existing file configuration setting.
@param body file configuration setting data to update
@return JSON response with updated setting ID and status
Request body class for file config edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the file configuration being edited |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
The username of the user who last updated this file configuration |
@Size{max=1000} | updatedBy |
| 3 | updated_time | Long |
The timestamp when this file configuration was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Integer |
The version number of the file configuration for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | label_type_ids | String[] |
The IDs of label types associated with this file configuration |
labelTypeIds | |
| 6 | crud_mode | Integer |
The CRUD operation mode for this form |
@ValidateTypeFailure | crudMode |
| 7 | name | String |
The name of the file configuration (required, maximum 200 characters) |
@Required , @Size{max=200} | name |
| 8 | description | String |
The description of the file configuration (maximum 1000 characters) |
@Size{max=1000} | description |
| 9 | paths | String |
The file paths to crawl (required, must be valid file URIs) |
@Required , @UriType{protocolType=FILE} , @CustomSize{maxKey=form.admin.max.input.size} | paths |
| 10 | included_paths | String |
The paths to include during crawling (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} | includedPaths |
| 11 | excluded_paths | String |
The paths to exclude during crawling (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} | excludedPaths |
| 12 | included_doc_paths | String |
The document paths to include in search results (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} | includedDocPaths |
| 13 | excluded_doc_paths | String |
The document paths to exclude from search results (pattern-based) |
@CustomSize{maxKey=form.admin.max.input.size} | excludedDocPaths |
| 14 | config_parameter | String |
Additional configuration parameters for the file crawler |
@CustomSize{maxKey=form.admin.max.input.size} | configParameter |
| 15 | depth | Integer |
The maximum crawling depth (0 to 2147483647, 0 means unlimited) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | depth |
| 16 | max_access_count | Long |
The maximum number of documents to access during crawling (0 means unlimited) |
@Min{value=0} , @Max{value=9223372036854775807} , @ValidateTypeFailure | maxAccessCount |
| 17 | num_of_thread | Integer |
The number of threads to use for crawling (required, 1 to 2147483647) |
@Required , @Min{value=1} , @Max{value=2147483647} , @ValidateTypeFailure | numOfThread |
| 18 | interval_time | Integer |
The interval time between crawl requests in milliseconds (required, 0 to 2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | intervalTime |
| 19 | boost | Float |
The boost value for search ranking (required) |
@Required , @ValidateTypeFailure | boost |
| 20 | available | String |
Whether this configuration is available for crawling (required, maximum 5 characters) |
@Required , @Size{max=5} | available |
| 21 | permissions | String |
The permissions required to access documents from this configuration |
@CustomSize{maxKey=form.admin.max.input.size} | permissions |
| 22 | virtual_hosts | String |
The virtual hosts associated with this file configuration |
@CustomSize{maxKey=form.admin.max.input.size} | virtualHosts |
| 23 | sort_order | Integer |
The sort order for this configuration (required, 0 to 2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 24 | created_by | String |
The user who created this file configuration (maximum 1000 characters) |
@Size{max=1000} | createdBy |
| 25 | created_time | Long |
The timestamp when this file configuration was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.fileconfig.ApiAdminFileconfigAction#delete$setting()
annotations: @Execute
API action for admin file configuration management.
Provides RESTful API endpoints for managing file crawling configuration settings in the Fess search engine.
File configurations define settings for crawling file systems, FTP servers, and other file-based data sources.
Deletes a specific file configuration setting.
@param id the file configuration setting ID to delete
@return JSON response with deletion status
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the file configuration setting ID to delete |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.general.ApiAdminGeneralAction#get$index()
annotations: @Execute
API action for admin general settings management.
Provides RESTful API endpoints for managing general system configuration settings in the Fess search engine.
General settings include system-wide parameters, LDAP configuration, and core application settings.
Returns the current general system settings.
Excludes sensitive information like LDAP security credentials from the response.
@return JSON response containing the general settings configuration
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.general.ApiAdminGeneralAction#put$index()
annotations: @Execute
API action for admin general settings management.
Provides RESTful API endpoints for managing general system configuration settings in the Fess search engine.
General settings include system-wide parameters, LDAP configuration, and core application settings.
Updates the general system settings.
Merges the provided settings with existing configuration and applies changes.
@param body the general settings data to update
@return JSON response with update status
Request body class for general settings edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | incremental_crawling | String |
Enable or disable incremental crawling |
@Size{max=10} | incrementalCrawling |
| 2 | day_for_cleanup | Integer |
Number of days to keep crawled documents before cleanup |
@Required , @Min{value=-1} , @Max{value=1000} , @ValidateTypeFailure | dayForCleanup |
| 3 | crawling_thread_count | Integer |
Number of threads to use for crawling operations |
@Required , @Min{value=0} , @Max{value=100} , @ValidateTypeFailure | crawlingThreadCount |
| 4 | search_log | String |
Enable or disable search query logging |
@Size{max=10} | searchLog |
| 5 | user_info | String |
Enable or disable user information tracking |
@Size{max=10} | userInfo |
| 6 | user_favorite | String |
Enable or disable user favorite functionality |
@Size{max=10} | userFavorite |
| 7 | web_api_json | String |
Enable or disable JSON Web API |
@Size{max=10} | webApiJson |
| 8 | app_value | String |
Application-specific value for custom configurations |
@Size{max=10000} | appValue |
| 9 | default_label_value | String |
Default label value to use when no specific label is selected |
@Size{max=1000} | defaultLabelValue |
| 10 | default_sort_value | String |
Default sort order for search results |
@Size{max=1000} | defaultSortValue |
| 11 | virtual_host_value | String |
Virtual host configuration for multi-tenant setups |
@Size{max=10000} | virtualHostValue |
| 12 | append_query_parameter | String |
Enable or disable appending query parameters to search URLs |
@Size{max=10} | appendQueryParameter |
| 13 | login_required | String |
Enable or disable login requirement for search access |
@Size{max=10} | loginRequired |
| 14 | result_collapsed | String |
Enable or disable result collapsing for similar documents |
@Size{max=10} | resultCollapsed |
| 15 | login_link | String |
Enable or disable display of login link in the search interface |
@Size{max=10} | loginLink |
| 16 | thumbnail | String |
Enable or disable thumbnail generation for documents |
@Size{max=10} | thumbnail |
| 17 | ignore_failure_type | String |
Types of crawling failures to ignore during crawling operations |
@Size{max=1000} | ignoreFailureType |
| 18 | failure_count_threshold | Integer |
Threshold for failure count before stopping crawling of a URL |
@Required , @Min{value=-1} , @Max{value=10000} , @ValidateTypeFailure | failureCountThreshold |
| 19 | popular_word | String |
Enable or disable popular word tracking and display |
@Size{max=10} | popularWord |
| 20 | csv_file_encoding | String |
Character encoding to use for CSV file exports |
@Required , @Size{max=20} | csvFileEncoding |
| 21 | purge_search_log_day | Integer |
Number of days to keep search logs before purging |
@Min{value=-1} , @Max{value=100000} , @ValidateTypeFailure | purgeSearchLogDay |
| 22 | purge_job_log_day | Integer |
Number of days to keep job logs before purging |
@Min{value=-1} , @Max{value=100000} , @ValidateTypeFailure | purgeJobLogDay |
| 23 | purge_user_info_day | Integer |
Number of days to keep user information before purging |
@Min{value=-1} , @Max{value=100000} , @ValidateTypeFailure | purgeUserInfoDay |
| 24 | purge_by_bots | String |
Bot user agents whose search logs should be purged |
@Size{max=10000} | purgeByBots |
| 25 | notification_to | String |
Email addresses to receive system notifications |
@Size{max=1000} | notificationTo |
| 26 | suggest_search_log | String |
Enable or disable search suggestions based on search logs |
@Size{max=10} | suggestSearchLog |
| 27 | suggest_documents | String |
Enable or disable search suggestions based on document content |
@Size{max=10} | suggestDocuments |
| 28 | purge_suggest_search_log_day | Integer |
Number of days to keep suggestion search logs before purging |
@Min{value=0} , @Max{value=100000} , @ValidateTypeFailure | purgeSuggestSearchLogDay |
| 29 | ldap_provider_url | String |
LDAP server URL for authentication |
@Size{max=1000} | ldapProviderUrl |
| 30 | ldap_security_principal | String |
LDAP security principal for binding to the LDAP server |
@Size{max=1000} | ldapSecurityPrincipal |
| 31 | ldap_admin_security_principal | String |
LDAP admin security principal for administrative operations |
@Size{max=1000} | ldapAdminSecurityPrincipal |
| 32 | ldap_admin_security_credentials | String |
LDAP admin security credentials (password) for administrative operations |
@Size{max=1000} | ldapAdminSecurityCredentials |
| 33 | ldap_base_dn | String |
LDAP base DN (Distinguished Name) for user searches |
@Size{max=1000} | ldapBaseDn |
| 34 | ldap_account_filter | String |
LDAP filter for finding user accounts |
@Size{max=1000} | ldapAccountFilter |
| 35 | ldap_group_filter | String |
LDAP filter for finding groups |
@Size{max=1000} | ldapGroupFilter |
| 36 | ldap_memberof_attribute | String |
LDAP attribute name for group membership |
@Size{max=100} | ldapMemberofAttribute |
| 37 | notification_login | String |
Notification message displayed on the login page |
@Size{max=3000} | notificationLogin |
| 38 | notification_search_top | String |
Notification message displayed on the search top page |
@Size{max=3000} | notificationSearchTop |
| 39 | log_level | String |
System log level for controlling log verbosity |
@Size{max=10} | logLevel |
| 40 | storage_endpoint | String |
Storage service endpoint URL for cloud storage integration |
@Size{max=1000} | storageEndpoint |
| 41 | storage_access_key | String |
Access key for cloud storage authentication |
@Size{max=1000} | storageAccessKey |
| 42 | storage_secret_key | String |
Secret key for cloud storage authentication |
@Size{max=1000} | storageSecretKey |
| 43 | storage_bucket | String |
Storage bucket name for cloud storage operations |
@Size{max=1000} | storageBucket |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.group.ApiAdminGroupAction#settings()
annotations: @Execute
API action for admin group management.
Provides RESTful API endpoints for managing user group settings in the Fess search engine.
Groups define user permissions and access controls for search and administrative functions.
Returns list of group settings.
Supports both GET and PUT requests for retrieving paginated group configurations.
@param body search parameters for filtering and pagination
@return JSON response containing group settings list with pagination info
Search request body for group administration API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
Group ID |
|
| 2 | size | Integer |
The page size for search results |
|
| 3 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.group.ApiAdminGroupAction#get$setting()
annotations: @Execute
API action for admin group management.
Provides RESTful API endpoints for managing user group settings in the Fess search engine.
Groups define user permissions and access controls for search and administrative functions.
Returns specific group setting by ID.
@param id the group setting ID
@return JSON response containing the group setting details
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the group setting ID |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.group.ApiAdminGroupAction#post$setting()
annotations: @Execute
API action for admin group management.
Provides RESTful API endpoints for managing user group settings in the Fess search engine.
Groups define user permissions and access controls for search and administrative functions.
Creates a new group setting.
@param body group setting data to create
@return JSON response with created setting ID and status
Request body for creating group via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 2 | name | String |
The name of the group |
@Required , @Size{max=100} | name |
| 3 | attributes | Map<String, String> |
Additional attributes for the group |
attributes |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.group.ApiAdminGroupAction#put$setting()
annotations: @Execute
API action for admin group management.
Provides RESTful API endpoints for managing user group settings in the Fess search engine.
Groups define user permissions and access controls for search and administrative functions.
Updates an existing group setting.
@param body group setting data to update
@return JSON response with updated setting ID and status
Request body class for group edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the group being edited |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
The username of the user who last updated this group |
@Size{max=1000} | updatedBy |
| 3 | updated_time | Long |
The timestamp when this group was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Integer |
The version number of the group for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 6 | name | String |
The name of the group |
@Required , @Size{max=100} | name |
| 7 | attributes | Map<String, String> |
Additional attributes for the group |
attributes |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.group.ApiAdminGroupAction#delete$setting()
annotations: @Execute
API action for admin group management.
Provides RESTful API endpoints for managing user group settings in the Fess search engine.
Groups define user permissions and access controls for search and administrative functions.
Deletes a specific group setting.
Prevents deletion of the currently logged-in user's group for security.
@param id the group setting ID to delete
@return JSON response with deletion status
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the group setting ID to delete |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.joblog.ApiAdminJoblogAction#logs()
annotations: @Execute
API action for admin job log management.
Provides RESTful API endpoints for viewing and managing job execution logs in the Fess search engine.
Job logs contain information about crawling jobs, indexing tasks, and system maintenance operations.
Returns list of job logs.
Supports filtering and pagination for job execution history.
@param body search parameters for filtering and pagination
@return JSON response containing job logs list with pagination info
Search request body for job log administration API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
Job log ID |
|
| 2 | size | Integer |
The page size for search results |
|
| 3 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.joblog.ApiAdminJoblogAction#get$log()
annotations: @Execute
API action for admin job log management.
Provides RESTful API endpoints for viewing and managing job execution logs in the Fess search engine.
Job logs contain information about crawling jobs, indexing tasks, and system maintenance operations.
Returns specific job log by ID.
Provides detailed information about a particular job execution.
@param id the job log ID
@return JSON response containing the job log details
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the job log ID |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.joblog.ApiAdminJoblogAction#delete$log()
annotations: @Execute
API action for admin job log management.
Provides RESTful API endpoints for viewing and managing job execution logs in the Fess search engine.
Job logs contain information about crawling jobs, indexing tasks, and system maintenance operations.
Deletes a specific job log.
Useful for cleaning up old job execution records.
@param id the job log ID to delete
@return JSON response with deletion status
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the job log ID to delete |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.keymatch.ApiAdminKeymatchAction#settings()
annotations: @Execute
API action for admin key match management.
Form or Body: SearchBodySearch request body for key match administration API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | term | String |
Search term for key matching |
|
| 2 | query | String |
Query pattern for key matching |
|
| 3 | size | Integer |
The page size for search results |
|
| 4 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.keymatch.ApiAdminKeymatchAction#get$setting()
annotations: @Execute
API action for admin key match management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.keymatch.ApiAdminKeymatchAction#post$setting()
annotations: @Execute
API action for admin key match management.
Form or Body: CreateBodyRequest body for creating key match via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 2 | term | String |
The search term that triggers the key match |
@Required , @Size{max=100} | term |
| 3 | query | String |
The query to execute when the term matches |
@Required , @CustomSize{maxKey=form.admin.max.input.size} | query |
| 4 | max_size | Integer |
The maximum number of results to return |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | maxSize |
| 5 | boost | Float |
The boost score for matched results |
@Required , @ValidateTypeFailure | boost |
| 6 | virtual_host | String |
The virtual host for the key match |
@Size{max=1000} | virtualHost |
| 7 | created_by | String |
The user who created this key match |
@Size{max=255} | createdBy |
| 8 | created_time | Long |
The timestamp when this key match was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.keymatch.ApiAdminKeymatchAction#put$setting()
annotations: @Execute
API action for admin key match management.
Form or Body: EditBodyRequest body class for key match edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the key match configuration being edited |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
The username of the user who last updated this key match configuration |
@Size{max=255} | updatedBy |
| 3 | updated_time | Long |
The timestamp when this key match configuration was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Integer |
The version number of the key match configuration for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 6 | term | String |
The search term that triggers the key match |
@Required , @Size{max=100} | term |
| 7 | query | String |
The query to execute when the term matches |
@Required , @CustomSize{maxKey=form.admin.max.input.size} | query |
| 8 | max_size | Integer |
The maximum number of results to return |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | maxSize |
| 9 | boost | Float |
The boost score for matched results |
@Required , @ValidateTypeFailure | boost |
| 10 | virtual_host | String |
The virtual host for the key match |
@Size{max=1000} | virtualHost |
| 11 | created_by | String |
The user who created this key match |
@Size{max=255} | createdBy |
| 12 | created_time | Long |
The timestamp when this key match was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.keymatch.ApiAdminKeymatchAction#delete$setting()
annotations: @Execute
API action for admin key match management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.labeltype.ApiAdminLabeltypeAction#settings()
annotations: @Execute
API action for admin label type management.
Form or Body: SearchBodySearch request body for label type administration API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
Name of the label type |
|
| 2 | value | String |
Value of the label type |
|
| 3 | size | Integer |
The page size for search results |
|
| 4 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.labeltype.ApiAdminLabeltypeAction#get$setting()
annotations: @Execute
API action for admin label type management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.labeltype.ApiAdminLabeltypeAction#post$setting()
annotations: @Execute
API action for admin label type management.
Form or Body: CreateBodyRequest body for creating label type via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 2 | name | String |
The name of the label type |
@Required , @Size{max=100} | name |
| 3 | value | String |
The value of the label type (alphanumeric and underscore only) |
@Required , @Size{max=100} , @Pattern{regexp=^[a-zA-Z0-9_]+$} | value |
| 4 | included_paths | String |
The paths to include for this label type |
@CustomSize{maxKey=form.admin.max.input.size} | includedPaths |
| 5 | excluded_paths | String |
The paths to exclude for this label type |
@CustomSize{maxKey=form.admin.max.input.size} | excludedPaths |
| 6 | permissions | String |
The permissions required to view this label type |
@CustomSize{maxKey=form.admin.max.input.size} | permissions |
| 7 | virtual_host | String |
The virtual host for the label type |
@Size{max=1000} | virtualHost |
| 8 | sort_order | Integer |
The sort order for displaying this label type |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 9 | created_by | String |
The user who created this label type |
@Size{max=1000} | createdBy |
| 10 | created_time | Long |
The timestamp when this label type was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.labeltype.ApiAdminLabeltypeAction#put$setting()
annotations: @Execute
API action for admin label type management.
Form or Body: EditBodyRequest body class for label type edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the label type being edited |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
The username of the user who last updated this label type |
@Size{max=1000} | updatedBy |
| 3 | updated_time | Long |
The timestamp when this label type was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Integer |
The version number of the label type for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 6 | name | String |
The name of the label type |
@Required , @Size{max=100} | name |
| 7 | value | String |
The value of the label type (alphanumeric and underscore only) |
@Required , @Size{max=100} , @Pattern{regexp=^[a-zA-Z0-9_]+$} | value |
| 8 | included_paths | String |
The paths to include for this label type |
@CustomSize{maxKey=form.admin.max.input.size} | includedPaths |
| 9 | excluded_paths | String |
The paths to exclude for this label type |
@CustomSize{maxKey=form.admin.max.input.size} | excludedPaths |
| 10 | permissions | String |
The permissions required to view this label type |
@CustomSize{maxKey=form.admin.max.input.size} | permissions |
| 11 | virtual_host | String |
The virtual host for the label type |
@Size{max=1000} | virtualHost |
| 12 | sort_order | Integer |
The sort order for displaying this label type |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 13 | created_by | String |
The user who created this label type |
@Size{max=1000} | createdBy |
| 14 | created_time | Long |
The timestamp when this label type was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.labeltype.ApiAdminLabeltypeAction#delete$setting()
annotations: @Execute
API action for admin label type management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.log.ApiAdminLogAction#files()
annotations: @Execute
API action for admin log management.
Return as: JsonResponse<ApiResult>| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.log.ApiAdminLogAction#get$file()
annotations: @Execute
API action for admin log management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
Execute Method: org.codelibs.fess.app.web.api.admin.pathmap.ApiAdminPathmapAction#settings()
annotations: @Execute
API action for admin path mapping management.
Provides RESTful API endpoints for managing path mapping settings in the Fess search engine.
Path mappings define URL path transformations and redirections for crawling and indexing.
Returns list of path mapping settings.
Supports both GET and PUT requests for retrieving paginated path mapping configurations.
@param body search parameters for filtering and pagination
@return JSON response containing path mapping settings list with pagination info
Search request body for path mapping administration API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | regex | String |
Regular expression pattern for path mapping |
|
| 2 | replacement | String |
Replacement pattern for path mapping |
|
| 3 | size | Integer |
The page size for search results |
|
| 4 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.pathmap.ApiAdminPathmapAction#get$setting()
annotations: @Execute
API action for admin path mapping management.
Provides RESTful API endpoints for managing path mapping settings in the Fess search engine.
Path mappings define URL path transformations and redirections for crawling and indexing.
Returns specific path mapping setting by ID.
@param id the path mapping setting ID
@return JSON response containing the path mapping setting details
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the path mapping setting ID |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.pathmap.ApiAdminPathmapAction#post$setting()
annotations: @Execute
API action for admin path mapping management.
Provides RESTful API endpoints for managing path mapping settings in the Fess search engine.
Path mappings define URL path transformations and redirections for crawling and indexing.
Creates a new path mapping setting.
@param body path mapping setting data to create
@return JSON response with created setting ID and status
Request body for creating path mapping via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure | crudMode |
| 2 | regex | String |
The regular expression pattern to match request paths |
@Required , @Size{max=1000} | regex |
| 3 | replacement | String |
The replacement pattern for matched paths |
@Size{max=1000} | replacement |
| 4 | process_type | String |
The processing type for path mapping |
@Required | processType |
| 5 | sort_order | Integer |
The sort order for this path mapping (0-2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 6 | created_by | String |
The username who created this path mapping |
@Size{max=1000} | createdBy |
| 7 | created_time | Long |
The timestamp when this path mapping was created |
@ValidateTypeFailure | createdTime |
| 8 | user_agent | String |
The user agent string for this path mapping |
@Size{max=1000} | userAgent |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.pathmap.ApiAdminPathmapAction#put$setting()
annotations: @Execute
API action for admin path mapping management.
Provides RESTful API endpoints for managing path mapping settings in the Fess search engine.
Path mappings define URL path transformations and redirections for crawling and indexing.
Updates an existing path mapping setting.
@param body path mapping setting data to update
@return JSON response with updated setting ID and status
Request body class for path mapping edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the path mapping configuration being edited |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
The username of the user who last updated this path mapping configuration |
@Size{max=1000} | updatedBy |
| 3 | updated_time | Long |
The timestamp when this path mapping configuration was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Integer |
The version number of the path mapping configuration for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | crud_mode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure | crudMode |
| 6 | regex | String |
The regular expression pattern to match request paths |
@Required , @Size{max=1000} | regex |
| 7 | replacement | String |
The replacement pattern for matched paths |
@Size{max=1000} | replacement |
| 8 | process_type | String |
The processing type for path mapping |
@Required | processType |
| 9 | sort_order | Integer |
The sort order for this path mapping (0-2147483647) |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 10 | created_by | String |
The username who created this path mapping |
@Size{max=1000} | createdBy |
| 11 | created_time | Long |
The timestamp when this path mapping was created |
@ValidateTypeFailure | createdTime |
| 12 | user_agent | String |
The user agent string for this path mapping |
@Size{max=1000} | userAgent |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.pathmap.ApiAdminPathmapAction#delete$setting()
annotations: @Execute
API action for admin path mapping management.
Provides RESTful API endpoints for managing path mapping settings in the Fess search engine.
Path mappings define URL path transformations and redirections for crawling and indexing.
Deletes a specific path mapping setting.
@param id the path mapping setting ID to delete
@return JSON response with deletion status
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the path mapping setting ID to delete |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.plugin.ApiAdminPluginAction#get$installed()
annotations: @Execute
API action for admin plugin management.
Return as: JsonResponse<ApiResult>| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.plugin.ApiAdminPluginAction#get$available()
annotations: @Execute
API action for admin plugin management.
Return as: JsonResponse<ApiResult>| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.plugin.ApiAdminPluginAction#post$index()
annotations: @Execute
API action for admin plugin management.
Form or Body: InstallBodyRequest body for plugin installation API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
Name of the plugin to install (required, max 100 characters) |
@Required , @Size{max=100} |
| 2 | version | String |
Version of the plugin to install (required, max 100 characters) |
@Required , @Size{max=100} |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.plugin.ApiAdminPluginAction#delete$index()
annotations: @Execute
API action for admin plugin management.
Form or Body: DeleteBodyRequest body class for plugin deletion API endpoint.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
The name of the plugin to delete |
@Required , @Size{max=100} |
| 2 | version | String |
The version of the plugin to delete |
@Size{max=100} |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.relatedcontent.ApiAdminRelatedcontentAction#settings()
annotations: @Execute
API action for admin related content management.
Provides RESTful API endpoints for managing related content settings in the Fess search engine.
Related content settings define content relationships and associations for search results.
Returns list of related content settings.
Supports both GET and PUT requests for retrieving paginated related content configurations.
@param body search parameters for filtering and pagination
@return JSON response containing related content settings list with pagination info
Search request body for related content administration API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | term | String |
Search term for related content |
|
| 2 | content | String |
Content text for related content |
|
| 3 | size | Integer |
The page size for search results |
|
| 4 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.relatedcontent.ApiAdminRelatedcontentAction#get$setting()
annotations: @Execute
API action for admin related content management.
Provides RESTful API endpoints for managing related content settings in the Fess search engine.
Related content settings define content relationships and associations for search results.
Returns specific related content setting by ID.
@param id the related content setting ID
@return JSON response containing the related content setting details
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the related content setting ID |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.relatedcontent.ApiAdminRelatedcontentAction#post$setting()
annotations: @Execute
API action for admin related content management.
Provides RESTful API endpoints for managing related content settings in the Fess search engine.
Related content settings define content relationships and associations for search results.
Creates a new related content setting.
@param body related content setting data to create
@return JSON response with created setting ID and status
Request body for creating related content via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure | crudMode |
| 2 | term | String |
The search term for which related content is shown |
@Required , @Size{max=10000} | term |
| 3 | content | String |
The related content to be displayed |
@Required , @Size{max=10000} | content |
| 4 | virtual_host | String |
The virtual host for which this related content applies |
@Size{max=1000} | virtualHost |
| 5 | sort_order | Integer |
The sort order for this related content (0-2147483647) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 6 | created_by | String |
The username who created this related content |
@Size{max=1000} | createdBy |
| 7 | created_time | Long |
The timestamp when this related content was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.relatedcontent.ApiAdminRelatedcontentAction#put$setting()
annotations: @Execute
API action for admin related content management.
Provides RESTful API endpoints for managing related content settings in the Fess search engine.
Related content settings define content relationships and associations for search results.
Updates an existing related content setting.
@param body related content setting data to update
@return JSON response with updated setting ID and status
Request body class for related content edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the related content configuration being edited |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
The username of the user who last updated this related content configuration |
@Size{max=1000} | updatedBy |
| 3 | updated_time | Long |
The timestamp when this related content configuration was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Integer |
The version number of the related content configuration for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | crud_mode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure | crudMode |
| 6 | term | String |
The search term for which related content is shown |
@Required , @Size{max=10000} | term |
| 7 | content | String |
The related content to be displayed |
@Required , @Size{max=10000} | content |
| 8 | virtual_host | String |
The virtual host for which this related content applies |
@Size{max=1000} | virtualHost |
| 9 | sort_order | Integer |
The sort order for this related content (0-2147483647) |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 10 | created_by | String |
The username who created this related content |
@Size{max=1000} | createdBy |
| 11 | created_time | Long |
The timestamp when this related content was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.relatedcontent.ApiAdminRelatedcontentAction#delete$setting()
annotations: @Execute
API action for admin related content management.
Provides RESTful API endpoints for managing related content settings in the Fess search engine.
Related content settings define content relationships and associations for search results.
Deletes a specific related content setting.
@param id the related content setting ID to delete
@return JSON response with deletion status
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
the related content setting ID to delete |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.relatedquery.ApiAdminRelatedqueryAction#settings()
annotations: @Execute
API action for admin related query management.
Provides REST endpoints for managing related search queries.
Search request body for related query administration API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | term | String |
Search term for related queries |
|
| 2 | queries | String |
Related queries text |
|
| 3 | size | Integer |
The page size for search results |
|
| 4 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.relatedquery.ApiAdminRelatedqueryAction#get$setting()
annotations: @Execute
API action for admin related query management.
Provides REST endpoints for managing related search queries.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.relatedquery.ApiAdminRelatedqueryAction#post$setting()
annotations: @Execute
API action for admin related query management.
Provides REST endpoints for managing related search queries.
Request body for creating related query via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure | crudMode |
| 2 | term | String |
The search term for which related queries are shown |
@Required , @Size{max=10000} | term |
| 3 | queries | String |
The related queries to be suggested (one per line) |
@Required , @Size{max=10000} | queries |
| 4 | virtual_host | String |
The virtual host for which these related queries apply |
@Size{max=1000} | virtualHost |
| 5 | created_by | String |
The username who created these related queries |
@Size{max=1000} | createdBy |
| 6 | created_time | Long |
The timestamp when these related queries were created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.relatedquery.ApiAdminRelatedqueryAction#put$setting()
annotations: @Execute
API action for admin related query management.
Provides REST endpoints for managing related search queries.
Request body class for related query edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
Unique identifier for the related query entry |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
Username of the user who last updated this entry |
@Size{max=1000} | updatedBy |
| 3 | updated_time | Long |
Timestamp when this entry was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Integer |
Version number for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | crud_mode | Integer |
The CRUD operation mode (create, update, etc |
@ValidateTypeFailure | crudMode |
| 6 | term | String |
The search term for which related queries are shown |
@Required , @Size{max=10000} | term |
| 7 | queries | String |
The related queries to be suggested (one per line) |
@Required , @Size{max=10000} | queries |
| 8 | virtual_host | String |
The virtual host for which these related queries apply |
@Size{max=1000} | virtualHost |
| 9 | created_by | String |
The username who created these related queries |
@Size{max=1000} | createdBy |
| 10 | created_time | Long |
The timestamp when these related queries were created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.relatedquery.ApiAdminRelatedqueryAction#delete$setting()
annotations: @Execute
API action for admin related query management.
Provides REST endpoints for managing related search queries.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.reqheader.ApiAdminReqheaderAction#settings()
annotations: @Execute
API action for admin request header management.
Form or Body: SearchBodySearch request body for request header administration API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
Request header configuration ID |
|
| 2 | size | Integer |
The page size for search results |
|
| 3 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.reqheader.ApiAdminReqheaderAction#get$setting()
annotations: @Execute
API action for admin request header management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.reqheader.ApiAdminReqheaderAction#post$setting()
annotations: @Execute
API action for admin request header management.
Form or Body: CreateBodyRequest body for creating request header via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 2 | name | String |
The name of the request header |
@Required , @Size{max=100} | name |
| 3 | value | String |
The value of the request header |
@Required , @Size{max=1000} | value |
| 4 | web_config_id | String |
The web configuration ID associated with this request header |
@Required , @Size{max=1000} | webConfigId |
| 5 | created_by | String |
The username of who created this request header |
@Size{max=1000} | createdBy |
| 6 | created_time | Long |
The timestamp when this request header was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.reqheader.ApiAdminReqheaderAction#put$setting()
annotations: @Execute
API action for admin request header management.
Form or Body: EditBodyRequest body class for request header edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the request header configuration being edited |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
The username of the user who last updated this request header configuration |
@Size{max=1000} | updatedBy |
| 3 | updated_time | Long |
The timestamp when this request header configuration was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Integer |
The version number of the request header configuration for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 6 | name | String |
The name of the request header |
@Required , @Size{max=100} | name |
| 7 | value | String |
The value of the request header |
@Required , @Size{max=1000} | value |
| 8 | web_config_id | String |
The web configuration ID associated with this request header |
@Required , @Size{max=1000} | webConfigId |
| 9 | created_by | String |
The username of who created this request header |
@Size{max=1000} | createdBy |
| 10 | created_time | Long |
The timestamp when this request header was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.reqheader.ApiAdminReqheaderAction#delete$setting()
annotations: @Execute
API action for admin request header management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.role.ApiAdminRoleAction#settings()
annotations: @Execute
API action for admin role management.
Form or Body: SearchBodySearch request body for role administration API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
Role ID |
|
| 2 | size | Integer |
The page size for search results |
|
| 3 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.role.ApiAdminRoleAction#get$setting()
annotations: @Execute
API action for admin role management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.role.ApiAdminRoleAction#post$setting()
annotations: @Execute
API action for admin role management.
Form or Body: CreateBodyRequest body for creating role via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 2 | name | String |
The name of the role |
@Required , @Size{max=100} | name |
| 3 | attributes | Map<String, String> |
The attributes map for the role |
attributes |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.role.ApiAdminRoleAction#put$setting()
annotations: @Execute
API action for admin role management.
Form or Body: EditBodyRequest body class for role edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the role being edited |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
The username of the user who last updated this role |
@Size{max=1000} | updatedBy |
| 3 | updated_time | Long |
The timestamp when this role was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Integer |
The version number of the role for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 6 | name | String |
The name of the role |
@Required , @Size{max=100} | name |
| 7 | attributes | Map<String, String> |
The attributes map for the role |
attributes |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.role.ApiAdminRoleAction#delete$setting()
annotations: @Execute
API action for admin role management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.scheduler.ApiAdminSchedulerAction#index()
annotations: @Execute
API action for admin scheduler management.
Index page (not supported for API).
@return throws UnsupportedOperationException
Execute Method: org.codelibs.fess.app.web.api.admin.scheduler.ApiAdminSchedulerAction#put$start()
annotations: @Execute{urlPattern={}/@word}
API action for admin scheduler management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.scheduler.ApiAdminSchedulerAction#put$stop()
annotations: @Execute{urlPattern={}/@word}
API action for admin scheduler management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.scheduler.ApiAdminSchedulerAction#settings()
annotations: @Execute
API action for admin scheduler management.
Form or Body: SearchBodySearch request body for scheduler administration API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
Scheduler ID |
|
| 2 | size | Integer |
The page size for search results |
|
| 3 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.scheduler.ApiAdminSchedulerAction#get$setting()
annotations: @Execute
API action for admin scheduler management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.scheduler.ApiAdminSchedulerAction#post$setting()
annotations: @Execute
API action for admin scheduler management.
Form or Body: CreateBodyRequest body for creating scheduler via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 2 | name | String |
The name of the scheduled job |
@Required , @Size{max=100} | name |
| 3 | target | String |
The target class for the scheduled job |
@Required , @Size{max=100} | target |
| 4 | cron_expression | String |
The cron expression defining when the job should run |
@Size{max=100} , @CronExpression | cronExpression |
| 5 | script_type | String |
The type of script for the scheduled job |
@Required , @Size{max=100} | scriptType |
| 6 | script_data | String |
The script data or code for the scheduled job |
@CustomSize{maxKey=form.admin.max.input.size} | scriptData |
| 7 | crawler | String |
Whether this job is related to crawling |
crawler | |
| 8 | job_logging | String |
Whether job logging is enabled |
jobLogging | |
| 9 | available | String |
Whether the scheduled job is available/enabled |
available | |
| 10 | sort_order | Integer |
The sort order for displaying this scheduled job |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 11 | created_by | String |
The username of who created this scheduled job |
@Size{max=1000} | createdBy |
| 12 | created_time | Long |
The timestamp when this scheduled job was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.scheduler.ApiAdminSchedulerAction#put$setting()
annotations: @Execute
API action for admin scheduler management.
Form or Body: EditBodyRequest body class for scheduler edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | running | Boolean |
Flag indicating whether the scheduler job is currently running |
running | |
| 2 | id | String |
The unique identifier of the scheduler being edited |
@Required , @Size{max=1000} | id |
| 3 | version_no | Integer |
The version number of the scheduler for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 4 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 5 | name | String |
The name of the scheduled job |
@Required , @Size{max=100} | name |
| 6 | target | String |
The target class for the scheduled job |
@Required , @Size{max=100} | target |
| 7 | cron_expression | String |
The cron expression defining when the job should run |
@Size{max=100} , @CronExpression | cronExpression |
| 8 | script_type | String |
The type of script for the scheduled job |
@Required , @Size{max=100} | scriptType |
| 9 | script_data | String |
The script data or code for the scheduled job |
@CustomSize{maxKey=form.admin.max.input.size} | scriptData |
| 10 | crawler | String |
Whether this job is related to crawling |
crawler | |
| 11 | job_logging | String |
Whether job logging is enabled |
jobLogging | |
| 12 | available | String |
Whether the scheduled job is available/enabled |
available | |
| 13 | sort_order | Integer |
The sort order for displaying this scheduled job |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 14 | created_by | String |
The username of who created this scheduled job |
@Size{max=1000} | createdBy |
| 15 | created_time | Long |
The timestamp when this scheduled job was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.scheduler.ApiAdminSchedulerAction#delete$setting()
annotations: @Execute
API action for admin scheduler management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.searchlist.ApiAdminSearchlistAction#docs()
annotations: @Execute
API action for admin search list management.
Form or Body: SearchBodySearch request body for search list administration API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | size | Integer |
Number of search results to retrieve (alias for num) |
@ValidateTypeFailure |
| 2 | q | String |
The search query string |
@Size{max=1000} |
| 3 | sort | String |
The sort field and direction |
|
| 4 | start | Integer |
The start position for search results |
@ValidateTypeFailure |
| 5 | offset | Integer |
The offset for pagination |
@ValidateTypeFailure |
| 6 | pn | Integer |
The page number |
@ValidateTypeFailure |
| 7 | num | Integer |
The number of results to display |
@ValidateTypeFailure |
| 8 | lang | String[] |
The languages |
|
| 9 | fields | Map<String, String[]> |
The fields |
|
| 10 | as | Map<String, String[]> |
The conditions |
|
| 11 | ex_q | String[] |
The extra queries |
|
| 12 | sdh | String |
The similar document hash |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.searchlist.ApiAdminSearchlistAction#get$doc()
annotations: @Execute
API action for admin search list management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.searchlist.ApiAdminSearchlistAction#post$doc()
annotations: @Execute
API action for admin search list management.
Form or Body: CreateBodyRequest body for creating search list via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 2 | doc | Map<String, Object> |
The document data for search list operations |
doc | |
| 3 | q | String |
The search query string |
q |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.searchlist.ApiAdminSearchlistAction#put$doc()
annotations: @Execute
API action for admin search list management.
Form or Body: EditBodyRequest body class for search list edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
Unique identifier for the search list entry |
id | |
| 2 | seq_no | Long |
Sequence number for ordering search list entries |
@ValidateTypeFailure | seqNo |
| 3 | primary_term | Long |
Primary term value for search list configuration |
@ValidateTypeFailure | primaryTerm |
| 4 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 5 | doc | Map<String, Object> |
The document data for search list operations |
doc | |
| 6 | q | String |
The search query string |
q |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.searchlist.ApiAdminSearchlistAction#delete$doc()
annotations: @Execute
API action for admin search list management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.searchlist.ApiAdminSearchlistAction#delete$query()
annotations: @Execute
API action for admin search list management.
Form or Body: SearchBodySearch request body for search list administration API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | size | Integer |
Number of search results to retrieve (alias for num) |
@ValidateTypeFailure |
| 2 | q | String |
The search query string |
@Size{max=1000} |
| 3 | sort | String |
The sort field and direction |
|
| 4 | start | Integer |
The start position for search results |
@ValidateTypeFailure |
| 5 | offset | Integer |
The offset for pagination |
@ValidateTypeFailure |
| 6 | pn | Integer |
The page number |
@ValidateTypeFailure |
| 7 | num | Integer |
The number of results to display |
@ValidateTypeFailure |
| 8 | lang | String[] |
The languages |
|
| 9 | fields | Map<String, String[]> |
The fields |
|
| 10 | as | Map<String, String[]> |
The conditions |
|
| 11 | ex_q | String[] |
The extra queries |
|
| 12 | sdh | String |
The similar document hash |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.stats.ApiAdminStatsAction#index()
annotations: @Execute
Data transfer object representing OS CPU statistics.
Return as: JsonResponse<ApiResult>| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.storage.ApiAdminStorageAction#list()
annotations: @Execute
Handles API requests for storage management in the Fess application.
Provides endpoints for listing, downloading, deleting, and uploading files.
Lists files and directories in storage.
@param id The ID of the directory to list.
@return A JSON response containing the list of files and directories.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | OptionalThing<String> |
The ID of the directory to list. |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.storage.ApiAdminStorageAction#get$download()
annotations: @Execute
Handles API requests for storage management in the Fess application.
Provides endpoints for listing, downloading, deleting, and uploading files.
Downloads a file from storage.
@param id The ID of the file to download.
@return A StreamResponse containing the file content.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID of the file to download. |
Execute Method: org.codelibs.fess.app.web.api.admin.storage.ApiAdminStorageAction#delete$delete()
annotations: @Execute
Handles API requests for storage management in the Fess application.
Provides endpoints for listing, downloading, deleting, and uploading files.
Deletes a file from storage.
@param id The ID of the file to delete.
@return A JSON response indicating the success or failure of the operation.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
The ID of the file to delete. |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.storage.ApiAdminStorageAction#put$upload()
annotations: @Execute
Handles API requests for storage management in the Fess application.
Provides endpoints for listing, downloading, deleting, and uploading files.
Uploads a file to storage.
@param form The form containing the file to upload and the target path.
@return A JSON response indicating the success or failure of the operation.
Form for uploading files to the storage system via the admin API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | path | String |
The storage path where the file should be uploaded |
|
| 2 | file | MultipartFormFile |
The multipart file to be uploaded to the storage system |
@Required |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.suggest.ApiAdminSuggestAction#get$index()
annotations: @Execute
API action for admin suggest management.
Return as: JsonResponse<ApiResult>| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.suggest.ApiAdminSuggestAction#delete$all()
annotations: @Execute
API action for admin suggest management.
Return as: JsonResponse<ApiResult>| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.suggest.ApiAdminSuggestAction#delete$document()
annotations: @Execute
API action for admin suggest management.
Return as: JsonResponse<ApiResult>| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.suggest.ApiAdminSuggestAction#delete$query()
annotations: @Execute
API action for admin suggest management.
Return as: JsonResponse<ApiResult>| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.systeminfo.ApiAdminSysteminfoAction#get$index()
annotations: @Execute
API action for admin system information management.
Return as: JsonResponse<ApiResult>| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.user.ApiAdminUserAction#settings()
annotations: @Execute
API action for admin user management.
Form or Body: SearchBodySearch request body for user administration API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
User ID |
|
| 2 | size | Integer |
The page size for search results |
|
| 3 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.user.ApiAdminUserAction#get$setting()
annotations: @Execute
API action for admin user management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.user.ApiAdminUserAction#post$setting()
annotations: @Execute
API action for admin user management.
Form or Body: CreateBodyRequest body for creating user via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 2 | name | String |
The username of the user |
@Required , @Size{max=100} | name |
| 3 | password | String |
The password for the user |
@Size{max=100} | password |
| 4 | confirm_password | String |
The password confirmation field |
@Size{max=100} | confirmPassword |
| 5 | attributes | Map<String, String> |
The attributes map for the user |
attributes | |
| 6 | roles | String[] |
The roles assigned to the user |
roles | |
| 7 | groups | String[] |
The groups assigned to the user |
groups |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.user.ApiAdminUserAction#put$setting()
annotations: @Execute
API action for admin user management.
Form or Body: EditBodyRequest body class for user edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the user being edited |
@Required , @Size{max=1000} | id |
| 2 | version_no | Integer |
The version number of the user for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 3 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 4 | name | String |
The username of the user |
@Required , @Size{max=100} | name |
| 5 | password | String |
The password for the user |
@Size{max=100} | password |
| 6 | confirm_password | String |
The password confirmation field |
@Size{max=100} | confirmPassword |
| 7 | attributes | Map<String, String> |
The attributes map for the user |
attributes | |
| 8 | roles | String[] |
The roles assigned to the user |
roles | |
| 9 | groups | String[] |
The groups assigned to the user |
groups |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.user.ApiAdminUserAction#delete$setting()
annotations: @Execute
API action for admin user management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.webauth.ApiAdminWebauthAction#settings()
annotations: @Execute
API action for admin web authentication management.
Form or Body: SearchBodySearch request body for web authentication administration API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
Web authentication configuration ID |
|
| 2 | size | Integer |
The page size for search results |
|
| 3 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.webauth.ApiAdminWebauthAction#get$setting()
annotations: @Execute
API action for admin web authentication management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.webauth.ApiAdminWebauthAction#post$setting()
annotations: @Execute
API action for admin web authentication management.
Form or Body: CreateBodyRequest body for creating web authentication via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 2 | hostname | String |
The hostname for the web authentication |
@Size{max=100} | hostname |
| 3 | port | Integer |
The port number for the web authentication |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | port |
| 4 | auth_realm | String |
The authentication realm |
@Size{max=100} | authRealm |
| 5 | protocol_scheme | String |
The protocol scheme (http, https) |
@Size{max=10} | protocolScheme |
| 6 | username | String |
The username for authentication |
@Required , @Size{max=100} | username |
| 7 | password | String |
The password for authentication |
@Size{max=100} | password |
| 8 | parameters | String |
Additional parameters for the authentication |
@Size{max=1000} | parameters |
| 9 | web_config_id | String |
The web configuration ID this authentication is associated with |
@Required , @Size{max=1000} | webConfigId |
| 10 | created_by | String |
The user who created this authentication configuration |
@Size{max=1000} | createdBy |
| 11 | created_time | Long |
The timestamp when this authentication configuration was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.webauth.ApiAdminWebauthAction#put$setting()
annotations: @Execute
API action for admin web authentication management.
Form or Body: EditBodyRequest body class for web authentication edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the web authentication configuration being edited |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
The username of the user who last updated this web authentication configuration |
@Size{max=255} | updatedBy |
| 3 | updated_time | Long |
The timestamp when this web authentication configuration was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Integer |
The version number of the web authentication configuration for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 6 | hostname | String |
The hostname for the web authentication |
@Size{max=100} | hostname |
| 7 | port | Integer |
The port number for the web authentication |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | port |
| 8 | auth_realm | String |
The authentication realm |
@Size{max=100} | authRealm |
| 9 | protocol_scheme | String |
The protocol scheme (http, https) |
@Size{max=10} | protocolScheme |
| 10 | username | String |
The username for authentication |
@Required , @Size{max=100} | username |
| 11 | password | String |
The password for authentication |
@Size{max=100} | password |
| 12 | parameters | String |
Additional parameters for the authentication |
@Size{max=1000} | parameters |
| 13 | web_config_id | String |
The web configuration ID this authentication is associated with |
@Required , @Size{max=1000} | webConfigId |
| 14 | created_by | String |
The user who created this authentication configuration |
@Size{max=1000} | createdBy |
| 15 | created_time | Long |
The timestamp when this authentication configuration was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.webauth.ApiAdminWebauthAction#delete$setting()
annotations: @Execute
API action for admin web authentication management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.webconfig.ApiAdminWebconfigAction#settings()
annotations: @Execute
API action for admin web configuration management.
Form or Body: SearchBodySearch request body for web crawling configuration administration API.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | name | String |
Name of the web crawling configuration |
|
| 2 | urls | String |
URLs to crawl |
|
| 3 | description | String |
Description of the web crawling configuration |
|
| 4 | size | Integer |
The page size for search results |
|
| 5 | page | Integer |
The page number for search results |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.webconfig.ApiAdminWebconfigAction#get$setting()
annotations: @Execute
API action for admin web configuration management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.webconfig.ApiAdminWebconfigAction#post$setting()
annotations: @Execute
API action for admin web configuration management.
Form or Body: CreateBodyRequest body for creating web configuration via REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | label_type_ids | String[] |
The label type IDs associated with this web configuration |
labelTypeIds | |
| 2 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 3 | name | String |
The name of the web configuration |
@Required , @Size{max=200} | name |
| 4 | description | String |
The description of the web configuration |
@Size{max=1000} | description |
| 5 | urls | String |
The URLs to be crawled by this web configuration |
@Required , @UriType{protocolType=WEB} , @CustomSize{maxKey=form.admin.max.input.size} | urls |
| 6 | included_urls | String |
URL patterns to include during crawling |
@CustomSize{maxKey=form.admin.max.input.size} | includedUrls |
| 7 | excluded_urls | String |
URL patterns to exclude during crawling |
@CustomSize{maxKey=form.admin.max.input.size} | excludedUrls |
| 8 | included_doc_urls | String |
Document URL patterns to include in search index |
@CustomSize{maxKey=form.admin.max.input.size} | includedDocUrls |
| 9 | excluded_doc_urls | String |
Document URL patterns to exclude from search index |
@CustomSize{maxKey=form.admin.max.input.size} | excludedDocUrls |
| 10 | config_parameter | String |
Additional configuration parameters for the crawler |
@CustomSize{maxKey=form.admin.max.input.size} | configParameter |
| 11 | depth | Integer |
The maximum crawling depth from the starting URLs |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | depth |
| 12 | max_access_count | Long |
The maximum number of URLs to access during crawling |
@Min{value=0} , @Max{value=9223372036854775807} , @ValidateTypeFailure | maxAccessCount |
| 13 | user_agent | String |
The user agent string to use during crawling |
@Required , @Size{max=200} | userAgent |
| 14 | num_of_thread | Integer |
The number of crawler threads to use |
@Required , @Min{value=1} , @Max{value=2147483647} , @ValidateTypeFailure | numOfThread |
| 15 | interval_time | Integer |
The interval time between requests in milliseconds |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | intervalTime |
| 16 | boost | Float |
The boost value for documents from this web configuration |
@Required , @ValidateTypeFailure | boost |
| 17 | available | String |
Whether this web configuration is available for crawling |
@Required , @Size{max=5} | available |
| 18 | permissions | String |
Permissions required to access documents from this configuration |
@CustomSize{maxKey=form.admin.max.input.size} | permissions |
| 19 | virtual_hosts | String |
Virtual host names for this web configuration |
@CustomSize{maxKey=form.admin.max.input.size} | virtualHosts |
| 20 | sort_order | Integer |
The sort order for this web configuration |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 21 | created_by | String |
The user who created this web configuration |
@Size{max=1000} | createdBy |
| 22 | created_time | Long |
The timestamp when this web configuration was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.webconfig.ApiAdminWebconfigAction#put$setting()
annotations: @Execute
API action for admin web configuration management.
Form or Body: EditBodyRequest body class for web config edit operations in the admin REST API.
| No. | public name | type | comment | annotations | property name |
|---|---|---|---|---|---|
| 1 | id | String |
The unique identifier of the web configuration being edited |
@Required , @Size{max=1000} | id |
| 2 | updated_by | String |
The username of the user who last updated this web configuration |
@Size{max=1000} | updatedBy |
| 3 | updated_time | Long |
The timestamp when this web configuration was last updated |
@ValidateTypeFailure | updatedTime |
| 4 | version_no | Integer |
The version number of the web configuration for optimistic locking |
@Required , @ValidateTypeFailure | versionNo |
| 5 | label_type_ids | String[] |
The label type IDs associated with this web configuration |
labelTypeIds | |
| 6 | crud_mode | Integer |
The CRUD mode for the form |
@ValidateTypeFailure | crudMode |
| 7 | name | String |
The name of the web configuration |
@Required , @Size{max=200} | name |
| 8 | description | String |
The description of the web configuration |
@Size{max=1000} | description |
| 9 | urls | String |
The URLs to be crawled by this web configuration |
@Required , @UriType{protocolType=WEB} , @CustomSize{maxKey=form.admin.max.input.size} | urls |
| 10 | included_urls | String |
URL patterns to include during crawling |
@CustomSize{maxKey=form.admin.max.input.size} | includedUrls |
| 11 | excluded_urls | String |
URL patterns to exclude during crawling |
@CustomSize{maxKey=form.admin.max.input.size} | excludedUrls |
| 12 | included_doc_urls | String |
Document URL patterns to include in search index |
@CustomSize{maxKey=form.admin.max.input.size} | includedDocUrls |
| 13 | excluded_doc_urls | String |
Document URL patterns to exclude from search index |
@CustomSize{maxKey=form.admin.max.input.size} | excludedDocUrls |
| 14 | config_parameter | String |
Additional configuration parameters for the crawler |
@CustomSize{maxKey=form.admin.max.input.size} | configParameter |
| 15 | depth | Integer |
The maximum crawling depth from the starting URLs |
@Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | depth |
| 16 | max_access_count | Long |
The maximum number of URLs to access during crawling |
@Min{value=0} , @Max{value=9223372036854775807} , @ValidateTypeFailure | maxAccessCount |
| 17 | user_agent | String |
The user agent string to use during crawling |
@Required , @Size{max=200} | userAgent |
| 18 | num_of_thread | Integer |
The number of crawler threads to use |
@Required , @Min{value=1} , @Max{value=2147483647} , @ValidateTypeFailure | numOfThread |
| 19 | interval_time | Integer |
The interval time between requests in milliseconds |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | intervalTime |
| 20 | boost | Float |
The boost value for documents from this web configuration |
@Required , @ValidateTypeFailure | boost |
| 21 | available | String |
Whether this web configuration is available for crawling |
@Required , @Size{max=5} | available |
| 22 | permissions | String |
Permissions required to access documents from this configuration |
@CustomSize{maxKey=form.admin.max.input.size} | permissions |
| 23 | virtual_hosts | String |
Virtual host names for this web configuration |
@CustomSize{maxKey=form.admin.max.input.size} | virtualHosts |
| 24 | sort_order | Integer |
The sort order for this web configuration |
@Required , @Min{value=0} , @Max{value=2147483647} , @ValidateTypeFailure | sortOrder |
| 25 | created_by | String |
The user who created this web configuration |
@Size{max=1000} | createdBy |
| 26 | created_time | Long |
The timestamp when this web configuration was created |
@ValidateTypeFailure | createdTime |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.api.admin.webconfig.ApiAdminWebconfigAction#delete$setting()
annotations: @Execute
API action for admin web configuration management.
Path Variables:| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | id | String |
| No. | name | type | comment | annotations | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | response | ApiResponse |
The API response object |
|||||||||||||||
|
||||||||||||||||||
Execute Method: org.codelibs.fess.app.web.cache.CacheAction#index()
annotations: @Execute
Action class for handling cached document content requests.
Provides functionality to retrieve and display cached versions of crawled documents.
Retrieves and displays cached content for a specific document.
@param form the cache form containing document ID and highlight query
@return ActionResponse containing the cached document content or error redirect
Form class for cache-related operations.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | docId | String |
Document ID for cache operations |
@Required , @Size{max=100} |
| 2 | hq | String[] |
Highlight query parameters |
|
| 3 | q | String |
Search query parameter for error page |
|
| 4 | num | String |
Number of results parameter for error page |
|
| 5 | sort | String |
Sort parameter for error page |
|
| 6 | lang | String |
Language parameter for error page |
|
| 7 | fields | Map<String, String[]> |
Additional fields map for cache operations |
Execute Method: org.codelibs.fess.app.web.error.ErrorAction#index()
annotations: @Execute
Action class for handling general error pages.
This action displays error pages when unhandled exceptions occur
during search operations or page navigation.
Displays the general error page.
@param form the error form containing error information
@return HTML response for the error page
Form class for handling error page data and search parameters.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | fields | Map<String, String[]> |
Map of form fields and their validation error messages |
|
| 2 | q | String |
Search query parameter that caused the error |
|
| 3 | url | String |
URL parameter associated with the error |
|
| 4 | num | String |
Number of results parameter |
|
| 5 | sort | String |
Sort order parameter for search results |
|
| 6 | lang | String |
Language parameter for search interface |
implementations: asHtml(virtualHost(path_Error_ErrorJsp)
Execute Method: org.codelibs.fess.app.web.error.ErrorBadrequrestAction#index()
annotations: @Execute
Action class for handling HTTP 400 Bad Request error pages.
This action displays error pages when a client request contains
invalid syntax or cannot be fulfilled due to malformed request parameters.
Displays the bad request error page.
@param form the error form containing error information
@return HTML response for the bad request error page
Form class for handling error page data and search parameters.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | fields | Map<String, String[]> |
Map of form fields and their validation error messages |
|
| 2 | q | String |
Search query parameter that caused the error |
|
| 3 | url | String |
URL parameter associated with the error |
|
| 4 | num | String |
Number of results parameter |
|
| 5 | sort | String |
Sort order parameter for search results |
|
| 6 | lang | String |
Language parameter for search interface |
implementations: asHtml(virtualHost(path_Error_BadRequestJsp)
Execute Method: org.codelibs.fess.app.web.error.ErrorNotfoundAction#index()
annotations: @Execute
Action class for handling HTTP 404 Not Found error pages.
This action displays error pages when the requested resource
cannot be found on the server.
Displays the not found error page.
@param form the error form containing error information
@return HTML response for the not found error page
Form class for handling error page data and search parameters.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | fields | Map<String, String[]> |
Map of form fields and their validation error messages |
|
| 2 | q | String |
Search query parameter that caused the error |
|
| 3 | url | String |
URL parameter associated with the error |
|
| 4 | num | String |
Number of results parameter |
|
| 5 | sort | String |
Sort order parameter for search results |
|
| 6 | lang | String |
Language parameter for search interface |
implementations: asHtml(virtualHost(path_Error_NotFoundJsp)
Execute Method: org.codelibs.fess.app.web.error.ErrorSystemerrorAction#index()
annotations: @Execute
Action class for handling HTTP 500 Internal Server Error pages.
This action displays error pages when the server encounters
an unexpected condition that prevents it from fulfilling the request.
Displays the system error page.
@param form the error form containing error information
@return HTML response for the system error page
Form class for handling error page data and search parameters.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | fields | Map<String, String[]> |
Map of form fields and their validation error messages |
|
| 2 | q | String |
Search query parameter that caused the error |
|
| 3 | url | String |
URL parameter associated with the error |
|
| 4 | num | String |
Number of results parameter |
|
| 5 | sort | String |
Sort order parameter for search results |
|
| 6 | lang | String |
Language parameter for search interface |
implementations: asHtml(virtualHost(path_Error_SystemJsp)
Execute Method: org.codelibs.fess.app.web.go.GoAction#index()
annotations: @Execute
Action class for handling document redirection requests.
This action processes "go" requests that redirect users to specific documents
while tracking click events and handling various URL types including file system paths.
Handles document redirection requests.
Validates the document ID, logs click events if enabled, and redirects
to the target URL or serves file content directly if configured.
@param form the go form containing document ID and tracking parameters
@return action response for redirection or content streaming
@throws IOException if an I/O error occurs during content retrieval
or search results. This form captures the necessary parameters for document
access tracking and error page fallback information.">Form class for handling "go" requests that redirect users to specific documents
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | docId | String |
Document identifier for the target document to redirect to |
@Required , @Size{max=100} |
| 2 | rt | String |
Redirect target or return URL parameter |
@Size{max=10000} , @Required |
| 3 | hash | String |
Hash value for security or validation purposes |
|
| 4 | queryId | String |
Query identifier associated with the search that led to this document access |
@Required |
| 5 | order | Integer |
Order or ranking position of the document in search results |
|
| 6 | q | String |
Query string parameter for error page fallback |
|
| 7 | num | String |
Number of results parameter for error page fallback |
|
| 8 | sort | String |
Sort parameter for error page fallback |
|
| 9 | lang | String |
Language parameter for error page fallback |
|
| 10 | fields | Map<String, String[]> |
Additional fields map for error page fallback |
Execute Method: org.codelibs.fess.app.web.help.HelpAction#index()
annotations: @Execute
Action class for handling help page requests in the Fess search application.
This class extends FessSearchAction to provide help functionality including
authentication checks and form parameter setup for the help interface.
Handles the help page request and renders the help interface.
This method performs authentication checks and sets up the necessary
form parameters and rendering data for the help page display.
@return HtmlResponse containing the rendered help page or redirect to login if authentication is required
implementations: redirectToLogin(),asHtml(virtualHost(path_HelpJsp)
Execute Method: org.codelibs.fess.app.web.login.LoginAction#index()
annotations: @Execute
The login action.
Displays the login page.
@return the HTML response for the login page
implementations: asIndexPage(null)
Execute Method: org.codelibs.fess.app.web.login.LoginAction#login()
annotations: @Execute
The login action.
Handles user login with the provided credentials.
@param form the login form containing username and password
@return the HTML response after login attempt
The login form.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | username | String |
The username |
@NotBlank |
| 2 | password | String |
The password |
@NotBlank |
| 3 | confirmPassword | String |
The confirm password |
implementations: getHtmlResponse(),##unanalyzable##,asHtml(virtualHost(path_Login_NewpasswordJsp),redirect(getClass()
Execute Method: org.codelibs.fess.app.web.login.LoginAction#changePassword()
annotations: @Execute
The login action.
Handles password change for the current user.
@param form the password form containing new password and confirmation
@return the HTML response after password change attempt
Form for password change.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | username | String |
The username |
|
| 2 | password | String |
The password |
@NotBlank |
| 3 | confirmPassword | String |
The confirm password |
@NotBlank |
implementations: getUserBean(),redirect(ProfileAction.class)
Execute Method: org.codelibs.fess.app.web.logout.LogoutAction#index()
annotations: @Execute
The logout action.
Handles user logout and redirects to the login page.
@return the HTML response after logout
implementations: HtmlResponse.fromRedirectPathAsIs(redirectUrl),redirect(LoginAction.class)
Execute Method: org.codelibs.fess.app.web.osdd.OsddAction#index()
annotations: @Execute
OSDD (OpenSearch Description Document) action.
Returns the OSDD document.
@return the OSDD document as a stream response
Execute Method: org.codelibs.fess.app.web.profile.ProfileAction#index()
annotations: @Execute
Action for user profile operations.
Displays the profile index page.
@return the HTML response
implementations: asIndexHtml()
Execute Method: org.codelibs.fess.app.web.profile.ProfileAction#changePassword()
annotations: @Execute
Action for user profile operations.
Changes the user password.
@param form the profile form
@return the HTML response
Form for user profile operations.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | oldPassword | String |
The old password |
@NotBlank |
| 2 | newPassword | String |
The new password |
@NotBlank |
| 3 | confirmNewPassword | String |
The confirm new password |
@NotBlank |
implementations: asIndexHtml(),redirect(getClass()
Execute Method: org.codelibs.fess.app.web.search.SearchAction#index()
annotations: @Execute
The render data for the search page.
The index page.
@param form The search form.
@return The HTML response.
Base search form class that extends SearchRequestParams.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | fields | Map<String, String[]> |
Map of additional search fields with their values |
|
| 2 | as | Map<String, String[]> |
Map of advanced search conditions |
|
| 3 | q | String |
The main search query string |
@Size{max=1000} |
| 4 | sort | String |
The sort parameter for search results |
@Size{max=1000} |
| 5 | num | Integer |
The number of search results to return per page |
@ValidateTypeFailure |
| 6 | lang | String[] |
Array of language codes to filter search results |
|
| 7 | ex_q | String[] |
Array of additional query strings to exclude from search |
|
| 8 | start | Integer |
The starting position for search results pagination |
@ValidateTypeFailure |
| 9 | offset | Integer |
The offset for search results |
@ValidateTypeFailure |
| 10 | pn | Integer |
The page number for pagination |
@ValidateTypeFailure |
| 11 | sdh | String |
Similar document hash for finding related documents |
@Size{max=1000} |
| 12 | track_total_hits | String |
Parameter to control tracking of total hits in search results |
@Size{max=100} |
implementations: search(form)
Execute Method: org.codelibs.fess.app.web.search.SearchAction#advance()
annotations: @Execute
The render data for the search page.
The advance search page.
@param form The search form.
@return The HTML response.
Base search form class that extends SearchRequestParams.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | fields | Map<String, String[]> |
Map of additional search fields with their values |
|
| 2 | as | Map<String, String[]> |
Map of advanced search conditions |
|
| 3 | q | String |
The main search query string |
@Size{max=1000} |
| 4 | sort | String |
The sort parameter for search results |
@Size{max=1000} |
| 5 | num | Integer |
The number of search results to return per page |
@ValidateTypeFailure |
| 6 | lang | String[] |
Array of language codes to filter search results |
|
| 7 | ex_q | String[] |
Array of additional query strings to exclude from search |
|
| 8 | start | Integer |
The starting position for search results pagination |
@ValidateTypeFailure |
| 9 | offset | Integer |
The offset for search results |
@ValidateTypeFailure |
| 10 | pn | Integer |
The page number for pagination |
@ValidateTypeFailure |
| 11 | sdh | String |
Similar document hash for finding related documents |
@Size{max=1000} |
| 12 | track_total_hits | String |
Parameter to control tracking of total hits in search results |
@Size{max=100} |
implementations: redirectToLogin(),asHtml(virtualHost(path_AdvanceJsp)
Execute Method: org.codelibs.fess.app.web.search.SearchAction#search()
annotations: @Execute
The render data for the search page.
The search page.
@param form The search form.
@return The HTML response.
Base search form class that extends SearchRequestParams.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | fields | Map<String, String[]> |
Map of additional search fields with their values |
|
| 2 | as | Map<String, String[]> |
Map of advanced search conditions |
|
| 3 | q | String |
The main search query string |
@Size{max=1000} |
| 4 | sort | String |
The sort parameter for search results |
@Size{max=1000} |
| 5 | num | Integer |
The number of search results to return per page |
@ValidateTypeFailure |
| 6 | lang | String[] |
Array of language codes to filter search results |
|
| 7 | ex_q | String[] |
Array of additional query strings to exclude from search |
|
| 8 | start | Integer |
The starting position for search results pagination |
@ValidateTypeFailure |
| 9 | offset | Integer |
The offset for search results |
@ValidateTypeFailure |
| 10 | pn | Integer |
The page number for pagination |
@ValidateTypeFailure |
| 11 | sdh | String |
Similar document hash for finding related documents |
@Size{max=1000} |
| 12 | track_total_hits | String |
Parameter to control tracking of total hits in search results |
@Size{max=100} |
implementations: doSearch(form)
Execute Method: org.codelibs.fess.app.web.search.SearchAction#prev()
annotations: @Execute
The render data for the search page.
The previous page.
@param form The search form.
@return The HTML response.
Base search form class that extends SearchRequestParams.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | fields | Map<String, String[]> |
Map of additional search fields with their values |
|
| 2 | as | Map<String, String[]> |
Map of advanced search conditions |
|
| 3 | q | String |
The main search query string |
@Size{max=1000} |
| 4 | sort | String |
The sort parameter for search results |
@Size{max=1000} |
| 5 | num | Integer |
The number of search results to return per page |
@ValidateTypeFailure |
| 6 | lang | String[] |
Array of language codes to filter search results |
|
| 7 | ex_q | String[] |
Array of additional query strings to exclude from search |
|
| 8 | start | Integer |
The starting position for search results pagination |
@ValidateTypeFailure |
| 9 | offset | Integer |
The offset for search results |
@ValidateTypeFailure |
| 10 | pn | Integer |
The page number for pagination |
@ValidateTypeFailure |
| 11 | sdh | String |
Similar document hash for finding related documents |
@Size{max=1000} |
| 12 | track_total_hits | String |
Parameter to control tracking of total hits in search results |
@Size{max=100} |
implementations: doMove(form, -1)
Execute Method: org.codelibs.fess.app.web.search.SearchAction#next()
annotations: @Execute
The render data for the search page.
The next page.
@param form The search form.
@return The HTML response.
Base search form class that extends SearchRequestParams.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | fields | Map<String, String[]> |
Map of additional search fields with their values |
|
| 2 | as | Map<String, String[]> |
Map of advanced search conditions |
|
| 3 | q | String |
The main search query string |
@Size{max=1000} |
| 4 | sort | String |
The sort parameter for search results |
@Size{max=1000} |
| 5 | num | Integer |
The number of search results to return per page |
@ValidateTypeFailure |
| 6 | lang | String[] |
Array of language codes to filter search results |
|
| 7 | ex_q | String[] |
Array of additional query strings to exclude from search |
|
| 8 | start | Integer |
The starting position for search results pagination |
@ValidateTypeFailure |
| 9 | offset | Integer |
The offset for search results |
@ValidateTypeFailure |
| 10 | pn | Integer |
The page number for pagination |
@ValidateTypeFailure |
| 11 | sdh | String |
Similar document hash for finding related documents |
@Size{max=1000} |
| 12 | track_total_hits | String |
Parameter to control tracking of total hits in search results |
@Size{max=100} |
implementations: doMove(form, 1)
Execute Method: org.codelibs.fess.app.web.search.SearchAction#move()
annotations: @Execute
The render data for the search page.
The move page.
@param form The search form.
@return The HTML response.
Base search form class that extends SearchRequestParams.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | fields | Map<String, String[]> |
Map of additional search fields with their values |
|
| 2 | as | Map<String, String[]> |
Map of advanced search conditions |
|
| 3 | q | String |
The main search query string |
@Size{max=1000} |
| 4 | sort | String |
The sort parameter for search results |
@Size{max=1000} |
| 5 | num | Integer |
The number of search results to return per page |
@ValidateTypeFailure |
| 6 | lang | String[] |
Array of language codes to filter search results |
|
| 7 | ex_q | String[] |
Array of additional query strings to exclude from search |
|
| 8 | start | Integer |
The starting position for search results pagination |
@ValidateTypeFailure |
| 9 | offset | Integer |
The offset for search results |
@ValidateTypeFailure |
| 10 | pn | Integer |
The page number for pagination |
@ValidateTypeFailure |
| 11 | sdh | String |
Similar document hash for finding related documents |
@Size{max=1000} |
| 12 | track_total_hits | String |
Parameter to control tracking of total hits in search results |
@Size{max=100} |
implementations: doMove(form, 0)
Execute Method: org.codelibs.fess.app.web.sso.SsoAction#index()
annotations: @Execute
SSO (Single Sign-On) action controller.
This action handles SSO authentication flows including login, logout, and metadata
operations. It coordinates with the SsoManager to perform authentication using
configured SSO providers and handles various authentication scenarios including
successful login, authentication failures, and redirects.
Main SSO authentication endpoint.
This method handles the primary SSO authentication flow. It checks if a user
is already logged in, attempts SSO authentication, and handles various
authentication scenarios including success, failure, and challenge responses.
@return ActionResponse directing to the appropriate page based on authentication result
Execute Method: org.codelibs.fess.app.web.sso.SsoAction#metadata()
annotations: @Execute
SSO (Single Sign-On) action controller.
This action handles SSO authentication flows including login, logout, and metadata
operations. It coordinates with the SsoManager to perform authentication using
configured SSO providers and handles various authentication scenarios including
successful login, authentication failures, and redirects.
SSO metadata endpoint.
This method handles requests for SSO metadata, typically used by SAML or
other SSO protocols that require metadata exchange. The actual metadata
content is generated by the configured SSO authenticator.
@return ActionResponse containing the SSO metadata or error page
Execute Method: org.codelibs.fess.app.web.sso.SsoAction#logout()
annotations: @Execute
SSO (Single Sign-On) action controller.
This action handles SSO authentication flows including login, logout, and metadata
operations. It coordinates with the SsoManager to perform authentication using
configured SSO providers and handles various authentication scenarios including
successful login, authentication failures, and redirects.
SSO logout endpoint.
This method handles SSO logout requests, coordinating with the SSO provider
to properly terminate the user's SSO session. It may involve redirecting
to the SSO provider's logout endpoint or performing local logout operations.
@return ActionResponse directing to the logout page or SSO provider logout endpoint
Execute Method: org.codelibs.fess.app.web.thumbnail.ThumbnailAction#index()
annotations: @Execute
Action class for handling thumbnail image requests.
Serves thumbnail images for documents in the search results.
Serves a thumbnail image for the specified document.
@param form the thumbnail request form containing document ID and query parameters
@return ActionResponse containing the thumbnail image or 404 if not found
Form class for thumbnail request parameters.
| No. | name | type | comment | annotations |
|---|---|---|---|---|
| 1 | docId | String |
The document ID for which to retrieve the thumbnail |
@Required , @Size{max=100} |
| 2 | queryId | String |
The query ID associated with the search request |
@Required |
| 3 | q | String |
The search query string for error page display |
|
| 4 | num | String |
The number of search results per page for error page display |
|
| 5 | sort | String |
The sort criteria for search results for error page display |
|
| 6 | lang | String |
The language setting for error page display |
|
| 7 | fields | Map<String, String[]> |
Additional search fields for error page display |
| No. | file | title | class | parameter count |
|---|---|---|---|---|
| 1 | crawler.dfmail | Crawler Notification | CrawlerPostcard | 16 |
| 2 | es_status.dfmail | Crawler Notification | EsStatusPostcard | 3 |
| 3 | testmail.dfmail | Test Mail | TestmailPostcard | 1 |
Title: Crawler Notification
Class: org.codelibs.fess.mylasta.mail.CrawlerPostcard
hasOptionPlusHtml: false
[Crawler Notification]
Crawler notification mail.
| No. | name | type |
|---|---|---|
| 1 | hostname | String |
| 2 | jobname | String |
| 3 | webFsCrawlStartTime | String |
| 4 | webFsCrawlEndTime | String |
| 5 | webFsCrawlExecTime | String |
| 6 | webFsIndexExecTime | String |
| 7 | webFsIndexSize | String |
| 8 | dataCrawlStartTime | String |
| 9 | dataCrawlEndTime | String |
| 10 | dataCrawlExecTime | String |
| 11 | dataIndexExecTime | String |
| 12 | dataIndexSize | String |
| 13 | crawlerStartTime | String |
| 14 | crawlerEndTime | String |
| 15 | crawlerExecTime | String |
| 16 | status | String |
Title: Crawler Notification
Class: org.codelibs.fess.mylasta.mail.EsStatusPostcard
hasOptionPlusHtml: false
[Crawler Notification]
| No. | name | type |
|---|---|---|
| 1 | hostname | String |
| 2 | clustername | String |
| 3 | clusterstatus | String |
Title: Test Mail
Class: org.codelibs.fess.mylasta.mail.TestmailPostcard
hasOptionPlusHtml: false
[Test Mail]
| No. | name | type |
|---|---|---|
| 1 | hostname | String |