1. Homepage
  2. Connector DevKit (3.9)
  3. Anypoint Connector プロジェクトの作成

  4. Java SDK ベースのコネクタの作成

Java SDK ベースのコネクタの作成

DevKit は、Studio 6 および Mule 3 とのみ互換性があります。Mule 4 Connector を作成するには、 「Mule SDK」ドキュメント​を参照してください。

Studio 用の独自の Anypoint Connector をビルドするには、Anypoint Connector DevKit を使用します。Anypoint Studio で、​Anypoint Connector DevKit​ を使用できるようにする拡張モジュールを追加できます。

新しい Java SDK ベースのコネクタプロジェクトを作成する

注意​: 既存のコネクタプロジェクトをインポートするには、​「既存のコネクタプロジェクトのインポート」​を参照してください。

  1. [File (ファイル)] > [New (新規)]​ をクリックし、​[Anypoint Connector Project (Anypoint Connector プロジェクト)]​ を選択します。

    new+proj2

    Anypoint Connector プロジェクトを作成します。

    項目 エントリ

    Connector Name (コネクタ名)

    Anypoint Connector プロジェクトの一意の名前を定義します。

    Project Name (プロジェクト名)

    コネクタプロジェクト名。

    Namespace (名前空間)

    コネクタプロジェクトの名前空間。

    Location (場所)

    コネクタプロジェクトの場所。

    ​API:​

    型

    [Type (種別)]​ 項目を使用して、コネクタがリソースにアクセスできる方法を選択します。

    認証

    コネクタがそのリソースにアクセスする方法に関する認証の選択肢 (​[Connection Management (接続管理)]​、​[OAuth V1]​、​[OAuth V2]​) をクリックします。

    ​DataSense:​

    Add DataSense methods (DataSense メソッドを追加)

    リソースのエンティティのメタデータを表示するメソッドを提供します。詳細は、​「DataSense の追加」​を参照してください。

    Add DataSense Query Method (DataSense クエリメソッドを追加)​

    DataSense クエリ言語のメソッドを追加します。詳細は、​「DataSense クエリ言語の追加」​を参照してください。

  2. [Next (次へ)]​ をクリックし、以下の表に応じて、ウィザードの最後の画面の項目に値を入力します。変更することなくデフォルト値を適用できる場合もあります。

    項目 説明

    Maven Settings (Maven 設定)

    必要に応じて ​[Manually set values (手動で値を設定)]​ をクリックし、Maven グループ ID、アーティファクト ID、またはコネクタのバージョンを変更します。

    GitHub Settings (GitHub 設定)

    必要に応じて ​[Add GitHub information (GitHub 情報を追加)]​ をクリックし、プロジェクトを新規または既存の GitHub リポジトリにリンクします。

  3. [Next (次へ)]​ をクリックし、ユーザがコネクタを使用してプロジェクトをビルドするときに Anypoint Studio にコネクタのアイコンがどのように表示されるのかを選択します。

    アイコンセット

  4. [Finish (完了)]​ をクリックします。これにより、必要なすべての要素 (コネクタの画像、サンプルドキュメント、基本的なテストなど) が含まれる構造を備えたプロジェクトが生成されます。​「Studio でのコネクタのインストールとテスト」​のこの最初の基本構造に基づいてビルドするには、DevKit ドキュメントを参照してください。

    screen05

その他の DevKit アクション

プラグインでは、ツールバーのアクションも提供されます。

actions

Package Explorer でプロジェクトを右クリックして、同じアクションにアクセスすることもできます。

screen21

DevKit プロジェクトのルートを選択したときに有効になるアクション:

Generate Tests (テストを生成)

コネクタプロセッサの機能テストケースを生成します。

Install Or Update (インストールまたは更新)

Anypoint Studio やローカルリポジトリでコネクタをインストールまたは更新します。

Preview Documentation (ドキュメントをプレビュー)

サンプルドキュメントファイルに含まれているサンプルを利用して、コネクタの Javadoc を生成します。

Generate Sources (ソースを生成)

ソース、スキーマ、エディタ、および Mule や Anypoint Studio と統合するために必要なすべてを生成します。これは、Mule アプリケーションのコネクタの動作をデバッグする場合に役立ちます。

Enable Javadoc check (Javadoc チェックを有効化)​/​Disable Javadoc check (Javadoc チェックを無効化)

コネクタをリリースする前に、Javadoc に問題がないことを確認します。このフラグが有効になっていると、ビルドしようとしたときに、Javadoc コメントまたはサンプルが欠落しているすべてのプロセッサが表示されます。

コネクタの使用

プロジェクトを右クリックし、​[Anypoint Connector (Anypoint Connector)]​ > ​[Install or Update (インストールまたは更新)]​ を選択して、Anypoint Studio にコネクタをコピーできます。パレットで簡単に見つけるには、検索ボックスに名前を入力します。

screen18

ドキュメントのプレビュー

コネクタをビルドすると、コード内に追加した Javadoc アノテーションのわかりやすい参照として機能する HTML ファイルが DevKit によって自動的に作成されます。このファイルの内容は、プロジェクト全体をビルドしなくてもプレビューできます。これは、ターミナルのプロジェクトフォルダで次のコマンドを実行することに相当します。

mvn clean package -DskipTests javadoc:javadoc

ソースの生成

コネクタをビルドして、プロジェクトの ​/target​ フォルダに .zip ファイルと .jar ファイルの両方を生成するように DevKit に指示できます。これらのファイルを使用してテストします。つまり、Studio の自分のインスタンスや Studio の他の個別のインスタンスでコネクタを使用します。ソースを生成するには、Package Explorer でプロジェクトを右クリックし、[Anypoint Connector (Anypoint Connector)] > [Generate Sources (ソースを生成)] を選択します。 これは、コマンドコンソールのプロジェクトフォルダ内から次のコマンドを実行することに相当します。

mvn clean package -DskipTests -Ddevkit.studio.package.skip=true -Ddevkit.javadoc.check.skip=true -Dmaven.javadoc.skip=true

Javadoc チェックの無効化

DevKit では、コネクタのコール可能なすべてのメソッドの Javadoc ドキュメントを提供する必要があります。ただし、作業中のプロジェクトをテストするために、Javadoc チェックを無効にして、プロジェクトが完成してテストの準備が整うまでドキュメントを延期できます。

mvn clean package -Ddevkit.javadoc.check.skip=true

サンプルの追加

サンプルに移動するには、​command キー​を押したままサンプルリンクをクリックします。サンプルが存在する場合、サンプルエディタでプロセッサのサンプルが開きます。

Javadoc チェックを有効にしている場合、​control + space​ と入力してトリガできるクイックフィックスを使用すると、欠落しているサンプルを追加するのに役立ちます。

screen24

サンプル (XML ファイル) がどのように表示されるのかを次に示します。その中には、使用可能ないくつかの単純なテンプレートがあります。

screen25

生成されたコネクタの理解

基本的にコネクタは、コネクタの開発目的の API をコンシュームするためにユーザが入力する一連の操作と設定可能な要素で構成されています。

設定可能な項目

コネクタの設定可能な項目は、DevKit ビューでは次のように表示されます。

screen11 1

ユーザは、コネクタの設定グローバル要素を追加するときに Studio でその項目を設定できます。

コネクタを右クリックして ​[Anypoint Connector (Anypoint Connector)]​ > ​[Install or Update (インストールまたは更新)]​ をクリックし、指示に従って Studio を再起動することでコネクタをインストールしたら、ユーザは Mule プロジェクトを作成してコネクタを使用できます。後続のステップは、コネクタの [Configurable (設定可能)] セクションでユーザがどのようにコネクタを設定できるのかを示しています。

設定方法:

  1. コネクタのインスタンスをキャンバスにドラッグします。

  2. コネクタをダブルクリックして、そのプロパティエディタを開きます。

  3. [Connector Configuration (コネクタ設定)]​ 項目の横にある緑のプラス記号をクリックします。

    add+global+element

  4. 項目の値を設定します。コネクタで設定するデフォルト値は、コネクタの設定項目 ​[My Property (私のプロパティ)]​ に初期値として表示されます。

    DevKitProperty

プロセッサ

ユーザがコネクタから作成された Mule プロジェクトを設定する場合、[Operation (操作)] 項目のオプションは、コネクタの @Processor コードに対応します。図の上部のビューでは、Demo Connector の [Operation (操作)] として [My Processor (私のプロセッサ)] が設定されています。図の下部には、コネクタのプロセッサの値が表示されています。

MyProcessor

この例では、1 つの文字列がこのプロセッサのメソッドの入力として設定されています。操作が選択されると入力項目として「文字列」が表示されます。

Content (コンテンツ)

関連情報