コンストラクターの詳細

• ServiceDelegate

  protected ServiceDelegate()

  デフォルトコンストラクター。

メソッドの詳細

• getPort

  public abstract <T> T getPort​(QNameSE portName,
                                ClassSE<T> serviceEndpointInterface)

  getPort メソッドはプロキシを返します。サービスクライアントは、このプロキシを使用して、ターゲットサービスエンドポイントで操作を呼び出します。serviceEndpointInterface は、作成された動的プロキシインスタンスによってサポートされるサービスエンドポイントインターフェースを指定します。

  型パラメーター:

  T - サービスエンドポイントインターフェース

  パラメーター:

  portName - WSDL サービス記述のサービスエンドポイントの修飾名

  serviceEndpointInterface - 動的プロキシでサポートされるサービスエンドポイントインターフェース

  戻り値:

  指定されたサービスエンドポイントインターフェースをサポートするオブジェクトプロキシインスタンス

  例外:

  WebServiceException - この例外は、次の場合にスローされます。

  • プロキシの作成中にエラーが発生した場合
  • このメソッドで必要とされる WSDL メタデータが欠落している場合
  • 不正な serviceEndpointInterface または portName が指定されている場合

  関連事項:

  ProxySE, InvocationHandlerSE

• getPort

  public abstract <T> T getPort​(QNameSE portName,
                                ClassSE<T> serviceEndpointInterface,
                                WebServiceFeature... features)

  getPort メソッドはプロキシを返します。サービスクライアントは、このプロキシを使用して、ターゲットサービスエンドポイントで操作を呼び出します。serviceEndpointInterface は、作成された動的プロキシインスタンスによってサポートされるサービスエンドポイントインターフェースを指定します。

  型パラメーター:

  T - サービスエンドポイントインターフェース

  パラメーター:

  portName - WSDL サービス記述のサービスエンドポイントの修飾名

  serviceEndpointInterface - 動的プロキシまたはインスタンスでサポートされるサービスエンドポイントインターフェース

  features - プロキシで構成する WebServiceFeatures のリスト。features  パラメーターに含まれていないサポートされている機能には、デフォルト値があります。

  戻り値:

  指定されたサービスエンドポイントインターフェースをサポートするオブジェクトプロキシインスタンス

  例外:

  WebServiceException - この例外は、次の場合にスローされます。

  • プロキシの作成中にエラーが発生した場合
  • このメソッドで必要とされる WSDL メタデータが欠落している場合
  • 不正な serviceEndpointInterface または portName が指定されている場合
  • このポートと互換性がない、またはサポートされていない機能が有効になっている場合。

  導入:

  1.6、JAX-WS 2.1

  関連事項:

  ProxySE, InvocationHandlerSE, WebServiceFeature

• getPort

  public abstract <T> T getPort​(EndpointReference endpointReference,
                                ClassSE<T> serviceEndpointInterface,
                                WebServiceFeature... features)

  getPort メソッドはプロキシを返します。パラメーター endpointReference は、返されたプロキシによって呼び出されるエンドポイントを指定します。endpointReference に参照パラメーターがある場合、それらの参照パラメーターは、エンドポイントに送信されるすべてのメッセージで、参照パラメーターであることを示す SOAP ヘッダーとして表示される必要があります。endpointReference's アドレスは、エンドポイントでの呼び出しに使用する必要があります。パラメーター serviceEndpointInterface は、返されたプロキシによってサポートされるサービスエンドポイントインターフェースを指定します。このメソッドの実装では、Jakarta XML Web Services ランタイムシステムは、プロトコルバインディング（およびポート）を選択し、この Service インスタンスに関連付けられた WSDL または endpointReference のメタデータからプロキシを構成する責任を負います。この Service インスタンスに WSDL があり、endpointReference メタデータにも WSDL がある場合は、このインスタンスの WSDL を使用する必要があります。この Service インスタンスに WSDL がなく、endpointReference に WSDL がある場合は、endpointReference の WSDL を使用できます。返されたプロキシは、クライアントが再構成しないでください。この Service インスタンスに WSDL に含まれる情報と一致する既知のプロキシポートがある場合、そのプロキシが返されます。それ以外の場合は、WebServiceException がスローされます。

  このメソッドを呼び出すと、次のように動作します。

   port = service.getPort(portName, serviceEndpointInterface);
   

  ここで、portName は、endpointReference のメタデータから、または serviceEndpointInterface とこの Service インスタンスに関連付けられた WSDL から取得されます。

  型パラメーター:

  T - サービスエンドポイントインターフェース。

  パラメーター:

  endpointReference - 返されたプロキシによって呼び出されるターゲットサービスエンドポイントの EndpointReference。

  serviceEndpointInterface - サービスエンドポイントインターフェース。

  features - プロキシで構成する WebServiceFeatures のリスト。features  パラメーターに含まれていないサポートされている機能には、デフォルト値があります。

  戻り値:

  指定されたサービスエンドポイントインターフェースをサポートするオブジェクトプロキシインスタンス。

  例外:

  WebServiceException -

  • プロキシの作成中にエラーが発生した場合。
  • このメソッドで必要とされる WSDL メタデータが欠落している場合。
  • endpointReference メタデータがこの Service インスタンスの serviceName と一致しない場合。
  • portName を WSDL または endpointReference メタデータから抽出できない場合。
  • 無効な endpointReference が指定された場合。
  • 無効な serviceEndpointInterface が指定された場合。
  • このポートと互換性がない、またはサポートされていない機能が有効になっている場合。

  導入:

  1.6、JAX-WS 2.1

• getPort

  public abstract <T> T getPort​(ClassSE<T> serviceEndpointInterface)

  getPort メソッドはプロキシを返します。パラメーター serviceEndpointInterface は、返されたプロキシによってサポートされるサービスエンドポイントインターフェースを指定します。このメソッドの実装では、Jakarta XML Web Services ランタイムシステムがプロトコルバインディング（およびポート）を選択し、それに応じてプロキシを構成する責任を負います。返されたプロキシは、クライアントが再構成しないでください。

  型パラメーター:

  T - サービスエンドポイントインターフェース

  パラメーター:

  serviceEndpointInterface - サービスエンドポイントインターフェース

  戻り値:

  指定されたサービスエンドポイントインターフェースをサポートするオブジェクトインスタンス

  例外:

  WebServiceException -

  • プロキシの作成中にエラーが発生した場合
  • このメソッドで必要とされる WSDL メタデータが欠落している場合
  • 不正な serviceEndpointInterface が指定された場合

• getPort

  public abstract <T> T getPort​(ClassSE<T> serviceEndpointInterface,
                                WebServiceFeature... features)

  getPort メソッドはプロキシを返します。パラメーター serviceEndpointInterface は、返されたプロキシによってサポートされるサービスエンドポイントインターフェースを指定します。このメソッドの実装では、Jakarta XML Web Services ランタイムシステムがプロトコルバインディング（およびポート）を選択し、それに応じてプロキシを構成する責任を負います。返されたプロキシは、クライアントが再構成しないでください。

  型パラメーター:

  T - サービスエンドポイントインターフェース

  パラメーター:

  serviceEndpointInterface - サービスエンドポイントインターフェース

  features - プロキシで構成する WebServiceFeatures の配列。features  パラメーターに含まれていないサポートされている機能には、デフォルト値があります。

  戻り値:

  指定されたサービスエンドポイントインターフェースをサポートするオブジェクトインスタンス

  例外:

  WebServiceException -

  • プロキシの作成中にエラーが発生した場合
  • このメソッドで必要とされる WSDL メタデータが欠落している場合
  • 不正な serviceEndpointInterface が指定された場合
  • このポートと互換性がない、またはサポートされていない機能が有効になっている場合。

  導入:

  1.6、JAX-WS 2.1

  関連事項:

  WebServiceFeature

• addPort

  public abstract void addPort​(QNameSE portName,
                               StringSE bindingId,
                               StringSE endpointAddress)

  サービスの新しいポートを作成します。この方法で作成されたポートには WSDL ポート型情報が含まれておらず、Dispatch インスタンスの作成にのみ使用できます。

  パラメーター:

  portName - ターゲットサービスエンドポイントの修飾名

  bindingId - バインディングの URI 識別子。

  endpointAddress - URI としてのターゲットサービスエンドポイントのアドレス

  例外:

  WebServiceException - ポートの作成でエラーが発生した場合

  関連事項:

  SOAPBinding.SOAP11HTTP_BINDING, SOAPBinding.SOAP12HTTP_BINDING, HTTPBinding.HTTP_BINDING

• createDispatch

  public abstract <T> Dispatch<T> createDispatch​(QNameSE portName,
                                                 ClassSE<T> type,
                                                 Service.Mode mode)

  ユーザーが選択したオブジェクトで使用する Dispatch インスタンスを作成します。

  型パラメーター:

  T - メッセージまたはメッセージペイロードに使用される型。javax.xml.transform.Source および jakarta.xml.soap.SOAPMessage をサポートするには実装が必要です。

  パラメーター:

  portName - ターゲットサービスエンドポイントの修飾名

  type - メッセージまたはメッセージペイロードに使用されるオブジェクトのクラス。javax.xml.transform.Source および jakarta.xml.soap.SOAPMessage をサポートするには、実装が必要です。

  mode - 作成されたディスパッチインスタンスがメッセージ指向かペイロード指向か、つまり、ユーザーが完全なプロトコルメッセージまたはメッセージペイロードを操作するかどうかを制御します。例: SOAP プロトコルを使用する場合、このパラメーターは、ユーザーが SOAP メッセージを操作するか SOAP 本文のコンテンツを操作するかを制御します。型が SOAPMessage の場合、モードは MESSAGE でなければなりません。

  戻り値:

  ディスパッチインスタンス

  例外:

  WebServiceException - Dispatch オブジェクトの作成でエラーが発生した場合

  関連事項:

  SourceSE, SOAPMessage

• createDispatch

  public abstract <T> Dispatch<T> createDispatch​(QNameSE portName,
                                                 ClassSE<T> type,
                                                 Service.Mode mode,
                                                 WebServiceFeature... features)

  ユーザーが選択したオブジェクトで使用する Dispatch インスタンスを作成します。

  型パラメーター:

  T - メッセージまたはメッセージペイロードに使用される型。javax.xml.transform.Source および jakarta.xml.soap.SOAPMessage をサポートするには実装が必要です。

  パラメーター:

  portName - ターゲットサービスエンドポイントの修飾名

  type - メッセージまたはメッセージペイロードに使用されるオブジェクトのクラス。javax.xml.transform.Source および jakarta.xml.soap.SOAPMessage をサポートするには、実装が必要です。

  mode - 作成されたディスパッチインスタンスがメッセージ指向かペイロード指向か、つまり、ユーザーが完全なプロトコルメッセージまたはメッセージペイロードを操作するかどうかを制御します。例: SOAP プロトコルを使用する場合、このパラメーターは、ユーザーが SOAP メッセージを操作するか SOAP 本文のコンテンツを操作するかを制御します。型が SOAPMessage の場合、モードは MESSAGE でなければなりません。

  features - プロキシで構成する WebServiceFeatures のリスト。features  パラメーターに含まれていないサポートされている機能には、デフォルト値があります。

  戻り値:

  ディスパッチインスタンス

  例外:

  WebServiceException - Dispatch オブジェクトの作成でエラーが発生した場合、またはこのポートと互換性がないかサポートされていない機能が有効になっている場合。

  導入:

  1.6、JAX-WS 2.1

  関連事項:

  SourceSE, SOAPMessage, WebServiceFeature

• createDispatch

  public abstract <T> Dispatch<T> createDispatch​(EndpointReference endpointReference,
                                                 ClassSE<T> type,
                                                 Service.Mode mode,
                                                 WebServiceFeature... features)

  ユーザーが選択したオブジェクトで使用する Dispatch インスタンスを作成します。endpointReference に参照パラメーターがある場合、それらの参照パラメーターは、エンドポイントに送信されるすべてのメッセージで、参照パラメーターであることを示す SOAP ヘッダーとして表示される必要があります。endpointReference's アドレスは、エンドポイントでの呼び出しに使用する必要があります。このメソッドの実装では、Jakarta XML Web Services ランタイムシステムは、プロトコルバインディング（およびポート）を選択し、それに応じて、この Service インスタンスに関連付けられた WSDL または endpointReference のメタデータからディスパッチを構成する責任を負います。この Service インスタンスに WSDL があり、endpointReference のメタデータにも WSDL がある場合は、このインスタンスの WSDL を使用する必要があります。この Service インスタンスに WSDL がなく、endpointReference に WSDL がある場合は、endpointReference の WSDL を使用できます。実装は、endpointReference メタデータから portName を取得できなければなりません（MUST）。

  このメソッドは、呼び出しと同じように動作します

   dispatch = service.createDispatch(portName, type, mode, features);
   

  ここで、portName は WSDL または EndpointReference メタデータから取得されます。

  型パラメーター:

  T - メッセージまたはメッセージペイロードに使用されるオブジェクトの型。javax.xml.transform.Source および jakarta.xml.soap.SOAPMessage をサポートするには実装が必要です。

  パラメーター:

  endpointReference - 返された Dispatch オブジェクトによって呼び出されるターゲットサービスエンドポイントの EndpointReference。

  type - メッセージまたはメッセージペイロードに使用されるオブジェクトのクラス。javax.xml.transform.Source および jakarta.xml.soap.SOAPMessage をサポートするには、実装が必要です。

  mode - 作成されたディスパッチインスタンスがメッセージ指向かペイロード指向か、つまり、ユーザーが完全なプロトコルメッセージまたはメッセージペイロードを操作するかどうかを制御します。例: SOAP プロトコルを使用する場合、このパラメーターは、ユーザーが SOAP メッセージを操作するか SOAP 本文のコンテンツを操作するかを制御します。型が SOAPMessage の場合、モードは MESSAGE でなければなりません。

  features - プロキシで構成する WebServiceFeatures の配列。features  パラメーターに含まれていないサポートされている機能には、デフォルト値があります。

  戻り値:

  ディスパッチインスタンス

  例外:

  WebServiceException -

  • このメソッドで必要とされる WSDL メタデータが欠落している場合。
  • endpointReference メタデータが、この Service インスタンスに関連付けられた WSDL の serviceName または portName と一致しない場合。
  • EndpointReference メタデータから portName を判別できない場合。
  • Dispatch オブジェクトの作成でエラーが発生した場合。
  • このポートと互換性がない、またはサポートされていない機能が有効になっている場合。

  導入:

  1.6、JAX-WS 2.1

  関連事項:

  SourceSE, SOAPMessage, WebServiceFeature

• createDispatch

  public abstract Dispatch<ObjectSE> createDispatch​(QNameSE portName,
                                                  JAXBContext context,
                                                  Service.Mode mode)

  Jakarta XML Binding で生成されたオブジェクトで使用する Dispatch インスタンスを作成します。

  パラメーター:

  portName - ターゲットサービスエンドポイントの修飾名

  context - メッセージまたはメッセージペイロードをマーシャルおよびアンマーシャルするために使用される JAXBContext。

  mode - 作成されたディスパッチインスタンスがメッセージ指向かペイロード指向か、つまり、ユーザーが完全なプロトコルメッセージまたはメッセージペイロードを操作するかどうかを制御します。例: SOAP プロトコルを使用する場合、このパラメーターは、ユーザーが SOAP メッセージを操作するか SOAP 本文のコンテンツを操作するかを制御します。

  戻り値:

  ディスパッチインスタンス

  例外:

  WebServiceException - Dispatch オブジェクトの作成でエラーが発生した場合

  関連事項:

  JAXBContext

• createDispatch

  public abstract Dispatch<ObjectSE> createDispatch​(QNameSE portName,
                                                  JAXBContext context,
                                                  Service.Mode mode,
                                                  WebServiceFeature... features)

  Jakarta XML Binding で生成されたオブジェクトで使用する Dispatch インスタンスを作成します。

  パラメーター:

  portName - ターゲットサービスエンドポイントの修飾名

  context - メッセージまたはメッセージペイロードをマーシャルおよびアンマーシャルするために使用される JAXBContext。

  mode - 作成されたディスパッチインスタンスがメッセージ指向かペイロード指向か、つまり、ユーザーが完全なプロトコルメッセージまたはメッセージペイロードを操作するかどうかを制御します。例: SOAP プロトコルを使用する場合、このパラメーターは、ユーザーが SOAP メッセージを操作するか SOAP 本文のコンテンツを操作するかを制御します。

  features - プロキシで構成する WebServiceFeatures のリスト。features  パラメーターに含まれていないサポートされている機能には、デフォルト値があります。

  戻り値:

  ディスパッチインスタンス

  例外:

  WebServiceException - Dispatch オブジェクトの作成でエラーが発生した場合、またはこのポートと互換性がないかサポートされていない機能が有効になっている場合。

  導入:

  1.6、JAX-WS 2.1

  関連事項:

  JAXBContext, WebServiceFeature

• createDispatch

  public abstract Dispatch<ObjectSE> createDispatch​(EndpointReference endpointReference,
                                                  JAXBContext context,
                                                  Service.Mode mode,
                                                  WebServiceFeature... features)

  Jakarta XML Binding で生成されたオブジェクトで使用する Dispatch インスタンスを作成します。endpointReference に参照パラメーターがある場合、それらの参照パラメーターは、エンドポイントに送信されるすべてのメッセージで、参照パラメーターであることを示す SOAP ヘッダーとして表示される必要があります。endpointReference's アドレスは、エンドポイントでの呼び出しに使用する必要があります。このメソッドの実装では、Jakarta XML Web Services ランタイムシステムは、プロトコルバインディング（およびポート）を選択し、それに応じて、この Service インスタンスに関連付けられた WSDL または endpointReference のメタデータからディスパッチを構成する責任を負います。この Service インスタンスに WSDL があり、endpointReference のメタデータにも WSDL がある場合は、このインスタンスの WSDL を使用する必要があります。この Service インスタンスに WSDL がなく、endpointReference に WSDL がある場合は、endpointReference の WSDL を使用できます。実装は、endpointReference メタデータから portName を取得できなければなりません（MUST）。

  このメソッドは、呼び出しと同じように動作します

   dispatch = service.createDispatch(portName, context, mode, features);
   

  ここで、portName は WSDL または endpointReference メタデータから取得されます。

  パラメーター:

  endpointReference - 返された Dispatch オブジェクトによって呼び出されるターゲットサービスエンドポイントの EndpointReference。

  context - メッセージまたはメッセージペイロードをマーシャルおよびアンマーシャルするために使用される JAXBContext。

  mode - 作成されたディスパッチインスタンスがメッセージ指向かペイロード指向か、つまり、ユーザーが完全なプロトコルメッセージまたはメッセージペイロードを操作するかどうかを制御します。例: SOAP プロトコルを使用する場合、このパラメーターは、ユーザーが SOAP メッセージを操作するか SOAP 本文のコンテンツを操作するかを制御します。

  features - プロキシで構成する WebServiceFeatures の配列。features  パラメーターに含まれていないサポートされている機能には、デフォルト値があります。

  戻り値:

  ディスパッチインスタンス

  例外:

  WebServiceException -

  • このメソッドで必要とされる WSDL メタデータが欠落している場合。
  • endpointReference メタデータが、この Service インスタンスに関連付けられた WSDL の serviceName または portName と一致しない場合。
  • EndpointReference メタデータから portName を判別できない場合。
  • Dispatch オブジェクトの作成でエラーが発生した場合。
  • このポートと互換性がない、またはサポートされていない機能が有効になっている場合。

  導入:

  1.6、JAX-WS 2.1

  関連事項:

  JAXBContext, WebServiceFeature

• getServiceName

  public abstract QNameSE getServiceName()

  このサービスの名前を取得します。

  戻り値:

  このサービスの修飾名

• getPorts

  public abstract IteratorSE<QNameSE> getPorts()

  このサービスによってグループ化されたサービスエンドポイントの QName のリストの Iterator を返します

  戻り値:

  型 javax.xml.namespace.QName の要素を持つ java.util.Iterator を返します

  例外:

  WebServiceException - このサービスクラスが必要な WSDL メタデータにアクセスできない場合

• getWSDLDocumentLocation

  public abstract URLSE getWSDLDocumentLocation()

  このサービスの WSDL ドキュメントの場所を取得します。

  戻り値:

  このサービスの WSDL ドキュメントの場所の URL

• getHandlerResolver

  public abstract HandlerResolver getHandlerResolver()

  構成されたハンドラーリゾルバーを返します。

  戻り値:

  HandlerResolver この Service インスタンスによって使用されている HandlerResolver、または存在しない場合は null。

• setHandlerResolver

  public abstract void setHandlerResolver​(HandlerResolver handlerResolver)

  この Service インスタンスの HandlerResolver を設定します。

  ハンドラーリゾルバーが存在する場合は、作成されるプロキシまたはディスパッチインスタンスごとに 1 回呼び出され、リゾルバーによって返されるハンドラーチェーンがインスタンスに設定されます。

  パラメーター:

  handlerResolver - その後に作成されるすべてのプロキシ / ディスパッチオブジェクトに使用する HandlerResolver。

  関連事項:

  HandlerResolver

• getExecutor

  public abstract ExecutorSE getExecutor()

  この Service インスタンスのエグゼキュータを返します。エグゼキュータは、コールバックを必要とするすべての非同期呼び出しに使用されます。

  戻り値:

  コールバックを呼び出すために使用される java.util.concurrent.Executor。

  関連事項:

  ExecutorSE

• setExecutor

  public abstract void setExecutor​(ExecutorSE executor)

  この Service インスタンスのエグゼキュータを設定します。エグゼキュータは、コールバックを必要とするすべての非同期呼び出しに使用されます。

  パラメーター:

  executor - コールバックを呼び出すために使用される java.util.concurrent.Executor。

  例外:

  SecurityExceptionSE - インスタンスがセキュリティ上の理由でエグゼキュータの設定をサポートしていない場合（たとえば、必要な権限がない場合）。

  関連事項:

  ExecutorSE