デザイン ビューを使用した Web サービスの作成

Web サービスのデザイン ビューは、Web サービスに対しグラフィカルな概要や編集環境を提供します。

デザイン ビューは、Web サービスのソース ビュー、プロパティ ビュー、および Web サービスの他のすべてのビューと同期しており、1 つのビューが変更されると、その変更内容が他のすべてのビューに反映されます。

このトピックでは、デザイン ビューのグラフィック要素を使用して Web サービスを作成する方法について説明します。

デザイン ビューの基本

デザイン ビューのメイン領域は、次のとおりです。

クライアント インタフェース

クライアント インタフェースには、インターネットを経由してパブリックにアクセスできるメソッドのみが表示されます。この中には、Web サービスの「Web メソッド」(@WebMethod アノテーションで修飾されたメソッド) が含まれます。その他のメソッドは、ソース ビューでのみ表示されます。ただし、@WebMethod アノテーションで修飾されたメソッドがない場合は、例外となります。その場合は、すべてのメソッドがデザイン ビューで表示されます。この場合、すべてのメソッドが Web メソッドとして想定されるためです。

メソッドとコールバック

各メソッドは、1 つまたは 2 つの矢印とラベルで表されます。

矢印またはラベルの上をポイントすると、メソッドの戻り値、パッケージ、およびクラスが表示されます。

〔Ctrl〕キーを押しながら要素をポイントすると、対応するソース コードが表示されます。

ラベルをクリックすると、メソッドのソース コードに移動します。

右クリックして [シグネチャの編集] を選択すると、メソッド シグネチャを編集できます。

メソッドとコールバックのアイコン

メソッドとコールバックのアイコンは、次のルールに従って作成されています。

以下の表に、クライアント インタフェースで表示されるメソッドとコールバックの一部を示します。

クライアント インタフェースのメソッドの表現
メソッドの型 パラメータの有無 戻り値の有無 表示 サンプル ソース コード
受信 (クライアントから呼び出し可能) なし なし 
@WebMethod
public void hello() {
}
受信 (クライアントから呼び出し可能) あり なし 
@WebMethod
public void hello(String str) {
}
 
受信 (クライアントから呼び出し可能) なし あり 
@WebMethod
public String hello() {
    return "Hello, World";
}
 
受信 (クライアントから呼び出し可能) あり あり 
@WebMethod
public String helloName(String str){
    return "Hello, " + str + "!";
}
 
受信 (一方向、クライアントは戻り値を想定しない) なし なし 
@Oneway()
@WebMethod
public void hello() {
}
 
受信 (一方向、クライアントは戻り値を想定しない) あり なし 
@Oneway()
@WebMethod
public void hello(String str) {
}
コールバック なし なし 
@CallbackService
public interface CallbackSvc extends CallbackInterface {
    @WebMethod
    public void callback();
}
コールバック あり なし 
@CallbackService
public interface CallbackSvc extends CallbackInterface {
    @WebMethod
    public void callback(String str);
}
 
コールバック なし あり 
@CallbackService
public interface CallbackSvc extends CallbackInterface {
    @WebMethod
    public String callback();
}
 
コールバック あり あり 
@CallbackService
public interface CallbackSvc extends CallbackInterface {
    @WebMethod
    public String callback(String str);
}

会話デコレータ

会話関連のアノテーションは、デコレータ アイコンによって表されます。

会話の開始、続行、および終了のメソッドは、それぞれ緑、黄色、赤で表されます。

以下の表に、会話関連のデコレータ アイコンをまとめます。

会話デコレータ アイコン
デコレータ 説明 ソース コード
メソッドによる会話の開始を示します。 @Conversation(Conversation.Phase.START)
メソッドによる会話の続行を示します。 @Conversation(Conversation.Phase.CONTINUE)
メソッドによる会話の終了を示します。 @Conversation(Conversation.Phase.FINISH)

メソッドの会話プロパティを設定するには、メソッドを右クリックして [会話の開始]、[会話の続行]、または [会話の終了] を選択します。

会話の詳細については、WebLogic Server ドキュメントの「会話形式の Web サービスの作成」を参照してください。

メソッド バッファ デコレータ

メソッド バッファは、次のアイコンによって表されます。

メソッドのメッセージ バッファを設定するには、メソッドを右クリックして [Message Buffer] または [メッセージ バッファと一方向] を選択します。

以下の表に、バッファ関連のデコレータ アイコンをまとめます。

バッファ デコレータ アイコン
デコレータ 説明 ソース コード
メソッドでバッファが可能なことを示します。 @MessageBuffer() (メソッド宣言で使用)
クラス レベルでバッファが可能なことを示します。 @MessageBuffer() (クラス宣言で使用)

メッセージ バッファの詳細については、WebLogic Server ドキュメントの「バッファ付き Web サービスの作成」を参照してください。

参照先のコントロール

Web サービスによって参照されるコントロールの領域は、デザイン ビューの右側に表示されます。

参照先のコントロールの領域にコントロールを追加するには、[プロジェクト・エクスプローラー] ビューからドラッグ アンド ドロップします。

以下にコントロール宣言の例を示します。

次のコントロール宣言は、

    @Control
    private HelloMessage helloMessage;

デザイン ビューに表示されます (下図を参照)。

変数名 helloMessage は、デザイン ビューに表示されます。コントロール クラスの名前ではありません。

コントロール インタフェースのすべてのメソッドは、デザイン ビューに表示されます。

クライアント インタフェースのメソッドを生成する

参照先のコントロールのメソッドを呼び出すクライアント インタフェースのメソッドを生成するには、コントロールのメソッドを右クリックして [代理メソッドの生成] を選択します。

対応するメソッドがクライアント インタフェースに作成されます。

イベント ハンドラ

Web サービスのイベント ハンドラ メソッドは、参照先のコントロールの領域に表示されます。イベント ハンドラは、クリッカブルなリンク テキストで表示されます。リンク テキストをクリックすると、Web サービスのイベント ハンドラのソース コードに移動します。

コントロールの未処理のイベントは、プレーン テキストで表示されます。

イベント ハンドラを Web サービスに追加するには、未処理のイベントを右クリックして [イベント ハンドラの作成] を選択します。

イベント ハンドラのシグネチャが、以下のように Web サービスに追加されます。

    @EventHandler(field = "helloMessage", eventSet = HelloMessage.NewEventSet.class, eventName = "onEvent")
    protected void helloMessage_NewEventSet_onEvent(String msg) {
        
    }

[デザイン パレット]

Web サービスのデザイン ビューは、[デザイン パレット] を伴います。

[デザイン パレット] から項目をドラッグ アンド ドロップする (または同じ項目をダブルクリックする) ことによって、デザイン ビューに項目を追加できます。

新しいコントロール参照、メソッド、およびコールバックを追加できます。

共通のタスク

キーボード ショートカット

キーボード ショートカット
キー ストローク イベント
〔Shift〕+〔F10〕 選択した項目のコンテキスト メニューを表示する。
〔Tab〕 / 〔Shift〕+〔Tab〕 前/後の参照先のコントロールおよび Web サービス クラスに移動する。〔Tab〕を押すと、フォーカスは Eclipse ツールバーに移動するが、〔Tab〕キーを十分な回数押せば、最終的にはデザイン ビューの要素に戻る。
上下の矢印キー 選択可能な要素 (個々のメソッド、コールバック、イベント ハンドラ、参照先のコントロール、およびデザイン ビューのキャンバス全体など) を移動する。
左右の矢印キー 参照先のコントロールが選択されている場合、左右の矢印は参照先のコントロールの展開と折りたたみを行う。

設定

[ウィンドウ｜設定｜Workshop｜サービス デザイン ビュー] で表示される [サービス デザイン ビュー] ダイアログを使用して、デザイン ビューを設定できます。

このダイアログの詳細については、「[設定]([サービス デザイン ビュー]) ダイアログ」を参照してください。

関連トピック

非同期インタフェースの設計

Beehive コントロールの操作

会話形式の Web サービスの作成

さらにヘルプが必要ですか。質問は Workshop ニュース グループまでお寄せください。