このセクションの内容:
概要
DTP は、JMS イベント ブローカーを使って DTP で発生するイベントについてのリアルタイムな情報を提供します。サーバーはイベント メッセージをトピックにパブリッシュし、クライアントはトピックをサブスクライブしてイベント メッセージを受け取ることができます。
イベント ブローカーは、クライアントの接続性とメッセージの配布を NIO プロトコル (nio://) を使って管理します。デフォルト ポートは 61617 です (デフォルト ポートの変更方法については 「JMS イベント ブローカーのポート番号の変更」 を参照)。サンプル URI: nio://<HOSTNAME>:61617
イベント ブローカーにパブリッシュされるすべてのイベントは jms.log ファイルに記録されます。ログへのアクセス方法については 「ログ ファイルの参照」 を参照してください。
イベント ブローカー トピックへのアクセス
設定メニュー (歯車のアイコン) から [Report Center 設定] を選択し、サイドバー メニューの [イベント ブローカー] をクリックしてイベント ブローカーのインターフェイスにアクセスします。このインターフェースを使用すると、イベント ブローカーのトピックを確認できます。
MQTT のサポート
デフォルトでは、DTP は MQTT トランスポート コネクタを使用するように設定されています。トランスポート コネクタは、<DTP_DATA_DIR>/conf
ディレクトリにある EventsConfig.xml 構成ファイルで指定します。
<?xml version="1.0" encoding="UTF-8"?> <events-configuration> <transport-connector port="61617" /> <transport-connector port="1883" protocol="mqtt"/> </events-configuration>
イベント トピック
現在、以下のトピックはサブスクリプションに使用できます。
イベント トピック | 説明 |
---|---|
| このトピックは、違反エクスプローラーとテスト エクスプローラーでの解析メタデータの変更についてサブスクライバに通知します。 対応する
JSON メッセージのボディは以下のスキーマを使用します。 AnalysisMetadata イベント スキーマ { "fields": [{ "newValue": "Retest", "fieldName": "action" }], "type": "test", "date": "2015-06-08T17:12:39.323+0000", "user": "admin", "ids": ["8a981276-e694-337e-b543-2187ab610c95"], eventId": 18 } |
| このトピックは、変更エクスプローラー でのビルド レビューへの変更についてサブスクライバに通知します。対応する
各メッセージには、リクエスト アクションの種類を表す文字列プロパティ action も含まれます。
メッセージは、メッセージ ボディとして JSON を持つ BuildReview イベント スキーマ { "type": "Review", "action": "Create", "entity": { "id": "36", "baselineBuild": { "id": "BaselineBuild" }, "targetBuild": { "id": "TargetBuild" }, "name": "ReviewName", "author": "admin", "metadata": {} }, "activity": { "author": "admin", "date": "2016-12-09T18:50:11Z", "changes": { "name": "ReviewName" } } } メッセージ ボディの JSON は、対応する REST 認証の提供方法を含め、REST エンドポイントの詳細については 「DTP REST API の使用」 を参照してください。 |
DataCollector | Data Collector から作成したイベントについてサブスクライバに通知します。対応する
JSON メッセージのボディは以下のスキーマを使用します。 DataCollector イベント スキーマ { "reportFileName":"javaStaticAnalysisRun007.xml", "eventTime":"2014-07-10 16:31:04", "status":"ReceivedEvent" }
{ "reportFileName": "em.xml", "eventTime": "2014-09-30 15:20:06", "status": "ProcessedEvent", "fixedViolationsCount": 0, "newViolationsCount": 391, "suppressedViolationsCount": 48, "violationsCount": 439, "runConfigurationId": "33", "runId": "580", "testConfig": { "name": "Recommended Rules", "machine": "embuilder1.parasoft.com", "user": "jenkins", "pseudoUrl": "builtin://Recommended Rules" }, "resultsSession": { "id": "1412929102566", "project": "Environment Manager", "time": "2014-09-30T14:44:46-07:00", "hasVoils":"true", "tag": "Recommended Rules", "toolId": "jtest", "toolVer": "10.0.6.201406011700", "toolName": "Parasoft Jtest", "machine": "embuilder1.parasoft.com", "lang": "en_US", "climode": "true" } } |
Project | このトピックは、プロジェクトに対する変更についてサブスクライバに通知します。プロジェクトが作成、更新、削除されるたびに、DTP はイベントをパブリッシュします。メッセージは、メッセージ ボディとして JSON を持つ PrioritizationView イベント スキーマ { "eventType":"CREATED", "project": ["id":"27","name":"Parabank"] } JMSType の値は以下のとおりです:
各メッセージには文字列プロパティ
以下の例では、メッセージ セレクタは Parabank プロジェクトだけが更新されたことを検出します。
REST API を使った Project イベント トピックの拡張
たとえば、上記の例の更新された "Parabank" プロジェクトのプロジェクト ID が 27 だとします。この URL に
REST 認証の提供方法を含め、REST エンドポイントの詳細については 「DTP REST API の使用」 を参照してください。 |
トピックのパブリッシュの認証
認証は、トピックへのサブスクリプションには不要ですが、トピックへのパブリッシュには必要です。EventsConfig.xml または eventsbeans.xml 構成ファイルに変更を加えたら、変更を有効にするために、必ず DTP Server を再起動しなければなりません。
AuthenticationTopic の有効化
<DTP_DATA_DIR>/conf
ディレクトリにある EventsConfig.xml 構成ファイルを開きます。<topic-authentication>
要素を探し、enabled 属性を true に設定します (true
がデフォルトです) 。認証を無効にするには、enabled 属性をfalse
に設定します。ユーザー名とパスワードの変更は推奨しません。- DTP Server を再起動します (「DTP アプリケーションの開始」 を参照)。
認証の例外
認証を有効化した後に、特定のトピックについて認証を不要にすることができます。
<DTP_INSTALL>/tomcat/webapps/grs/WEB-INF/springs/
ディレクトリにある events-beans.xml を開きます。destinationAuthenticationManager
Bean のnonAuthenticatedTopics
プロパティの list にトピック名を追加します。<bean id="destinationAuthenticationManager"> <property name="nonAuthenticatedTopics"> <list> <value>MyTopicName</value> </list> </property> </bean>
DTP Server を再起動します (「DTP アプリケーションの開始」 を参照)。