WebLogic Web サービス プログラマーズ ガイド

JWS アノテーション リファレンス

以下の節では、標準 (JSR-181) JWS アノテーションおよび WebLogic 固有の JWS アノテーションに関するリファレンスを提供します。

JWS アノテーション タグの概要

WebLogic Web サービスのプログラミング モデルでは、新しい JDK 5.0 メタデータ アノテーション機能 (JSR-175 による仕様) を採用しています。このプログラミング モデルでは、アノテーション付きの Java ファイルを作成し、Ant タスクを使用してそのファイルを Java クラスにコンパイルし、関連するアーティファクトをすべて生成します。

アノテーション付きの Java Web サービス (JWS) ファイルは、Web サービスの中核部分です。このファイルには Web サービスの動作を決定する Java コードが含まれています。JWS ファイルは、アノテーションを使用して Web サービスの形式や特性を指定した、通常の Java クラス ファイルです。JWS ファイルで使用できる JWS アノテーションには、Web Services Metadata for the Java Platform 仕様 (JSR-181) で定義された標準のアノテーションと、WebLogic 固有のアノテーションがあります。この章では、この両方のアノテーションに関するリファレンス情報を提供します。

JWS アノテーションは、JWS ファイルのクラス、メソッド、またはパラメータのいずれかのレベルを対象にします。アノテーションの中には、複数のレベルを対象にできるものもあります。たとえば、@SecurityRoles は、クラスとメソッドの 2 つのレベルを対象にできます。この節では、各アノテーションの対象となるレベルを列挙して説明します。

次に、簡単な JWS ファイルの例を挙げます。このファイルでは、JSR-181 に準拠した標準 JWS アノテーションおよび WebLogic 固有の JWS アノテーションの両方が使われており、アノテーションはともに太字で示されています。

package examples.webservices.complex;

// 標準の JWS アノテーション インタフェースをインポートする

import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.jws.soap.SOAPBinding;

// WebLogic 固有の JWS アノテーション インタフェースをインポートする

import weblogic.jws.WLHttpTransport;

// BasicStruct JavaBean をインポートする

import examples.webservices.complex.BasicStruct;

// Web サービスの portType 名を「ComplexPortType」、パブリック サービス名を「ComplexService」、
// 生成される WSDL で使用される targetNamespace を「http://example.org」と指定する、
// 標準の JWS アノテーション

@WebService(serviceName="ComplexService", name="ComplexPortType",
            targetNamespace="http://example.org")

// document-literal-wrapped 型の Web サービスであることを指定する
// 標準の JWS アノテーション

@SOAPBinding(style=SOAPBinding.Style.DOCUMENT,
             use=SOAPBinding.Use.LITERAL,
             parameterStyle=SOAPBinding.ParameterStyle.WRAPPED)

// Web サービスの URI を構成するのに使用されるコンテキスト パスとサービス URI が
// 「complex/ComplexService」であることを指定する、WebLogic 固有の JWS アノテーション

@WLHttpTransport(contextPath="complex", serviceUri="ComplexService",
                 portName="ComplexServicePort")

/**
 * WebLogic Web サービスの基本となる JWS ファイル。この Web サービスには、
 * 以下の 2 つのパブリック オペレーションがある
 *
 *  - echoInt(int)
 *  - echoComplexType(BasicStruct)
 *
 * この Web サービスは「document-literal」サービスとして定義される。
 * つまり、SOAP メッセージには、本文全体を定義する XML スキーマ要素
 * を参照している 1 つの部分がある
 *
 * @author Copyright (c) 2005 by BEA Systems. All Rights Reserved.
 */

public class ComplexImpl {

  // メソッドがパブリック オペレーションとして公開されることを指定する、
  // 標準の JWS アノテーション。アノテーションにはメンバー値の
  // 「operationName」が含まれていないので、オペレーションの名前は
  // メソッド名 echoInt と同じになる
  //
  // WebResult アノテーションは、生成される WSDL 内のオペレーションの
  // 結果の名前が、デフォルト名の「return」ではなく「IntegerOutput」
  // であることを指定する。WebParam アノテーションは、WSDL ファイル内の
  // 入力パラメータ名が、パラメータの Java 名「input」ではなく、
  // 「IntegerInput」であることを指定する

  @WebMethod()
  @WebResult(name="IntegerOutput",
             targetNamespace="http://example.org/complex")
  public int echoInt(
      @WebParam(name="IntegerInput",
                targetNamespace="http://example.org/complex")
      int input)
  {
    System.out.println("echoInt '" + input + "' to you too!");
    return input;
  }

  // メソッド「echoStruct」を「echoComplexType」というパブリック オペレーション
  // として公開するための、標準の JWS アノテーション。
  // WebResult アノテーションは、生成される WSDL 内のオペレーションの結果の名前が、
  // デフォルト名の「return」ではなく、「EchoStructReturnMessage」であることを
  // 指定する

  @WebMethod(operationName="echoComplexType")
  @WebResult(name="EchoStructReturnMessage",
             targetNamespace="http://example.org/complex")
  public BasicStruct echoStruct(BasicStruct struct)
  {
    System.out.println("echoComplexType called");
    return struct;
  }
}

標準 JSR-181 の JWS アノテーション リファレンス

Web Services Metadata for the Java Platform (JSR-181) 仕様は、Web サービスの形態と動作を指定するために JWS ファイルで使用可能な標準アノテーションを定義しています。この節では、各アノテーションをその属性とともに簡単に説明します。例については、「JWS ファイルのプログラミング」を参照してください。Java アノテーションの型定義や追加の例など、各アノテーションの詳細については、仕様を参照してください。

この節では、以下の標準 JWS アノテーションについて説明します。

javax.jws.WebService

説明

対象 : クラス

JWS ファイルが Web サービスを実装するように指定します。

属性

例

@WebService(name="JMSTransportPortType",
            serviceName="JMSTransportService",
            targetNamespace="http://example.org")

javax.jws.WebMethod

説明

対象 : メソッド

Web サービスのパブリック オペレーションとしてメソッドが公開されるように指定します。メソッドを公開するには、このアノテーションを明示的に使用する必要があります。このアノテーションを指定しなかった場合、メソッドはデフォルトでは公開されません。

属性

例

 @WebMethod(operationName="echoComplexType")

 public BasicStruct echoStruct(BasicStruct struct)
 {
    ...
 }

javax.jws.Oneway

説明

対象 : メソッド

メソッドが入力パラメータのみを持っており、値を返さないように指定します。このアノテーションは、必ず @WebMethod アノテーションと一緒に使用する必要があります。

void 以外の値を返すメソッド、入力パラメータとして Holder クラスを取るメソッド、またはチェック例外を送出するメソッドに対してこのアノテーションを使用すると、エラーになります。

このアノテーションには、属性はありません。

例

  @WebMethod()
  @Oneway()
  public void helloWorld(String input) {
    ...

  }

javax.jws.WebParam

説明

対象 : パラメータ

Web サービスのオペレーションの入力パラメータと、生成された WSDL ファイルの要素との対応関係をカスタマイズします。このアノテーションは、パラメータの動作を指定する場合にも使われます。

属性

例

 @WebMethod()
 public int echoInt(
     @WebParam(name="IntegerInput",
               targetNamespace="http://example.org/complex")
     int input)
 {
   ...
 }

javax.jws.WebResult

説明

対象 : メソッド

Web サービスのオペレーションの戻り値と、生成された WSDL ファイルの対応する要素との対応関係をカスタマイズします。

属性

例

  @WebMethod(operationName="echoComplexType")
  @WebResult(name="EchoStructReturnMessage",
             targetNamespace="http://example.org/complex")
  public BasicStruct echoStruct(BasicStruct struct)
  {
   ...
  }

javax.jws.HandlerChain

説明

対象 : クラス

ハンドラ チェーンのコンフィグレーションを格納している外部ファイルに Web サービスを関連付けます。コンフィグレーションには、チェーン内のハンドラのリスト、ハンドラが実行される順序、初期化パラメータなどが含まれます。

以下の場合は、@SOAPMessageHandlers アノテーションではなく @HandlerChain アノテーションを JWS ファイルで使用します。

このアノテーションを @SOAPMessageHandlers アノテーションと一緒に使用すると、エラーになります。

外部コンフィグレーション ファイルの XML スキーマ、その作成に関する詳細、およびさらなるサンプルについては、 Web Services Metadata for the Java Platform 仕様を参照してください。

属性

例

package examples.webservices.handler;

...

@WebService (...)

@HandlerChain(file="HandlerConfig.xml", name="SimpleChain")

public class HandlerChainImpl {

...

}

javax.jws.soap.SOAPBinding

説明

対象 : クラス

SOAP メッセージ プロトコルに対する Web サービスのマッピングを指定します。

属性

例

package examples.webservices.bindings;

...

@WebService (...)

@SOAPBinding(style=SOAPBinding.Style.DOCUMENT,
             use=SOAPBinding.Use.LITERAL,
             parameterStyle=SOAPBinding.ParameterStyle.WRAPPED)

public class BindingsImpl {

...

}

javax.jws.soap.SOAPMessageHandler

説明

対象 : なし。このアノテーションは、@SOAPMessageHandler 配列の内部でのみ使用可能です。

特定の SOAP メッセージ ハンドラを @SOAPMessageHandler 配列で指定します。このアノテーションには、ハンドラのクラス名、初期化パラメータ、ハンドラで処理される SOAP ヘッダのリストなどを指定する属性が含まれます。

属性

例

package examples.webservices.handlers;

...

@WebService (...)

@SOAPMessageHandlers ( {
  @SOAPMessageHandler (
   className="examples.webservices.soap_handlers.simple.ServerHandler1"),
  @SOAPMessageHandler (
   className="examples.webservices.soap_handlers.simple.ServerHandler2")
} )

public class HandlersImpl {

...

}

javax.jws.soap.InitParam

説明

対象 : なし。このアノテーションは、@SOAPMessageHandler アノテーションの initParams 属性に対する値としてのみ使用可能です。

このアノテーションは、初期化の際にハンドラ クラスに渡されるパラメータ (名前/値のペア) の配列を指定するために、@SOAPMessageHandler アノテーションの initParams 属性で使用します。

属性

javax.jws.soap.SOAPMessageHandlers

説明

対象 : クラス

Web サービスのオペレーションの前後に実行される SOAP メッセージ ハンドラの配列を指定します。@SOAPMessageHandler アノテーションは、特定のハンドラを指定するために使用します。JWS ファイル自体の内部でハンドラのリストを指定するので、ハンドラ チェーンのコンフィグレーションは、Web サービス内に埋め込まれます。

以下の場合は、@HandlerChain アノテーションではなく @SOAPMessageHandlers アノテーションを使用します。

@SOAPMessageHandlers アノテーションは @SOAPMessageHandler 型の配列です。各ハンドラは、配列内の最初のハンドラからアノテーションに表示される順序で実行されます。

このアノテーションには、属性はありません。

例

package examples.webservices.handlers;

...

@WebService (...)

@SOAPMessageHandlers ( {
  @SOAPMessageHandler (
   className="examples.webservices.soap_handlers.simple.ServerHandler1"),
  @SOAPMessageHandler (
   className="examples.webservices.soap_handlers.simple.ServerHandler2")
} )

public class HandlersImpl {

...

}

WebLogic 固有の JWS アノテーション リファレンス

WebLogic Web サービスでは、JSR-181 の標準 JWS アノテーションに加え、さらに動作と機能を指定するのに使用できる JWS アノテーションのセットが定義されます。具体的には、WebLogic 固有のアノテーションは次のとおりです。

weblogic.jws.AsyncFailure

説明

対象 : メソッド

メイン JWS ファイルが別の Web サービスのオペレーションを非同期的に呼び出したときに発生する可能性のある障害を処理するメソッドを指定します。

JWS ファイルの内部から Web サービスのオペレーションを非同期的に呼び出すと、応答 (または障害の場合は例外) は、オペレーション呼び出しの直後ではなく、多少遅れて返されます。オペレーション呼び出しは応答を待たないので、JWS ファイル内の別のメソッドは、応答が返された時点でその応答を処理する必要があります。同様に、さらに別のメソッドは障害を処理する必要があります。@AsyncFailure アノテーションは、非同期オペレーション呼び出しによって発生する可能性がある障害を処理する、JWS ファイル内のメソッドを指定するために使用します。

@AsyncFailure アノテーションは、呼び出し対象となる Web サービスの JAX-RPC スタブの名前と、非同期的に呼び出すオペレーションの名前の 2 つのパラメータを取ります。JAX-RPC スタブは、@ServiceClient アノテーションが付けられているスタブです。

非同期障害を処理するメソッドは、以下のガイドラインに従う必要があります。

メソッド自体の内部では、コンテキストからメソッド障害に関する詳細を入手し、特定の型の障害を問い合わせ、それに従って処理を実行できます。

通常、非同期オペレーション障害を処理するメソッドを明示的に指定する場合は、必ず @AsyncFailure アノテーションを使用します。このアノテーションを使用しない唯一のケースは、単一のメソッドで、別の Web サービスを呼び出す複数のスタブの障害を処理する場合です。この場合、スタブは別の Web サービスに接続しますが、Web サービス ランタイムは、アノテーションではなくメソッドの名前を基に (onMethodNameAsyncFailure) 非同期障害の処理方法を判別するので、各 Web サービスは、名前が似ているメソッドを持っている必要があります。ただし、オペレーションのいずれか 1 つから非同期障害を処理するメソッドとスタブとの間に必ず 1 対 1 の対応が必要な場合は、@AsyncFailure を明示的に使用することをお勧めします。

このアノテーションの詳細および使用例については、「非同期の要求と応答を使用した Web サービスの呼び出し」を参照してください。

属性

 port.getQuoteAsync (apc, symbol);

例

以下のサンプル スニペットでは、別の Web サービスのオペレーションを非同期的に呼び出す、JWS ファイル内の @AsyncFailure アノテーションの使い方を示します。ここでは、関連する Java コードのみを示します。

package examples.webservices.async_req_res;

...

public class StockQuoteClientImpl {

  @ServiceClient(wsdlLocation="http://localhost:7001/async/StockQuote?WSDL",
                 serviceName="StockQuoteService", portName="StockQuote")
  private StockQuotePortType port;

  @WebMethodpublic void getQuote (String symbol) {

    AsyncPreCallContext apc = AsyncCallContextFactory.getAsyncPreCallContext();
    apc.setProperty("symbol", symbol);

    try {
      port.getQuoteAsync(apc, symbol );
      System.out.println("in getQuote method of StockQuoteClient WS");
    }
    catch (RemoteException e) {
      e.printStackTrace();
    }

  }

...

  @AsyncFailure(target="port", operation="getQuote")
  public void onGetQuoteAsyncFailure(AsyncPostCallContext apc, Throwable e) {
    System.out.println("-------------------");
    e.printStackTrace();
    System.out.println("-------------------");
  }

}

この例では、port という JAX-RPC スタブが、http://localhost:7001/async/StockQuote にある Web サービスを呼び出すために使用されています。getQuote オペレーションが非同期的に呼び出され、この呼び出しで例外が発生すると、@AsyncFailure アノテーションで指定されている onGetQuoteAsyncFailure メソッドによって処理されます。

weblogic.jws.AsyncResponse

説明

対象 : メソッド

メイン JWS ファイルが別の Web サービスのオペレーションを非同期的に呼び出したときの応答を処理するメソッドを指定します。

JWS ファイルの内部から Web サービスのオペレーションを非同期的に呼び出すと、応答は、オペレーション呼び出しの直後ではなく、多少遅れて返されます。オペレーション呼び出しは応答を待たないので、JWS ファイル内の別のメソッドは、応答が最終的に返された時点でその応答を処理する必要があります。@AsyncResponse アノテーションは、非同期オペレーション呼び出しの応答を処理する、JWS ファイル内のメソッドを指定するために使用します。

@AsyncResponse アノテーションは、呼び出し対象となる Web サービスの JAX-RPC スタブの名前と、非同期的に呼び出すオペレーションの名前の 2 つのパラメータを取ります。JAX-RPC スタブは、@ServiceClient アノテーションが付けられているスタブです。

非同期応答を処理するメソッドは、以下のガイドラインに従う必要があります。

非同期応答メソッド自体の内部では、応答を処理するコードを追加します。また、コンテキストからメソッド呼び出しに関する詳細を入手できます。

通常、非同期オペレーション応答を処理するメソッドを明示的に指定する場合は、必ず @AsyncResponse アノテーションを使用します。このアノテーションを使用しない唯一のケースは、単一のメソッドで、別の Web サービスを呼び出す複数のスタブの応答を処理する場合です。この場合、スタブは別の Web サービスに接続しますが、Web サービス ランタイムは、アノテーションではなくメソッドの名前を基に (onMethodNameAsyncResponse) 非同期応答の処理方法を判別するので、各 Web サービスは、名前が似ているメソッドを持っている必要があります。ただし、オペレーションのいずれか 1 つから非同期応答を処理するメソッドとスタブとの間に必ず 1 対 1 の対応が必要な場合は、@AsyncResponse を明示的に使用することをお勧めします。

このアノテーションの詳細および使用例については、「非同期の要求と応答を使用した Web サービスの呼び出し」を参照してください。

属性

 port.getQuoteAsync (apc, symbol);

例

以下のサンプル スニペットでは、別の Web サービスのオペレーションを非同期的に呼び出す、JWS ファイル内の @AsyncResponse アノテーションの使い方を示します。ここでは、関連する Java コードのみを示します。

package examples.webservices.async_req_res;

...

public class StockQuoteClientImpl {

  @ServiceClient(wsdlLocation="http://localhost:7001/async/StockQuote?WSDL",
                 serviceName="StockQuoteService", portName="StockQuote")
  private StockQuotePortType port;

  @WebMethodpublic void getQuote (String symbol) {

    AsyncPreCallContext apc = AsyncCallContextFactory.getAsyncPreCallContext();
    apc.setProperty("symbol", symbol);

    try {
      port.getQuoteAsync(apc, symbol );
      System.out.println("in getQuote method of StockQuoteClient WS");
    }
    catch (RemoteException e) {
      e.printStackTrace();
    }

  }

...

  @AsyncResponse(target="port", operation="getQuote")
  public void onGetQuoteAsyncResponse(AsyncPostCallContext apc, int quote) {
    System.out.println("-------------------");
    System.out.println("Got quote " + quote );
    System.out.println("-------------------");
  }

}

この例では、port という JAX-RPC スタブが、http://localhost:7001/async/StockQuote にある Web サービスを呼び出すために使用されています。getQuote オペレーションが非同期的に呼び出され、この呼び出しに対する応答は、@AsyncResponse アノテーションで指定されている onGetQuoteAsyncResponse メソッドによって処理されます。

weblogic.jws.Binding

説明

対象 : クラス

SOAP (Simple Object Access Protocol) メッセージの送受信時に、Web サービスで SOAP 実装のバージョン 1.1 を使うのか、バージョン 1.2 を使うのかを指定します。デフォルトでは、WebLogic Web サービスは SOAP 1.1 を使用します。

属性

例

次に、SOAP 1.2 を指定する例を示します (関連コードのみ表示)。

package examples.webservices.soap12;

...

import javax.jws.WebMethod;
import javax.jws.WebService;

import weblogic.jws.Binding;

@WebService(name="SOAP12PortType",
            serviceName="SOAP12Service",
            targetNamespace="http://example.org")

@Binding(Binding.Type.SOAP12)

public class SOAP12Impl {

  @WebMethod()
  public String sayHello(String message) {

...

  }

}

weblogic.jws.BufferQueue

説明

対象 : クラス

JMS キューの JNDI 名を指定します。WebLogic Server は、それに対して以下の操作を行います。

バッファ付き Web サービスで使用する場合、このアノテーションは、バッファリングされた JWS のメソッドを指定する @MessageBuffer と組み合わせて使用します。信頼性のある Web サービスで使用する場合、このアノテーションは、Web サービスに関連付けられた、信頼性のあるメッセージング WS-Policy ファイルを指定する @Policy と組み合わせて使用します。

Web サービスに対してバッファ付きまたは信頼性のあるメッセージングを有効にしているが、@BuffereQueue アノテーションを指定していない場合、WebLogic Server は、デフォルトの Web サービス JMS キュー (weblogic.wsee.DefaultQueue) を使用して、バッファ付きまたは信頼性のあるオペレーションの呼び出しを格納します。この JMS キューは、JMS 転送機能のデフォルト キューでもあります。これらの機能のいずれかに対してこの JMS キューを使用する場合は、JMS キューをあらかじめ作成していることが前提となります。

バッファ付きまたは信頼性のある Web サービスの詳細および作成例については、「バッファ付き Web サービスの作成」と「Web サービスの信頼性のあるメッセージングの使用」を参照してください。

属性

例

以下の例では、JWS ファイルのコード スニペットを示します。ここでは、パブリック オペレーションがバッファ付きで、WebLogic Server がオペレーションの呼び出しを入れている JMS キューが my.buffere.queue と呼ばれています。関連する Java コードのみを示します。

package examples.webservices.buffered;

...

@WebService(name="BufferedPortType",
            serviceName="BufferedService",
            targetNamespace="http://example.org")

@BufferQueue(name="my.buffer.queue")

public class BufferedImpl {

...

  @WebMethod()
  @MessageBuffer(retryCount=10, retryDelay="10 seconds")
  @Oneway()
  public void sayHelloNoReturn(String message) {
    System.out.println("sayHelloNoReturn: " + message);
  }
}

weblogic.jws.Callback

説明

対象 : フィールド

アノテーション付き変数がコールバックであることを指定します。つまり、アノテーション付き変数を使って、対象 Web サービスのオペレーションを呼び出したクライアント Web サービスにコールバック イベントを返送できます。

対象 Web サービスにおいて @Callback アノテーションを指定すると、クライアント Web サービスにコールバックできます。アノテーション付き変数のデータ型は、コールバック インタフェースです。

コールバック機能は、2 つの WebLogic Web サービス間で機能します。ただし、この機能をプログラミングする際、次の 3 つの Java ファイルを作成します。

コールバック機能のプログラミングに関する詳細および手順については、「コールバックによるクライアントへのイベントの通知」を参照してください。

@Callback アノテーションは、属性を持ちません。

例

次に、callback という変数に @Callback アノテーションを付けた非常に簡単な対象 Web サービスの例を示します。この変数のデータ型は CallbackInterface で、これは、コールバック Web サービスがこの名前で存在する必要があることを意味します。変数にコールバック情報が注入された後で、CallbackInterface で定義されているコールバック メソッドを呼び出すことができます。この例では、callbackOperation() がコールバック メソッドです。

関連コードは、太字で示しています。

package examples.webservices.callback;

import weblogic.jws.WLHttpTransport;
import weblogic.jws.Callback;

import javax.jws.WebService;
import javax.jws.WebMethod;

@WebService(name="CallbackPortType",
            serviceName="TargetService",
            targetNamespace="http://examples.org/")

@WLHttpTransport(contextPath="callback",
                 serviceUri="TargetService",
                 portName="TargetServicePort")

public class TargetServiceImpl {

  @Callback
  CallbackInterface callback;

  @WebMethod
  public void targetOperation (String message) {

        callback.callbackOperation (message);

  }

}

weblogic.jws.CallbackMethod

説明

対象 : メソッド

コールバック Web サービスから受け取るメッセージを処理する、クライアント Web サービスのメソッドを指定します。この属性を使うと、クライアント Web サービス内のコールバック メッセージ ハンドラ メソッドと、コールバック インタフェース内のコールバック メソッドをリンクできます。

コールバック機能は、2 つの WebLogic Web サービス間で機能します。ただし、この機能をプログラミングする際、次の 3 つの Java ファイルを作成します。

コールバック機能のプログラミングに関する詳細および手順については、「コールバックによるクライアントへのイベントの通知」を参照してください。

属性

例

次に、@CallbackMethod アノテーションが付けられているクライアント Web サービスのメソッドを示します。この属性では、port という変数に前もって JAX-RPC スタブ情報が注入されていること、およびアノテーション付きメソッドが callbackOperation() というコールバック オペレーションから受信したメッセージを処理することが示されています。

  @CallbackMethod(target="port", operation="callbackOperation")
  @CallbackRolesAllowed(@SecurityRole(role="engineer",  mapToPrincipals="shackell"))
  public void callbackHandler(String msg) {

        System.out.println (msg);

  }

weblogic.jws.CallbackService

説明

対象 : クラス

JWS ファイルが実際に、コールバック Web サービスを記述する Java インタフェースであることを指定します。このアノテーションは、@javax.jws.WebService に似ていますが、コールバックに限定され、属性の数も制限されています。

コールバック機能は、2 つの WebLogic Web サービス間で機能します。ただし、この機能をプログラミングする際、次の 3 つの Java ファイルを作成します。

@CallbackInterface アノテーションを使うと、Java ファイルがコールバック インタフェース ファイルであることが指定されます。

コールバック インタフェースをプログラミングする際、標準の非コールバック Web サービスと同様に、1 つまたは複数のコールバック メソッドを指定し、これらのメソッドに @javax.jws.WebMethod アノテーションを付け、それらが Web サービス オペレーションであることを指定します。ただし、非コールバック メソッドとは異なり、これらのコールバック メソッドの実際の実装コードを記述する必要はありません。代わりに、jwsc Ant タスクを使ったクライアント Web サービスのコンパイル時に、そのタスクで自動的にコールバック インタフェースの実装が作成され、それが Web サービスにパッケージ化されます。こうして生成された実装によって、コールバック メソッドがすべて同じ処理を行う (コールバック メソッドを呼び出す対象 Web サービスからクライアント Web サービスにメッセージを返送する) ことが指定されます。

コールバック機能のプログラミングに関する詳細および手順については、「コールバックによるクライアントへのイベントの通知」を参照してください。

属性

例

次に、非常に簡単なコールバック インタフェースの例を示します。結果のコールバック Web サービスは、callbackOperation() というコールバック メソッドを 1 つ持ちます。

package examples.webservices.callback;

import weblogic.jws.CallbackService;

import javax.jws.Oneway;
import javax.jws.WebMethod;

@CallbackService

public interface CallbackInterface {

  @WebMethod
  @Oneway
  public void callbackOperation (String msg);

}

weblogic.jws.Context

説明

対象 : フィールド

アノテートされたフィールドが Web サービスの実行時コンテキストへのアクセスを提供するように指定します。

クライアント アプリケーションが、JWS ファイルで実装された WebLogic Web サービスを呼び出すと、WebLogic Server は、Web サービスが、サービスに関する実行時情報のアクセス、および場合によっては変更に使用できるコンテキストを自動的に作成します。この情報の多くは、現在の会話が終了したか、会話のプロパティの現在の値、実行時の会話のプロパティの変更など、会話に関連しています。コンテキストを介してアクセス可能な情報には、Web サービスの呼び出しに使用されたプロトコル (HTTP/S または JMS)、SOAP メッセージ要求内にあった SOAP ヘッダなど、より一般的なものもあります。アノテーション フィールドのデータ型は weblogic.wsee.jws.JwsContext です。これは、コンテキストを問い合わせるメソッドを含む WebLogic Web サービス API です。

このアノテーションの使用に関する詳細については、「JwsContext を使用した Web サービスの実行時情報へのアクセス」を参照してください。

このアノテーションには、属性はありません。

例

以下の JWS ファイルのスニペットでは、@Context アノテーションの使い方を示します。ここでは、ファイルの一部のみを示し、該当するコード箇所は太字になっています。

...

import weblogic.jws.Context;

import weblogic.wsee.jws.JwsContext;

...

public class JwsContextImpl {

  @Context
  private JwsContext ctx;

  @WebMethod()
  public String getProtocol() {

...

weblogic.jws.Conversation

説明

対象 : メソッド

@Conversation アノテーション付きのメソッドが、2 つの WebLogic Web サービスの間の会話、またはスタンドアロン Java クライアントと会話形式の Web サービスとの間の会話の一部として呼び出すことができるように指定します。

会話形式の Web サービスは通常、3 つのメソッドを指定します。各メソッドには、会話の開始、継続、終了の各フェーズに対応する @Conversation アノテーションが付けられています。@Conversational アノテーションは、Web サービスが会話形式になるようにクラス レベルで指定する場合、および最大アイドル時間などの会話のプロパティをコンフィグレーションする場合に使用します。

2 つの Web サービスの間の会話の場合、クライアント サービスでは、@ServiceClient アノテーションを使用して、wsdl、サービス名、呼び出された会話サービスのポートを指定します。サービスとスタンドアロン クライアントとの間の会話の場合、クライアントは、開始メソッド、継続メソッド、および終了メソッドを適切な順序で呼び出し、会話を行います。Web サービスを会話形式にするために、唯一の追加要件として、java.io.Serializable を実装する必要があります。

このアノテーションの詳細および使用例については、「会話形式の Web サービスの作成」を参照してください。

属性

例

以下のサンプル スニペットでは、会話の開始、継続、および終了の各フェーズを指定するために @Conversation アノテーションが付けられた 3 つのメソッド (start、middle、および finish) を含む JWS ファイルを示します。

...

public class ConversationalServiceImpl implements Serializable {

  @WebMethod
  @Conversation (Conversation.Phase.START)
  public String start() {
    // 会話を開始する Java コードがここに入る
  }

  @WebMethod
  @Conversation (Conversation.Phase.CONTINUE)
  public String middle(String message) {
    // 会話を継続する Java コードがここに入る
  }

  @WebMethod
  @Conversation (Conversation.Phase.FINISH)
  public String finish(String message ) {
    // 会話を終了する Java コードがここに入る
  }

}

weblogic.jws.Conversational

説明

対象 : クラス

JWS ファイルが会話形式の Web サービスを実装するように指定します。

Web サービスを会話形式にするために、このアノテーションを使用する必要はありません。@Conversation アノテーションを 1 つのメソッドに付けるだけで、JWS ファイルのすべてのメソッドは自動的に会話形式になります。クラス レベルの @Conversational アノテーションは、会話形式の動作の一部を変更する場合や、クラス レベルで JWS が会話形式であることを明示する場合にのみ使用します。

JWS ファイルで @Conversational アノテーションを使用しない場合でも、デフォルト値がニーズに合っていれば、属性なしでアノテーションを指定できます。ただし、会話で可能な最大アイドル時間、会話の最大継続時間などの値を変更する場合は、それぞれに対応した属性を指定します。

このアノテーションの詳細および使用例については、「会話形式の Web サービスの作成」を参照してください。

属性

例

以下のサンプル スニペットでは、JWS ファイルが会話形式の Web サービスを実装するように指定する方法を示します。会話で許可されている最大アイドル時間は 10 分、会話の最大継続時間はアクティビティに関係なく 1 日です。会話の継続および終了フェーズは、会話を開始したユーザとは別のユーザによって実行されます。各フェーズが発生すると、対応するメソッドが、元のユーザではなく新しいユーザとして実行されます。

package examples.webservices.conversation;

...

@Conversational(maxIdleTime="10 minutes",
                maxAge="1 day",
                runAsStartUser=false,
                singlePrincipal=false )

public class ConversationalServiceImpl implements Serializable {

...

weblogic.jws.MessageBuffer

説明

対象 : クラス、メソッド

JWS のどのパブリック メソッドがバッファされるかを指定します。クラス レベルで指定した場合、すべてのパブリック メソッドがバッファされます。一部のメソッドのみバッファする場合、適切なメソッド レベルでアノテーションを指定します。

クライアント Web サービスが、別の WebLogic Web サービスのバッファ付きオペレーションを呼び出すと、呼び出された Web サービスをホストしている WebLogic Server は、呼び出しメッセージを JMS キューに入れます。実際の呼び出しは、後で WebLogic Server が JMS キューの先頭から Web サービスの実装にメッセージを配信したときに処理されます。クライアントは、応答を待つ必要がなく、処理の実行を継続できます。このため、バッファリングされたオペレーション (追加の非同期機能なしの場合) は、void のみを返すことができ、@Oneway アノテーションが付けられている必要があります。値を返すオペレーションをバッファリングする場合は、呼び出し側のクライアント Web サービスからの非同期の要求と応答も使用する必要があります。詳細については、「非同期の要求と応答を使用した Web サービスの呼び出し」を参照してください。

バッファリングは、バッファされた一方のオペレーションをもう一方が呼び出す 2 つの Web サービスの間でのみ機能します。

@MessageBuffer の省略可能な属性を使用すると、JMS キューによる、バッファされた Web サービス オペレーションの呼び出しが成功するまでの回数、およびその呼び出しの間隔を指定できます。

省略可能なクラスレベルの @BufferQueue アノテーションを使用すると、呼び出しメッセージを入れる JMS キューを指定できます。このアノテーションを指定しなかった場合、メッセージは、デフォルト Web サービス キュー weblogic.wsee.DefaultQueue に入れられます。

このアノテーションの詳細および使用例については、「バッファ付き Web サービスの作成」を参照してください。

属性

@MessageBuffer(retryDelay="2 days")

例

以下の例では、JWS ファイルのコード スニペットを示します。ここでは、パブリック オペレーション sayHelloNoReturn がバッファ付きで、WebLogic Server がオペレーションの呼び出しを入れている JMS キューが my.buffere.queue と呼ばれています。呼び出された Web サービスをホストしている WebLogic Server インスタンスは、最大再試行回数 10 回、再試行間隔 10 秒で、JMS キュー内の呼び出しメッセージを Web サービスの実装に配信しようとしています。以下のスニペットでは、関連する Java コードのみを示します。

package examples.webservices.buffered;

...

@WebService(name="BufferedPortType",
            serviceName="BufferedService",
            targetNamespace="http://example.org")

@BufferQueue(name="my.buffer.queue")

public class BufferedImpl {

...

  @WebMethod()
  @MessageBuffer(retryCount=10, retryDelay="10 seconds")
  @Oneway()
  public void sayHelloNoReturn(String message) {
    System.out.println("sayHelloNoReturn: " + message);
  }
}

weblogic.jws.Policies

説明

対象 : クラス、メソッド

@weblogic.jws.Policy アノテーションの配列を指定します。

このアノテーションは、複数の WS-Policy ファイルを JWS ファイルのクラスまたはメソッドにアタッチする場合に使用します。アタッチする WS-Policy ファイルが 1 つだけの場合は、@weblogic.jws.Policy を単独で使用できます。

このアノテーションの詳細と使用例については、「Web サービスの信頼性のあるメッセージングの使用」および「メッセージレベルのセキュリティ (デジタル署名と暗号化) のコンフィグレーション」を参照してください。

この JWS アノテーションは、属性を持ちません。

例

@Policies({
    @Policy(uri="policy:firstPolicy.xml"),
    @Policy(uri="policy:secondPolicy.xml")
  })

weblogic.jws.Policy

説明

対象 : クラス、メソッド

デジタル署名、暗号化、または Web サービスの信頼性のあるメッセージングに関する情報を格納している WS-Policy ファイルを要求または応答 SOAP メッセージに適用するように指定します。

このアノテーションを単独で使用すると、単一の WS-Policy ファイルをクラスまたはメソッドに適用できます。複数の WS-Policy ファイルをクラスまたはメソッドに適用する場合は、@weblogic.jws.Policies アノテーションを使用し、WS-Policy ファイルをまとめて適用します。

このアノテーションをクラス レベルで指定した場合、WS-Policy ファイル (1 つまたは複数) は Web サービスのあらゆるパブリック オペレーションに適用されます。アノテーションをメソッド レベルで指定した場合、WS-Policy ファイルは、対応するオペレーションにのみ適用されます。

デフォルトでは、WS-Policy ファイルは要求 (着信) と応答 (発信) の両方の SOAP メッセージに適用されます。このデフォルトの動作は、direction 属性を使用して変更できます。

デフォルトではまた、指定した WS-Policy ファイルは、Web サービス用に生成されてパブリッシュされた WSDL ファイルにアタッチされるので、コンシューマは、Web サービスの WS-Policy に関するすべての要件を確認できます。このデフォルトの動作を変更するには、attachToWsdl 属性を使用します。

このアノテーションの詳細と使用例については、「Web サービスの信頼性のあるメッセージングの使用」および「メッセージレベルのセキュリティ (デジタル署名と暗号化) のコンフィグレーション」を参照してください。

属性

@Policy(uri="policy:MyPolicyFile.xml")

例

  @Policy(uri="policy:myPolicy.xml", 
          attachToWsdl=true, 
          direction=Policy.Direction.outbound)

weblogic.jws.ReliabilityBuffer

説明

対象 : メソッド

このアノテーションは、WebLogic Server による JMS キューから Web サービス実装へのメッセージ配信試行回数、およびサーバが待機すべき再試行間隔など、信頼性のある Web サービスのオペレーションに対する信頼性のあるメッセージングのプロパティのコンフィグレーションに使用します。

Web サービスに対して信頼性のある Web サービス メッセージングを有効にする際の詳細については、「Web サービスの信頼性のあるメッセージングの使用」を参照してください。

属性

@ReliabilityBuffer(retryDelay="2 days")

例

以下のサンプル スニペットでは、メソッドレベルで信頼性のあるオペレーションのデフォルトの再試行回数と再試行間隔を変更する @ReliabilityBuffer アノテーションの使い方を示します。ここでは、関連する Java コードのみを示します。

package examples.webservices.reliable;

import javax.jws.WebMethod;
import javax.jws.WebService;
import javax.jws.Oneway;

...

import weblogic.jws.ReliabilityBuffer;
import weblogic.jws.Policy;

@WebService(name="ReliableHelloWorldPortType",
              serviceName="ReliableHelloWorldService")

...

@Policy(uri="ReliableHelloWorldPolicy.xml",
          direction=Policy.Direction.inbound,
          attachToWsdl=true)

public class ReliableHelloWorldImpl {

  @WebMethod()
  @Oneway()
  @ReliabilityBuffer(retryCount=10, retryDelay="10 seconds")

  public void helloWorld(String input) {
    System.out.println(" Hello World " + input);

  }
}

weblogic.jws.ReliabilityErrorHandler

説明

対象 : メソッド

クライアント Web サービスが信頼性のある Web サービスを呼び出したが、信頼性のある Web サービスが実際にそのメッセージを受け取ったという確認応答をそのクライアントが受信しなかった場合に発生するエラーを処理するメソッドを指定します。

このアノテーションは、Web サービスの信頼性のあるメッセージング機能を実装する場合にのみ関係します。アノテーションは、信頼性のある Web サービスを呼び出すクライアントサイドの Web サービスで指定します。

@ReliabilityErrorHandler アノテーションを付けるメソッドでは、データ型 weblogic.wsee.reliability.ReliabilityErrorContext のパラメータを 1 つ取ります。このコンテキストを使うと、エラーの原因 (エラーの原因となったオペレーション、対象 Web サービス、障害など) に関する詳細な情報を取得できます。メソッドは、void を返す必要があります。

@ReliabilityErrorHandler アノテーションの 1 つの属性では、クライアント Web サービスが呼び出している信頼性のある Web サービスの JAX-RPC スタブ情報を注入した変数を指定します。この情報は、@weblogic.jws.ServiceClient アノテーションを使って変数に注入します。

属性

例

信頼性のある Web サービスを呼び出すクライアント Web サービスの次のコードでは、@ReliabilityErrorHandler アノテーションの使用方法を示します。ここでは、コードの一部のみが示され、このアノテーションに関連するコードについては太字で示されています。

package examples.webservices.reliable;

...

import weblogic.jws.ServiceClient;
import weblogic.jws.ReliabilityErrorHandler;

import examples.webservices.reliable.ReliableHelloWorldPortType;

import weblogic.wsee.reliability.ReliabilityErrorContext;
import weblogic.wsee.reliability.ReliableDeliveryException;

@WebService(name="ReliableClientPortType",
...

public class ReliableClientImpl

{

  @ServiceClient(
     wsdlLocation="http://localhost:7001/ReliableHelloWorld/ReliableHelloWorld?WSDL",
     serviceName="ReliableHelloWorldService",
     portName="ReliableHelloWorldServicePort")

  private ReliableHelloWorldPortType port;

  @WebMethod
  public void callHelloWorld(String input, String serviceUrl)
     throws RemoteException {

   ...

  }

  @ReliabilityErrorHandler(target="port")
  public void onReliableMessageDeliveryError(ReliabilityErrorContext ctx) {

    ReliableDeliveryException fault = ctx.getFault();
    String message = null;
    if (fault != null) {
      message = ctx.getFault().getMessage();
    }
    String operation = ctx.getOperationName();
    System.out.println("Reliable operation " + operation + " may have not invoked. The error message is " + message);
  }

}

上の例では、port 変数は ReliableHelloWorldService Web Service に対応する JAX-RPC スタブで注入されており、クライアント Web サービスの特定の場所で、このスタブのオペレーションが呼び出されると見なされます。onReliableMessageDeliveryError メソッドは、@ReliabilityErrorHandler アノテーションが付けられ、port JAX-RPC スタブとリンクされているため、信頼性のある Web サービスの呼び出しにおいて障害が発生した場合、このメソッドが呼び出されます。信頼性のあるエラー処理メソッドでは、ReliabilityErrorContext オブジェクトを使用して、このエラーの原因の詳細を取得します。

weblogic.jws.ServiceClient

説明

対象 : フィールド

JWS ファイルのアノテーション付き変数が、以下の機能を使用するときに、別の WebLogic Web サービスを呼び出す JAX-RPC スタブであることを指定します。

信頼性のあるメッセージング機能および非同期の要求と応答機能は、2 つの Web サービスの間でのみ使用します。つまり、たとえば、スタンドアロン クライアントからではなく、別の Web サービスからのみ信頼性のある Web サービス オペレーションを呼び出すことができます。信頼性のあるメッセージング機能は、WS-ReliableMessaging 1.0 仕様が実装された任意の 2 つのアプリケーション サーバ間で機能します。非同期の要求と応答機能は、2 つの WebLogic Server インスタンス間でのみ機能します。

クライアント Web サービスの場合、どの変数が、@ServiceClient 属性で記述した Web サービスの JAX-RPC ポートの種類かを指定するには、@ServiceClient アノテーションを使用します。クライアント Web サービスを格納するエンタープライズ アプリケーションも、呼び出している Web サービスの JAX-RPC スタブを含んでいる必要があります。このスタブは、clientgen Ant タスクで生成します。

@ServiceClient アノテーションの詳細および使用例については、「高度な JWS プログラミング : 非同期機能の実装」を参照してください。

属性

例

以下の JWS ファイルの抜粋では、クライアント Web サービスで @ServiceClient アノテーションを使用し、呼び出される Web サービス (WSDL が http://localhost:7001/ReliableHelloWorld/ReliableHelloWorld?WSDL という URL 上にある ReliableHelloWorldService) の JAX-RPC スタブでフィールド (port) にアノテーションを付ける方法を示します。ここでは、関連する部分のみを示します。

package examples.webservices.reliable;

import javax.jws.WebService;

...

import weblogic.jws.ServiceClient;

import examples.webservices.reliable.ReliableHelloWorldPortType;

@WebService(...

public class ReliableClientImpl

{

  @ServiceClient(

     wsdlLocation="http://localhost:7001/ReliableHelloWorld/ReliableHelloWorld?WSDL",
     serviceName="ReliableHelloWorldService",
     portName="ReliableHelloWorldServicePort")

  private ReliableHelloWorldPortType port;

  @WebMethod

  public void callHelloWorld(String input, String serviceUrl)

     throws RemoteException {

    port.helloWorld(input);

    System.out.println(" Invoked the ReliableHelloWorld.helloWorld operation reliably." );

  }

}

weblogic.jws.StreamAttachments

説明

対象 : クラス

WebLogic Web サービス ランタイムで、Web サービスのすべてのメソッド パラメータを読み込む際に Streaming API を使用するように指定します。これによって、特に画像など、大きなパラメータの場合に Web サービス オペレーションの呼び出しのパフォーマンスが向上します。

同じ Web サービスで次の機能も使用している場合、このアノテーションは使用できません。

@StreamAttachments アノテーションは、属性を持ちません。

例

次に、@StreamAttachments アノテーションを指定する簡単な JWS ファイルを示します。単一のメソッド echoAttachment() は DataHandler パラメータを取り、Web サービス オペレーションを呼び出したクライアント アプリケーションにエコー バックします。WebLogic Web サービス ランタイムでは、DataHandler の内容を読み込む際にストリーミングが使用されます。

package examples.webservices.stream_attach;

import javax.jws.WebMethod;
import javax.jws.WebService;

import weblogic.jws.WLHttpTransport;
import weblogic.jws.StreamAttachments;

import javax.activation.DataHandler;

import java.rmi.RemoteException;

@WebService(name="StreamAttachPortType",
            serviceName="StreamAttachService",
            targetNamespace="http://example.org")

@WLHttpTransport(contextPath="stream_attach",
                 serviceUri="StreamAttachService",
                 portName="StreamAttachServicePort")

@StreamAttachments

/**
 * 添付ファイルのストリーミング例
 */

public class StreamAttachImpl {

  @WebMethod()
  public DataHandler echoAttachment(DataHandler dh) throws RemoteException {

        return dh;

  }
}

weblogic.jws.Transactional

説明

対象 : クラス、メソッド

アノテーション付きのオペレーション、またはアノテーションがクラスレベルで指定されている場合は JWS ファイルのすべてのオペレーションがトランザクション内で実行されるかどうかを指定します。デフォルトでは、オペレーションはトランザクションでは実行されません。

属性

例

以下の例では、@Transactional アノテーションを使って、Web サービスのオペレーションがトランザクションの一部として実行されるように指定する方法を示します。

package examples.webservices.transactional;

import javax.jws.WebMethod;
import javax.jws.WebService;

import weblogic.jws.WLHttpTransport;
import weblogic.jws.Transactional;

@WebService(name="TransactionPojoPortType",
            serviceName="TransactionPojoService",
            targetNamespace="http://example.org")

@WLHttpTransport(contextPath="transactionsPojo",
                 serviceUri="TransactionPojoService",
                 portName="TransactionPojoPort")

/**
 * この JWS ファイルは、1 つのオペレーション sayHello を含む簡単な
 * WebLogic Web サービスの基本となる。オペレーションはトランザクションの
 * 一部として実行される
 *
 * @author Copyright (c) 2004 by BEA Systems.  All rights reserved.
 */

public class TransactionPojoImpl {

  @WebMethod()
  @Transactional(value=true)

  public String sayHello(String message) {
    System.out.println("sayHello:" + message);
    return "Here is the message: '" + message + "'";
  }

}

weblogic.jws.Types

説明

対象 : メソッド、パラメータ

戻り値またはパラメータの代替データ型の完全修飾 Java クラス名のカンマ区切りリストを指定します。代替データ型は、メソッド シグネチャで指定されたデータ型を拡張する必要があります。これに当てはまらない場合、JWS ファイルを Web サービスにコンパイルする際に jwsc Ant タスクは検証エラーを返します。

たとえば、Address 基本データ型を作成してから、この基本の型を拡張する USAAddress および CAAddress を作成しているものと仮定します。メソッド シグネチャで、この型が Address パラメータを取ることが指定されている場合、このパラメータに @Types アノテーションを付け、パブリック オペレーションでも、基本 Address データ型の他に、パラメータとして USAAddress および CAAddress を取るように指定できます。

このアノテーションを使うと、java.util.Collection または java.util.List など、コレクション データ型の戻り値またはパラメータに格納可能なデータ型を制限することもできます。許容される格納データ型を制限することによって、生成される WSDL は明確で一義的となり、クライアント アプリケーションが Web サービス オペレーションを呼び出す際、Web サービス ランタイムはパラメータの適格確認処理を効率よく実行できます。

このアノテーションをメソッド レベルで指定すると、適用対象は戻り値に限定されます。アノテーションをパラメータに適用する場合、各関連パラメータについて、パラメータ レベルで指定する必要があります。

属性

例

次の例では、@Types アノテーションを使用する簡単な JWS ファイルを示します。関連する Java コードは太字で示しています。

package examples.webservices.types;

import javax.jws.WebMethod;
import javax.jws.WebService;

import weblogic.jws.WLHttpTransport;
import weblogic.jws.Types;

import examples.webservices.types.BasicStruct;

@WebService(serviceName="TypesService",
            name="TypesPortType",
            targetNamespace="http://example.org")

@WLHttpTransport(contextPath="types",
                 serviceUri="TypesService",
                 portName="TypesServicePort")

public class TypesImpl {

  @WebMethod()
  @Types({"examples.webservices.types.ExtendedStruct"})
  public BasicStruct echoStruct(
     @Types({"examples.webservices.types.ExtendedStruct"}) BasicStruct struct)
  {
    System.out.println("echoStruct called");
    return struct;
  }

}

上の例では、echoStruct() メソッドのシグネチャにおいて、パラメータおよび戻り値の両方として BasicStruct 値を取ることが示されています。ただし、メソッドおよび struct パラメータは共に @Types アノテーションが付けられているため、echoStruct オペレーションを呼び出すクライアント アプリケーションは、データ型 ExtendedStruct のパラメータも渡すことができます。この場合、オペレーションも ExtendedStruct 値を返します。ここでは、ExtendedStruct が BasicStruct を拡張するものと見なされています。

weblogic.jws.WildcardBinding

説明

対象 : クラス

javax.xml.soap.SOAPElement または org.apache.xmlbeans.XmlObject などのワイルドカード クラスがバインドする先の XML スキーマ データ型を指定します。デフォルトでは、これらの Java データ型は <xsd:any> XML スキーマ データ型にバインドされます。このクラス レベルのアノテーションを使用すると、ワイルドカード クラスを代わりに <xsd:anyType> にバインドするように指定できます。

属性

例

次に、@WildcardBinding アノテーションを使って、Apache XMLBeans データ型の XMLObject が、この Web サービスの <xsd:any> XML スキーマ データ型にバインドされるように指定する例を示します。

@WildcardBindings({
    @WildcardBinding(className="org.apache.xmlbeans.XmlObject", 
                      binding=WildcardParticle.ANY),
    @WildcardBinding(className="org.apache.xmlbeans.XmlObject[]",
                      binding=WildcardParticle.ANY)})
public class SimpleImpl {

...

weblogic.jws.WildcardBindings

説明

対象 : クラス

@weblogic.jws.WildcardBinding アノテーションの配列を指定します。

この JWS アノテーションは、属性を持ちません。

例については、weblogic.jws.WildcardBinding を参照してください。

weblogic.jws.WLHttpTransport

説明

対象 : クラス

生成された WSDL のポート名に加え、HTTP 転送形式で Web サービスを呼び出すために使用するコンテキスト パスおよび URL のサービス URI セクションを指定します。

このアノテーションは、JWS ファイル内で最大で一度だけ指定できます。

属性

http://hostname:7001/financial/GetQuote?WSDL

http://hostname:7001/financial/GetQuote?WSDL

例

@WLHttpTransport(contextPath="complex", 
                 serviceUri="ComplexService",
                 portName="ComplexServicePort")

weblogic.jws.WLHttpsTransport

説明

対象 : クラス

生成された WSDL のポート名に加え、HTTPS 転送形式で Web サービスを呼び出すために使用するコンテキスト パスおよび URL のサービス URI セクションを指定します。

このアノテーションは、JWS ファイル内で最大で一度だけ指定できます。

属性

https://hostname:7001/financial/GetQuote?WSDL

https://hostname:7001/financial/GetQuote?WSDL

例

@WLHttpsTransport(portName="helloSecurePort",
                 contextPath="secure",
                 serviceUri="SimpleSecureBean")

weblogic.jws.WLJmsTransport

説明

対象 : クラス

生成された WSDL のポート名に加え、JMS 転送形式で Web サービスを呼び出すために使用するコンテキスト パスおよび URL のサービス URI セクションを指定します。WebLogic Server がオペレーションの呼び出しの SOAP 要求メッセージを入れる JMS キューを指定する場合にも、このアノテーションを使用します。

このアノテーションは、JWS ファイル内で最大で一度だけ指定できます。

属性

例

以下の例では、JMS 転送を使用して呼び出される Web サービスが JWS ファイルで実装されるように指定する方法を示します。WebLogic Server が、サービス オペレーションの呼び出しにある SOAP メッセージ要求を入れる JMS キューは JMSTransportQueue です。ここでは、この JMS キューは WebLogic Server 用にすでにコンフィグレーションされていることを前提としています。

WLJmsTransport(contextPath="transports", 
                serviceUri="JMSTransport",
                queue="JMSTransportQueue", 
                portName="JMSTransportServicePort")

weblogic.jws.WSDL

説明

対象 : クラス

デプロイされた WebLogic Web サービスの WSDL を公開するかどうかを指定します。

デフォルトでは、WSDL は次の URL で公開されます。

http://[host]:[port]/[contextPath]/[serviceUri]?WSDL

各要素の説明は次のとおりです。

たとえば、次の @WLHttpTransport アノテーションを使用しているとします。

@WLHttpTransport(portName="helloPort",
                 contextPath="hello",
                 serviceUri="SimpleImpl")

Web サービスが ariel というホストのデフォルトのポート番号で実行されているとすると、その Web サービスの WSDL を表示する URL は次のとおりです。

http://ariel:7001/hello/SimpleImpl?WSDL

属性

例

以下の @WSDL アノテーションの使用例では、デプロイされる Web サービスの WSDL が公開されないように指定する方法を示します。ここでは、関連する Java コードのみを示します。

package examples.webservices;

import....

@WebService(name="WsdlAnnotationPortType",
            serviceName="WsdlAnnotationService",
            targetNamespace="http://example.org")

@WSDL(exposed=false)

public class WsdlAnnotationImpl {

...

}

weblogic.jws.security.CallbackRolesAllowed

説明

対象 : メソッド、フィールド

Web サービスのコールバック メソッドを呼び出す許可を与えられたロールをリストする @SecurityRole JWS アノテーションの配列を指定します。未指定のロールにマップされたユーザ、またはロールにマップされていないユーザは、コールバック メソッドの呼び出しを許可されません。

このアノテーションをフィールド レベルで使用した場合、指定したロールは、Web サービスのすべてのコールバック オペレーションの呼び出しを許可されます。このアノテーションをメソッド レベルで使用した場合、指定したロールは、コールバック メソッドのみの呼び出しを許可されます。両方のレベルで指定し、衝突がある場合、メソッド値がフィールド値をオーバーライドします。

属性

例

次に、メソッド レベルで @CallbackRolesAllowed アノテーションを使って、ロール engineer がコールバック メソッドの呼び出しを許可されるように指定する例を示します。

  @CallbackMethod(target="port", operation="callbackOperation")
  @CallbackRolesAllowed(@SecurityRole(role="engineer", mapToPrincipals="shackell"))
  public void callbackHandler(String msg) {

        System.out.println (msg);

  }

weblogic.jws.security.RolesAllowed

説明

対象 : クラス、メソッド

Web サービスの基本認証の有効化に使用される JWS アノテーション。具体的には、これは Web サービスを呼び出す許可を与えられたロールのリストを記述した @SecurityRole JWS アノテーションの配列を指定します。未指定のロールにマップされたユーザ、またはロールにマップされていないユーザは、Web サービスの呼び出しを許可されません。

このアノテーションをクラス レベルで使用した場合、指定したロールは、Web サービスのすべてのオペレーションの呼び出しを許可されます。特定のオペレーション群のみに対してロールを指定するには、アノテーションをオペレーションレベルで指定します。

属性

例

package examples.webservices.security_roles;

...

import weblogic.jws.security.RolesAllowed;
import weblogic.jws.security.SecurityRole;

@WebService(name="SecurityRolesPortType",
            serviceName="SecurityRolesService",
            targetNamespace="http://example.org")

@RolesAllowed (  {
    @SecurityRole (role="manager",
                   mapToPrincipals={ "juliet","amanda" }),
    @SecurityRole (role="vp")
} )

public class SecurityRolesImpl {

...

この例では、ロール manager および vp のみが Web サービスの呼び出しを許可されています。Web サービスのコンテキスト内で、ユーザ juliet および amanda にはロール manager が割り当てられます。しかしロール vp には、ユーザが外部でこのロールにマップされたことを示唆する mapToPrincipals 属性が含まれていません。ここでは、2 人のユーザ juliet および amanda が WebLogic Server セキュリティ レルムにすでに追加されていることが前提となっています。

weblogic.jws.security.RolesReferenced

説明

対象 : クラス

Web サービスの呼び出しが許可されている実際のロールを参照する、ロール名のリストの指定に使用される JWS アノテーション。具体的には、@SecurityRoleRef JWS アノテーションの配列を指定します。各アノテーションには、参照されるロール名と、@SecurityRole アノテーションで定義される実際のロールの間のリンクが記述されています。

この JWS アノテーションは、属性を持ちません。

例

package examples.webservices.security_roles;

...

import weblogic.jws.security.RolesAllowed;
import weblogic.jws.security.SecurityRole;
import weblogic.jws.security.RolesReferenced;
import weblogic.jws.security.SecurityRoleRef;

@WebService(name="SecurityRolesPortType",
            serviceName="SecurityRolesService",
            targetNamespace="http://example.org")

@RolesAllowed (  {
    @SecurityRole (role="manager",
                   mapToPrincipals={ "juliet","amanda" }),
    @SecurityRole (role="vp")
} )

@RolesReferenced (
    @SecurityRoleRef (role="mgr", link="manager")
)

public class SecurityRolesImpl {

...

この例では、ロール mgr は Web サービスの呼び出しを許可されているロール manager にリンクされています。つまり、mgr のロールに割り当てられたユーザはすべて、Web サービスの呼び出しを許可されているということです。

weblogic.jws.security.RunAs

説明

対象 : クラス

WebLogic Server 内の Web サービスを実際に実行するロールおよびユーザ ID を指定します。

たとえば、@RunAs アノテーションが、roleA ロールと userA プリンシパルを指定すると仮定します。これは、Web サービスが userB (roleB にマップされている) によって呼び出された場合でも、関連のオペレーションは内部で実際には userA として実行されているということです。

属性

例

package examples.webservices.security_roles;

import weblogic.jws.security.RunAs;

...

@WebService(name="SecurityRunAsPortType",
            serviceName="SecurityRunAsService",
            targetNamespace="http://example.org")

@RunAs (role="manager", mapToPrincipal="juliet")

public class SecurityRunAsImpl {

...

この例では、どのユーザによって呼び出されたかに関係なく、Web サービスを常にロール manager にマップされているユーザ juliet として実行するということを指定する方法を示します。

weblogic.jws.security.SecurityRole

説明

対象 : クラス、メソッド

Web サービスの呼び出しを許可されているロールの名前を指定します。このアノテーションは、JWS ファイルの中で常に @RolesAllowed 配列のメンバーとして指定されます。

クライアント アプリケーションは保護された Web サービスを呼び出す際、基本認証の一部としてユーザおよびパスワードを指定します。管理者は Administration Console を使用してユーザを有効な WebLogic Server ユーザとしてコンフィグレーション済みであることが前提となっています。詳細については、「ユーザの作成」を参照してください。

Web サービスを呼び出すユーザは、関連のロールにもマップされている必要があります。このタスクは、次の 2 つの方法のいずれかによって実行できます。

複数のロールが Web サービスの呼び出しを許可されていることを指定するには、複数の @SecurityRole アノテーションを @RolesAllowed アノテーション内に含めます。

属性

例

package examples.webservices.security_roles;

...

import weblogic.jws.security.RolesAllowed;
import weblogic.jws.security.SecurityRole;

@WebService(name="SecurityRolesPortType",
            serviceName="SecurityRolesService",
            targetNamespace="http://example.org")

@RolesAllowed (  {
    @SecurityRole (role="manager",
                   mapToPrincipals={ "juliet","amanda" }),
    @SecurityRole (role="vp")
} )

public class SecurityRolesImpl {

...

この例では、ロール manager および vp のみが Web サービスの呼び出しを許可されています。Web サービスのコンテキスト内で、ユーザ juliet および amanda にはロール manager が割り当てられます。しかしロール vp には、ユーザが外部でこのロールにマップされたことを示唆する mapToPrincipals 属性が含まれていません。ここでは、2 人のユーザ juliet および amanda が WebLogic Server セキュリティ レルムにすでに追加されていることが前提となっています。

weblogic.jws.security.SecurityRoleRef

説明

対象 : クラス

Web サービスの呼び出しを許可されている、指定済みのロールにリンクするロール名参照を指定します。

ロール参照にマップされたユーザは、参照されたロールが Web サービスの @RolesAllowed アノテーションで指定されている限り、Web サービスを呼び出すことができます。

属性

例

package examples.webservices.security_roles;

...

import weblogic.jws.security.RolesAllowed;
import weblogic.jws.security.SecurityRole;
import weblogic.jws.security.RolesReferenced;
import weblogic.jws.security.SecurityRoleRef;

@WebService(name="SecurityRolesPortType",
            serviceName="SecurityRolesService",
            targetNamespace="http://example.org")

@RolesAllowed (  {
    @SecurityRole (role="manager",
                   mapToPrincipals={ "juliet","amanda" }),
    @SecurityRole (role="vp")
} )

@RolesReferenced (
    @SecurityRoleRef (role="mgr", link="manager")
)

public class SecurityRolesImpl {

...

この例では、ロール mgr は Web サービスの呼び出しを許可されているロール manager にリンクされています。つまり、mgr のロールに割り当てられたユーザはすべて、Web サービスの呼び出しを許可されているということです。

weblogic.jws.security.UserDataConstraint

説明

対象 : クラス

クライアントが Web サービスを呼び出す際に、HTTPS 転送の使用が必要であるかどうかを指定します。

WebLogic Server は、このアノテーションの transport 属性が、Web サービスを実装する JWS ファイル内で Transport.INTEGRAL と Transport.CONFIDENTIAL のうちのいずれかに設定されていると、クライアントと Web サービスの間にセキュア ソケット レイヤ (SSL) 接続を確立します。

このアノテーションを JWS ファイル内で指定した場合は、weblogic.jws.WLHttpTransport アノテーション (または jwsc Ant タスクの <WLHttpTransport> 要素) も指定して、HTTPS バインディングが jwsc Ant タスクによって WSDL ファイル内に確実に生成されるようにする必要があります。

属性

例

package examples.webservices.security_https;

import weblogic.jws.security.UserDataConstraint;

...

@WebService(name="SecurityHttpsPortType",
            serviceName="SecurityHttpsService",
            targetNamespace="http://example.org")

@UserDataConstraint(
           transport=UserDataConstraint.Transport.CONFIDENTIAL)

public class SecurityHttpsImpl {

...

weblogic.jws.security.WssConfiguration

説明

対象 : クラス

Web サービスで使用する Web サービス セキュリティ コンフィグレーションの名前を指定します。JWS ファイルでこのアノテーションを指定しなかった場合、デフォルトのセキュリティ コンフィグレーション (default_wss) をドメインで作成済みであれば、Web サービスは、そのセキュリティ コンフィグレーションに関連付けられます。

@WssConfiguration アノテーションは、Web サービスでメッセージレベルのセキュリティ (暗号化およびデジタル署名) がコンフィグレーションされている場合にのみ有効です。このアノテーションを使用して Web サービスに関連付けられたセキュリティ コンフィグレーションでは、ID の認証に X.509 証明書を使用するかどうか、パスワード ダイジェストを使用するかどうか、暗号化やデジタル署名にキーストアを使用するかどうかなどを指定します。

WebLogic Web サービスは、必ずしもセキュリティ コンフィグレーションと関連付ける必要はありません。Web サービスのセキュリティ ランタイムのデフォルトの動作が十分なものであれば、追加のコンフィグレーションは不要です。しかし、Web サービスでデフォルトとは異なる動作が必要とされる場合 (ID の認証に、デフォルトのユーザ名/パスワードのトークンではなく X.509 証明書を使用する場合など) は、Web サービスにセキュリティ コンフィグレーションを関連付ける必要があります。

セキュリティ コンフィグレーションを指定した Web サービスを呼び出すことができるようにするには、あらかじめ Administration Console でセキュリティ コンフィグレーションを作成しておく必要があります。詳細については、「Web サービス セキュリティ コンフィグレーションの作成」を参照してください。メッセージレベルのセキュリティの概要については、「メッセージレベルのセキュリティ (デジタル署名と暗号化) のコンフィグレーション」を参照してください。

属性

例

以下の例では、Web サービスが my_security_configuration セキュリティ コンフィグレーションに関連付けられるように指定する方法を示します。ここでは、関連する Java コードのみを示します。

package examples.webservices.wss_configuration;

import javax.jws.WebService;
...

import weblogic.jws.security.WssConfiguration;

@WebService(...
...

@WssConfiguration(value="my_security_configuration")

public class WssConfigurationImpl {

...

weblogic.jws.soap.SOAPBinding

説明

対象 : メソッド

SOAP メッセージ プロトコルに対する Web サービス オペレーションのマッピングを指定します。

このアノテーションは、@javax.jws.soap.SOAPBinding に似ていますが、クラスではなく、メソッドに適用される点が異なります。たとえば、このアノテーションを使用すると、ある Web サービス オペレーションで RPC エンコードの SOAP バインディングを使用し、同じ Web サービスの別のオペレーションでは document-literal-wrapped の SOAP バインディングを使用するように指定できます。

属性

例

次に、Web サービスのオペレーションが document-literal-wrapped の SOAP バインディングをデフォルトで使用するように指定する簡単な JWS ファイルを示します。これは、@javax.jws.soap.SOAPBinding アノテーションをクラス レベルで使用することによって指定できます。この例では、@weblogic.jws.soap.SOAPBinding アノテーションをメソッド レベルで使用して個々のメソッドに異なる SOAP バインディングを指定する方法も示します。具体的には、sayHelloDocLitBare() メソッドでは document-literal-bare の SOAP バインディングを使用し、sayHelloRPCEncoded() メソッドでは RPC エンコードの SOAP バインディングを使用します。

package examples.webservices.soap_binding_method;

import javax.jws.WebMethod;
import javax.jws.WebService;
import javax.jws.soap.SOAPBinding;

import weblogic.jws.WLHttpTransport;

@WebService(name="SoapBindingMethodPortType",
            serviceName="SoapBindingMethodService",
            targetNamespace="http://example.org")

@SOAPBinding(style=SOAPBinding.Style.DOCUMENT,
             use=SOAPBinding.Use.LITERAL,
             parameterStyle=SOAPBinding.ParameterStyle.WRAPPED)

@WLHttpTransport(contextPath="soap_binding_method",
                 serviceUri="SoapBindingMethodService",
                 portName="SoapBindingMethodServicePort")

/**
 * メソッドの SOAP バインディングを指定する簡単な JWS の例
 */

public class SoapBindingMethodImpl {

  @WebMethod()
  @weblogic.jws.soap.SOAPBinding(
               style=SOAPBinding.Style.DOCUMENT,
               use=SOAPBinding.Use.LITERAL,
               parameterStyle=SOAPBinding.ParameterStyle.BARE)

  public String sayHelloDocLitBare(String message) {
    System.out.println("sayHelloDocLitBare" + message);
    return "Here is the message: '" + message + "'";
  }

  @WebMethod()
  @weblogic.jws.soap.SOAPBinding(
               style=SOAPBinding.Style.RPC,
               use=SOAPBinding.Use.ENCODED)

  public String sayHelloRPCEncoded (String message) {
    System.out.println("sayHelloRPCEncoded" + message);
    return "Here is the message: '" + message + "'";
  }
}

weblogic.jws.security.SecurityRoles (非推奨)

説明

対象 : クラス、メソッド

Web サービスのオペレーションにアクセスできるロールを指定します。

このアノテーションをクラス レベルで指定した場合、指定したロールは、Web サービスのすべてのパブリック オペレーションに適用されます。複数のロールを同じ Web サービスの複数のオペレーションに関連付ける場合は、メソッド レベルでロールのリストを指定することもできます。

属性

例

以下の例では、Admin ロールのみが Web サービスを呼び出すことができるようにクラスレベルで指定する方法を示します。ここでは、関連する部分のみを示します。

package examples.webservices.security_roles;

import javax.ejb.SessionBean;
import javax.ejb.SessionContext;

import weblogic.ejbgen.Session;

import javax.jws.WebService;

...

import weblogic.jws.security.SecurityRoles;

@Session(ejbName="SecurityRolesEJB")

@WebService(...

// Web サービス全体を呼び出すことができるロールを指定する

@SecurityRoles(rolesAllowed="Admnin")

public class SecurityRolesImpl implements SessionBean {

...

weblogic.jws.security.SecurityIdentity (非推奨)

説明

対象 : クラス

呼び出された Web サービスが前提とする ID を指定します。

別の値を指定した場合を除き、Web サービスは、認証された呼び出し側の ID を前提とします。このアノテーションを使用すると、Web サービスが特定のロールで実行されるように設定を変更できます。ロールは、WebLogic Server のセキュリティ レルム内のユーザまたはグループに対応している必要があります。

属性

例

以下の例では、呼び出された Web サービスが Admin ロールで実行されるように指定する方法を示します。

package examples.webservices.security_roles;

import javax.ejb.SessionBean;
import javax.ejb.SessionContext;

import weblogic.ejbgen.Session;

import javax.jws.WebService;

...

import weblogic.jws.security.SecurityIdentity;

@Session(ejbName="SecurityRolesEJB")

@WebService(...

// Web サービスが Admin ロールで実行されるように指定する

@SecurityIdentity( value="Admin")

public class SecurityRolesImpl implements SessionBean {

...