Skip to content

Commit 1e738fb

Browse files
committed
iplass-ee-aws モジュール削除 (ドキュメント)
- DEVELOPER GUIDE > データ管理 > 全文検索から非推奨のOpenSearch設定を削除 - DEVELOPER GUIDE > 開発・運用サポートから、Micrometer のメトリクスのうち aws2 利用時というコメントを削除 - ENVIRONMENT のLobStoreServiceの設定に記載したAWS SDK for Java 1.x のコメントを削除 - FulltextSearchService から非推奨の OpenSearchFulltextSearchService の記載を削除 - LobStoreService から非推奨の S3LobStore, MetricsS3LobStore の記載を削除 - MailService から非推奨のAWSMailServiceの記載を削除 - 非推奨のAWSSettingの記載を削除 - MicrometerService から非推奨のCloudWatchMeterRegistryFactory, AWSHttpSender の記載を削除 - WebFrontendService から非推奨のAmznTraceIdMdcValueResolver を削除 - aws-service-config.xml の説明を削除 - 非推奨のSecretsManagerPropertyValueCoder、SecretsManagerPassphraseSupplier の記載を削除
1 parent 08490f0 commit 1e738fb

22 files changed

Lines changed: 64 additions & 1419 deletions

developerguide/src/docs/asciidoc/datamanagement/entity_fulltextsearch.adoc

Lines changed: 12 additions & 127 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ iPLAssでは、Lucene、Elasticsearch(OpenSearch) という全文検索エンジ
2020
|概要
2121
|Javaベースのオープンソースの全文検索ライブラリ。 +
2222
iPLAssが稼働するAPサーバ内の同一VM上に組み込まれ動作。
23-
|Elasticsearch(OpenSearch)はLuceneをベースに開発されたオープンソースの全文検索エンジン。 +
23+
|Elasticsearch(OpenSearch)はLuceneをベースに開発されたオープンソースの全文検索エンジン。 +
2424
Elasticsearch(OpenSearch)単体でサーバとして稼働する。
2525

2626
|データ保存先
@@ -111,12 +111,12 @@ Indexファイルの保存場所、Analyzerなどに関する設定などを行
111111
112112
<property name="maxRows" value="1000" />
113113
<property name="throwExceptionWhenOverLimit" value="true"/>
114-
114+
115115
<property name="analyzerSetting" class="org.iplass.mtp.impl.fulltextsearch.lucene.JapaneseAnalyzerSetting">
116116
<property name="className" value="org.apache.lucene.analysis.ja.JapaneseAnalyzer" />
117117
<property name="mode" value="SEARCH" />
118-
</property>
119-
118+
</property>
119+
120120
</service>
121121
----
122122

@@ -146,7 +146,7 @@ true:maxRowsの設定値以上に検索結果件数が取得できた場合、
146146

147147
image::images/FulltextSearch_Lucene_SearchResult_True.png[]
148148

149-
|binaryParser|
149+
|binaryParser|
150150
BinaryReference解析用のParserを設定します。
151151
Apache Tikaを利用して、特定のバイナリ内もインデックスすることができます。
152152

@@ -229,7 +229,7 @@ Bi-gram分割(文章が分かち書きされない言語である中国語、
229229
230230
<property name="maxRows" value="1000" />
231231
<property name="throwExceptionWhenOverLimit" value="true"/>
232-
232+
233233
<property name="analysisFactory" class="org.iplass.mtp.impl.fulltextsearch.elasticsearch.analysis.DefaultAnalysisFactory">
234234
<property name="analyzer" >
235235
<property name="my_kuromoji" class="org.iplass.mtp.impl.fulltextsearch.elasticsearch.analysis.analyzer.KuromojiAnalyzerFactory">
@@ -246,7 +246,7 @@ Bi-gram分割(文章が分かち書きされない言語である中国語、
246246
<property name="analyzer" value="my_kuromoji"/>
247247
</property>
248248
</property>
249-
249+
250250
</service>
251251
----
252252

@@ -275,136 +275,21 @@ true:maxRowsの設定値以上に検索結果件数が取得できた場合、
275275

276276
image::images/FulltextSearch_Lucene_SearchResult_True.png[]
277277

278-
|binaryParser|
278+
|binaryParser|
279279
BinaryReference解析用のParserを設定します。
280280
Apache Tikaを利用して、特定のバイナリ内もインデックスすることができます。
281281

282282
|analysisFactory| カスタムでAnalyzer等を定義したい場合に利用します。
283283
classには `org.iplass.mtp.impl.fulltextsearch.elasticsearch.analysis.DefaultAnalysisFactory` を指定します。
284284

285-
|defaultAnalyzerProperty| デフォルトで利用するAnalyzer名を指定します。 classには `org.iplass.mtp.impl.fulltextsearch.elasticsearch.mapping.AnalyzerProperty` を指定します。Analyzer名にはデフォルトで提供されているAnalyzerやカスタムで定義したAnalyzerを指定することができます。 +
285+
|defaultAnalyzerProperty| デフォルトで利用するAnalyzer名を指定します。 classには `org.iplass.mtp.impl.fulltextsearch.elasticsearch.mapping.AnalyzerProperty` を指定します。Analyzer名にはデフォルトで提供されているAnalyzerやカスタムで定義したAnalyzerを指定することができます。 +
286286
デフォルトで提供されているAnalyzerについては、Elasticsearchのドキュメントを参照してください。
287287

288288
|analyzerPropertyPerEntity|
289289
Entity定義単位でAnalyzerを切り替えたい場合、Entity名とAnalyzerPropertyをMap形式で指定します。
290290

291291
|===
292292

293-
==== [.eeonly]#(非推奨)OpenSearch設定#
294-
295-
全文検索に関する設定をFulltextSearchServiceに設定します。
296-
サーバURL、Analyzerなどに関する設定などを行います。
297-
詳細は <<../../serviceconfig/index.adoc#FulltextSearchService, FulltextSearchService>> を参照してください。
298-
299-
[CAUTION]
300-
====
301-
AWS SDK for Java 1.x はメンテナンスモードになっており、2025年12月 にサポートを終了する予定です。 +
302-
iPLAss では AWS SDK for Java 1.x ベースのライブラリ iplass-ee-aws を非推奨とし、AWS SDK for Java 2.x ベースのライブラリ iplass-ee-aws2 への移行を推奨します。 +
303-
iplass-ee-aws2 の対応に伴い、opensearch の機能は iplass-ee-opensearch へ移管しました。 +
304-
本機能を利用している場合は、ライブラリ iplass-ee-opensearch の <<datamanagement_fulltextsearch_opensearch_opensearch>> へ設定を移行してください。 +
305-
ライブラリ iplass-ee-aws は将来削除される予定です。
306-
====
307-
308-
次に設定ファイルの設定例を示します。
309-
310-
.mtp-service-config.xmlの設定例(必要最低限の設定)
311-
デフォルト値を利用し、必要最低限の設定のみを行った設定例を以下に示します。
312-
313-
[source,xml]
314-
----
315-
<service>
316-
<interface>org.iplass.mtp.impl.fulltextsearch.FulltextSearchService</interface>
317-
318-
<class>org.iplass.mtp.impl.aws.fulltextsearch.opensearch.OpenSearchFulltextSearchService</class> <1>
319-
<property name="useFulltextSearch" value="true" /> <2>
320-
<property name="restClientFactory" class="org.iplass.mtp.impl.aws.fulltextsearch.opensearch.DefaultRestClientFactory">
321-
<property name="openSearchUrl" value="{SCHEME}://{ADDRESS}:{PORT}"/> <3>
322-
</property>
323-
</service>
324-
----
325-
<1> 実装クラスとしてOpenSearchFulltextSearchServiceを指定します
326-
<2> 全文検索機能を有効化する場合trueを指定します
327-
<3> OpenSearchのサーバURLを指定します
328-
329-
.mtp-service-config.xmlの設定例(主要な項目を設定)
330-
331-
主要な設定項目を設定した例を以下に示します。
332-
333-
[source,xml]
334-
----
335-
<service>
336-
<interface>org.iplass.mtp.impl.fulltextsearch.FulltextSearchService</interface>
337-
<class>org.iplass.mtp.impl.aws.fulltextsearch.opensearch.OpenSearchFulltextSearchService</class>
338-
<property name="useFulltextSearch" value="true" />
339-
<property name="restClientFactory" class="org.iplass.mtp.impl.aws.fulltextsearch.opensearch.DefaultRestClientFactory" >
340-
<property name="openSearchUrl" value="{SCHEME}://{ADDRESS}:{PORT}"/>
341-
<property name="httpRequestInterceptorFactory" class="org.iplass.mtp.impl.aws.AWSRequestSigningApacheInterceptorFactory" >
342-
<property name="serviceName" value="es"/>
343-
<property name="region" value="ap-northeast-1"/>
344-
</property>
345-
</property>
346-
347-
<property name="analysisFactory" class="org.iplass.mtp.impl.aws.fulltextsearch.opensearch.analysis.DefaultAnalysisFactory">
348-
<property name="analyzer" >
349-
<property name="my_kuromoji" class="org.iplass.mtp.impl.aws.fulltextsearch.opensearch.analysis.analyzer.KuromojiAnalyzerFactory">
350-
<property name="mode" value="Search"/>
351-
<property name="method" value="Nfc"/>
352-
</property>
353-
</property>
354-
</property>
355-
<property name="defaultAnalyzerProperty" >
356-
<property name="analyzer" value="kuromoji"/>
357-
</property>
358-
<property name="analyzerPropertyPerEntity" >
359-
<property name="testEntity" class="org.iplass.mtp.impl.aws.fulltextsearch.opensearch.mappings.AnalyzerProperty">
360-
<property name="analyzer" value="my_kuromoji"/>
361-
</property>
362-
</property>
363-
364-
</service>
365-
----
366-
367-
各設定項目の概要を以下に説明します。
368-
369-
[cols="1,3a",options="header"]
370-
|===
371-
|プロパティ名|内容説明
372-
|useFulltextSearch|全文検索機能を有効にする場合は `true` にします。
373-
|openSearchUrl|OpenSearchのサーバURLを指定します。
374-
|httpRequestInterceptorFactory| httpRequestInterceptorを生成するFactoryクラスを設定します。
375-
BASIC認証ではなく、IAM認証情報を使用してリクエストを署名したい場合、実装クラスである `org.iplass.mtp.impl.aws.AWSRequestSigningApacheInterceptorFactory` を指定します。
376-
|maxRows|
377-
全文検索サーバから取得する検索結果の最大件数を設定します。 +
378-
379-
NOTE: 件数が1000件以上で、かつ、Oracleを利用する場合は、
380-
Oracle設定の `enableInPartitioning` プロパティ値を `true` へ変更してください。
381-
382-
|throwExceptionWhenOverLimit|
383-
false:maxRowsの設定値以上に検索結果件数が取得できた場合でも、maxRowsの設定値分の件数は結果を表示します。
384-
385-
下記の画面は設定値以上に取得出来た場合となります。設定値未満の場合、メッセージ表示はありません。
386-
387-
image::images/FulltextSearch_Lucene_SearchResult_False.png[]
388-
389-
true:maxRowsの設定値以上に検索結果件数が取得できた場合、結果を表示せずに条件を絞り込むようメッセージで催促されます。
390-
391-
image::images/FulltextSearch_Lucene_SearchResult_True.png[]
392-
393-
|binaryParser|
394-
BinaryReference解析用のParserを設定します。
395-
Apache Tikaを利用して、特定のバイナリ内もインデックスすることができます。
396-
397-
|analysisFactory| カスタムでAnalyzer等を定義したい場合に利用します。
398-
classには `org.iplass.mtp.impl.aws.fulltextsearch.opensearch.analysis.DefaultAnalysisFactory` を指定します。
399-
400-
|defaultAnalyzerProperty| デフォルトで利用するAnalyzer名を指定します。 classには `org.iplass.mtp.impl.aws.fulltextsearch.opensearch.mappings.AnalyzerProperty` を指定します。Analyzer名にはデフォルトで提供されているAnalyzerやカスタムで定義したAnalyzerを指定することができます。 +
401-
デフォルトで提供されているAnalyzerについては、OpenSearchのドキュメントを参照してください。
402-
403-
|analyzerPropertyPerEntity|
404-
Entity定義単位でAnalyzerを切り替えたい場合、Entity名とAnalyzerPropertyをMap形式で指定します。
405-
406-
|===
407-
408293
[[datamanagement_fulltextsearch_opensearch_opensearch]]
409294
==== [.eeonly]#OpenSearch設定#
410295

@@ -503,14 +388,14 @@ true:maxRowsの設定値以上に検索結果件数が取得できた場合、
503388

504389
image::images/FulltextSearch_Lucene_SearchResult_True.png[]
505390

506-
|binaryParser|
391+
|binaryParser|
507392
BinaryReference解析用のParserを設定します。
508393
Apache Tikaを利用して、特定のバイナリ内もインデックスすることができます。
509394

510395
|analysisFactory| カスタムでAnalyzer等を定義したい場合に利用します。
511396
classには `org.iplass.mtp.impl.fulltextsearch.opensearch.analysis.DefaultAnalysisFactory` を指定します。
512397

513-
|defaultAnalyzerProperty| デフォルトで利用するAnalyzer名を指定します。 classには `org.iplass.mtp.impl.fulltextsearch.opensearch.mappings.AnalyzerProperty` を指定します。Analyzer名にはデフォルトで提供されているAnalyzerやカスタムで定義したAnalyzerを指定することができます。 +
398+
|defaultAnalyzerProperty| デフォルトで利用するAnalyzer名を指定します。 classには `org.iplass.mtp.impl.fulltextsearch.opensearch.mappings.AnalyzerProperty` を指定します。Analyzer名にはデフォルトで提供されているAnalyzerやカスタムで定義したAnalyzerを指定することができます。 +
514399
デフォルトで提供されているAnalyzerについては、OpenSearchのドキュメントを参照してください。
515400

516401
|analyzerPropertyPerEntity|
@@ -641,7 +526,7 @@ TopViewの機能概要、作成方法については<<../genericentitymanager/to
641526

642527
image::images/FulltextSearch_SetParts.png[]
643528

644-
ドラッグ&ドロップして出てきたFulltext Searchの設定ボタンをクリックすると、 `crawl for full text search`
529+
ドラッグ&ドロップして出てきたFulltext Searchの設定ボタンをクリックすると、 `crawl for full text search`
645530
にチェックをつけたEntityのみが表示されます。 +
646531
Entity View列に設定したSearchViewを使用して、全文検索結果となったEntityの情報を表示します。 +
647532

developerguide/src/docs/asciidoc/support/micrometer.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ NOTE: 標準メトリクスの収集には、Micrometerのcoreモジュールを
169169
**** `bucket_name`:S3のバケット名
170170
**** `method`:HTTPメソッド
171171
**** `status`:レスポンスのHTTPステータスコード
172-
**** `operation_name`:S3操作名(GetObject, PutObject, HeadObject, GetObjectTagging, DeleteObject)(iplass-ee-aws2 モジュール利用時)
172+
**** `operation_name`:S3操作名(GetObject, PutObject, HeadObject, GetObjectTagging, DeleteObject)
173173

174174
* メール系のログ
175175
** メール送信処理に対する成功回数/失敗回数

environment/src/docs/asciidoc/index_en.adoc

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -642,15 +642,6 @@ To store in AWS S3, specify org.iplass.mtp.impl.lob.lobstore.s3.awsv2.S3LobStore
642642
CAUTION: If the RDB in the context is MySQL or PostgreSQL, we recommend to use FileLobStore or S3LobStore for binaryStore.
643643
As when the DB was accessed via JDBC, the binary data will be processed as data stream, which may cause OutOfMemoryError.
644644
+
645-
[CAUTION]
646-
====
647-
The AWS SDK for Java 1.x is in maintenance mode and is scheduled to reach end of life in December 2025. +
648-
iPLAss is deprecating the iplass-ee-aws library based on AWS SDK for Java 1.x and recommends migrating to the iplass-ee-aws2 library based on AWS SDK for Java 2.x. +
649-
If you are using the `org.iplass.mtp.impl.aws.lobstore.s3.S3LobStore` class from the iplass-ee-aws library, +
650-
please migrate your configuration to the `org.iplass.mtp.impl.lob.lobstore.s3.awsv2.S3LobStore` class in the iplass-ee-aws2 library. +
651-
The iplass-ee-aws library is scheduled for future removal.
652-
====
653-
+
654645
[source,xml]
655646
.Example 1
656647
----

environment/src/docs/asciidoc/index_ja.adoc

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -653,15 +653,6 @@ AWS S3で保存の場合は、org.iplass.mtp.impl.lob.lobstore.s3.awsv2.S3LobSto
653653
CAUTION: RDBとしてMySQL、PostgreSQLを利用する場合、binaryStoreはFileLobStoreもしくはS3LobStoreの利用を推奨します。
654654
これらのDBへJDBC経由でアクセスした場合、バイナリデータはストリーム処理されないため、OutOfMemoryErrorの危険性が増します。
655655
+
656-
[CAUTION]
657-
====
658-
AWS SDK for Java 1.x はメンテナンスモードになっており、2025年12月 にサポートを終了する予定です。 +
659-
iPLAss では AWS SDK for Java 1.x ベースのライブラリ iplass-ee-aws を非推奨とし、AWS SDK for Java 2.x ベースのライブラリ iplass-ee-aws2 への移行を推奨します。 +
660-
ライブラリ iplass-ee-aws の `org.iplass.mtp.impl.aws.lobstore.s3.S3LobStore` を利用している場合は、 +
661-
ライブラリ iplass-ee-aws2 の `org.iplass.mtp.impl.lob.lobstore.s3.awsv2.S3LobStore` へ設定を移行してください。 +
662-
ライブラリ iplass-ee-aws は将来削除される予定です。
663-
====
664-
+
665656
[source,xml]
666657
.設定例1
667658
----

0 commit comments

Comments
 (0)