javax.xml.ws.spi

クラスServiceDelegate

java.lang.Object

javax.xml.ws.spi.ServiceDelegate

public abstract class ServiceDelegate
extends Object

サービスの委譲は、プラグイン可能なJAX-WS実装を許可するため、Serviceオブジェクトによって内部的に使用されます。

すべてのServiceオブジェクトには、Provider.createServiceDelegate(java.net.URL, javax.xml.namespace.QName, java.lang.Class<? extends javax.xml.ws.Service>)メソッドを使用して作成された、それ自身の委譲があります。Serviceオブジェクトは、それ自身のすべてのインスタンス・メソッドをそれの委譲に委任します。

導入されたバージョン:

JAX-WS 2.0

関連項目:

Service, Provider

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	ServiceDelegate()

メソッドのサマリー

修飾子と型	メソッドと説明
abstract void	addPort(QName portName, String bindingId, String endpointAddress) サービスの新しいポートを作成します。
abstract <T> Dispatch<T>	createDispatch(EndpointReference endpointReference, Class<T> type, Service.Mode mode, WebServiceFeature... features) ユーザーが選択したオブジェクトで使用するDispatchインスタンスを作成します。
abstract Dispatch<Object>	createDispatch(EndpointReference endpointReference, JAXBContext context, Service.Mode mode, WebServiceFeature... features) JAXB生成オブジェクトで使用するDispatchインスタンスを作成します。
abstract <T> Dispatch<T>	createDispatch(QName portName, Class<T> type, Service.Mode mode) ユーザーが選択したオブジェクトで使用するDispatchインスタンスを作成します。
abstract <T> Dispatch<T>	createDispatch(QName portName, Class<T> type, Service.Mode mode, WebServiceFeature... features) ユーザーが選択したオブジェクトで使用するDispatchインスタンスを作成します。
abstract Dispatch<Object>	createDispatch(QName portName, JAXBContext context, Service.Mode mode) JAXB生成オブジェクトで使用するDispatchインスタンスを作成します。
abstract Dispatch<Object>	createDispatch(QName portName, JAXBContext context, Service.Mode mode, WebServiceFeature... features) JAXB生成オブジェクトで使用するDispatchインスタンスを作成します。
abstract Executor	getExecutor() このServiceインスタンスのexecutorを返します。
abstract HandlerResolver	getHandlerResolver() 構成済みのハンドラ・リゾルバを返します。
abstract <T> T	getPort(Class<T> serviceEndpointInterface) getPortメソッドはプロキシを返します。
abstract <T> T	getPort(Class<T> serviceEndpointInterface, WebServiceFeature... features) getPortメソッドはプロキシを返します。
abstract <T> T	getPort(EndpointReference endpointReference, Class<T> serviceEndpointInterface, WebServiceFeature... features) getPortメソッドはプロキシを返します。
abstract <T> T	getPort(QName portName, Class<T> serviceEndpointInterface) getPortメソッドはプロキシを返します。
abstract <T> T	getPort(QName portName, Class<T> serviceEndpointInterface, WebServiceFeature... features) getPortメソッドはプロキシを返します。
abstract Iterator<QName>	getPorts() このサービスによってグループ化されたサービス・エンドポイントのQNameリストのIteratorを返します
abstract QName	getServiceName() このサービスの名前を取得します。
abstract URL	getWSDLDocumentLocation() このサービスのWSDL文書の位置を取得します。
abstract void	setExecutor(Executor executor) このServiceインスタンスのexecutorを設定します。
abstract void	setHandlerResolver(HandlerResolver handlerResolver) このServiceインスタンスのHandlerResolverを設定します。

クラス java.lang.Objectから継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

ServiceDelegate

protected ServiceDelegate()

メソッドの詳細

getPort

public abstract <T> T getPort(QName portName,
                              Class<T> serviceEndpointInterface)

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

パラメータ:

portName - WSDLサービス記述内のサービス端点の修飾名

serviceEndpointInterface - 動的プロキシによってサポートされているサービス端点インタフェース

戻り値:

指定されたサービス端点インタフェースをサポートするObject Proxyインスタンス

例外:

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

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

関連項目:

Proxy, InvocationHandler

getPort

public abstract <T> T getPort(QName portName,
                              Class<T> serviceEndpointInterface,
                              WebServiceFeature... features)

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

パラメータ:

portName - WSDLサービス記述内のサービス端点の修飾名

serviceEndpointInterface - 動的プロキシまたはインスタンスによってサポートされているサービス端点インタフェース

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

戻り値:

指定されたサービス端点インタフェースをサポートするObject Proxyインスタンス

例外:

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

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

導入されたバージョン:

JAX-WS 2.1

関連項目:

Proxy, InvocationHandler, WebServiceFeature

getPort

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

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

このメソッドを呼び出したときの動作は、次の場合と同じになります

 port = service.getPort(portName, serviceEndpointInterface);
 

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

パラメータ:

endpointReference - 戻り値のプロキシによって呼び出されるターゲット・サービス端点のEndpointReference。

serviceEndpointInterface - サービス端点インタフェース。

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

戻り値:

指定されたサービス端点インタフェースをサポートするObject Proxyインスタンス。

例外:

WebServiceException -

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

導入されたバージョン:

JAX-WS 2.1

getPort

public abstract <T> T getPort(Class<T> serviceEndpointInterface)

getPortメソッドはプロキシを返します。パラメータserviceEndpointInterfaceは、戻り値のプロキシによってサポートされるサービス端点インタフェースを指定します。このメソッドの実装では、JAX-WS実行時システムがプロトコル・バインディング(およびポート)を選択し、それに従ってプロキシの構成を行います。戻り値のプロキシを、クライアントが構成し直さないようにしてください。

パラメータ:

serviceEndpointInterface - サービス端点インタフェース

戻り値:

指定されたサービス端点インタフェースをサポートするObjectインスタンス

例外:

WebServiceException -

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

getPort

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

getPortメソッドはプロキシを返します。パラメータserviceEndpointInterfaceは、戻り値のプロキシによってサポートされるサービス端点インタフェースを指定します。このメソッドの実装では、JAX-WS実行時システムがプロトコル・バインディング(およびポート)を選択し、それに従ってプロキシの構成を行います。戻り値のプロキシを、クライアントが構成し直さないようにしてください。

パラメータ:

serviceEndpointInterface - サービス端点インタフェース

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

戻り値:

指定されたサービス端点インタフェースをサポートするObjectインスタンス

例外:

WebServiceException -

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

導入されたバージョン:

JAX-WS 2.1

関連項目:

WebServiceFeature

addPort

public abstract void addPort(QName portName,
                             String bindingId,
                             String 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(QName portName,
                                               Class<T> type,
                                               Service.Mode mode)

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

パラメータ:

portName - ターゲット・サービス端点の修飾名

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

mode - 作成されたディスパッチ・インスタンスがメッセージ指向であるかペイロード指向であるかを制御する。つまり、ユーザーが完全なプロトコル・メッセージを扱うか、メッセージ・ペイロードを扱うかを制御する。たとえば、SOAPプロトコルを使用する場合、このパラメータは、ユーザーがSOAPメッセージを扱うか、SOAP本体のコンテンツを扱うかどうかを制御する。typeがSOAPMessageの場合、modeはMESSAGEでなければならない。

戻り値:

Dispatchインスタンス

例外:

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

関連項目:

Source, SOAPMessage

createDispatch

public abstract <T> Dispatch<T> createDispatch(QName portName,
                                               Class<T> type,
                                               Service.Mode mode,
                                               WebServiceFeature... features)

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

パラメータ:

portName - ターゲット・サービス端点の修飾名

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

mode - 作成されたディスパッチ・インスタンスがメッセージ指向であるかペイロード指向であるかを制御する。つまり、ユーザーが完全なプロトコル・メッセージを扱うか、メッセージ・ペイロードを扱うかを制御する。たとえば、SOAPプロトコルを使用する場合、このパラメータは、ユーザーがSOAPメッセージを扱うか、SOAP本体のコンテンツを扱うかどうかを制御する。typeがSOAPMessageの場合、modeはMESSAGEでなければならない。

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

戻り値:

Dispatchインスタンス

例外:

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

導入されたバージョン:

JAX-WS 2.1

関連項目:

Source, SOAPMessage, WebServiceFeature

createDispatch

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

ユーザーが選択したオブジェクトで使用するDispatchインスタンスを作成します。endpointReferenceに参照パラメータがある場合は、端点に送信されるすべてのメッセージにそれらの参照パラメータをSOAPヘッダーとして含め、それらが参照パラメータであることを示す必要があります。端点の呼出しにはendpointReference'sのアドレスを使用する必要があります。このメソッドの実装では、このServiceインスタンスに関連付けられたWSDLまたはendpointReferenceのメタデータに従って、JAX-WSランタイム・システムがプロトコル・バインディング(およびポート)の選択とディスパッチの構成を行います。このServiceインスタンスにWSDLがあり、endpointReferenceのメタデータにもWSDLがある場合は、このインスタンスのWSDLを使用する必要があります。このServiceインスタンスにWSDLがなく、endpointReferenceにWSDLがある場合は、endpointReferenceのWSDLを使用することができます。実装は、endpointReferenceのメタデータからportNameを取得できる必要があります。

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

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

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

パラメータ:

endpointReference - 戻り値のDispatchオブジェクトによって呼び出されるターゲット・サービス端点のEndpointReference。

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

mode - 作成されたディスパッチ・インスタンスがメッセージ指向であるかペイロード指向であるかを制御する。つまり、ユーザーが完全なプロトコル・メッセージを扱うか、メッセージ・ペイロードを扱うかを制御する。たとえば、SOAPプロトコルを使用する場合、このパラメータは、ユーザーがSOAPメッセージを扱うか、SOAP本体のコンテンツを扱うかどうかを制御する。typeがSOAPMessageの場合、modeはMESSAGEでなければならない。

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

戻り値:

Dispatchインスタンス

例外:

WebServiceException -

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

導入されたバージョン:

JAX-WS 2.1

関連項目:

Source, SOAPMessage, WebServiceFeature

createDispatch

public abstract Dispatch<Object> createDispatch(QName portName,
                                                JAXBContext context,
                                                Service.Mode mode)

JAXB生成オブジェクトで使用するDispatchインスタンスを作成します。

パラメータ:

portName - ターゲット・サービス端点の修飾名

context - メッセージまたはメッセージ・ペイロードの整列化と非整列化に使用されるJAXBコンテキスト。

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

戻り値:

Dispatchインスタンス

例外:

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

関連項目:

JAXBContext

createDispatch

public abstract Dispatch<Object> createDispatch(QName portName,
                                                JAXBContext context,
                                                Service.Mode mode,
                                                WebServiceFeature... features)

JAXB生成オブジェクトで使用するDispatchインスタンスを作成します。

パラメータ:

portName - ターゲット・サービス端点の修飾名

context - メッセージまたはメッセージ・ペイロードの整列化と非整列化に使用されるJAXBコンテキスト。

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

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

戻り値:

Dispatchインスタンス

例外:

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

導入されたバージョン:

JAX-WS 2.1

関連項目:

JAXBContext、WebServiceFeature

createDispatch

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

JAXB生成オブジェクトで使用するDispatchインスタンスを作成します。endpointReferenceに参照パラメータがある場合は、端点に送信されるすべてのメッセージにそれらの参照パラメータをSOAPヘッダーとして含め、それらが参照パラメータであることを示す必要があります。端点の呼出しにはendpointReference'sのアドレスを使用する必要があります。このメソッドの実装では、このServiceインスタンスに関連付けられたWSDLまたはendpointReferenceのメタデータに従って、JAX-WSランタイム・システムがプロトコル・バインディング(およびポート)の選択とディスパッチの構成を行います。このServiceインスタンスにWSDLがあり、endpointReferenceのメタデータにもWSDLがある場合は、このインスタンスのWSDLを使用する必要があります。このServiceインスタンスにWSDLがなく、endpointReferenceにWSDLがある場合は、endpointReferenceのWSDLを使用することができます。実装は、endpointReferenceのメタデータからportNameを取得できる必要があります。

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

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

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

パラメータ:

endpointReference - 戻り値のDispatchオブジェクトによって呼び出されるターゲット・サービス端点のEndpointReference。

context - メッセージまたはメッセージ・ペイロードの整列化と非整列化に使用されるJAXBコンテキスト。

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

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

戻り値:

Dispatchインスタンス

例外:

WebServiceException -

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

導入されたバージョン:

JAX-WS 2.1

関連項目:

JAXBContext、WebServiceFeature

getServiceName

public abstract QName getServiceName()

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

戻り値:

このサービスの修飾名

getPorts

public abstract Iterator<QName> getPorts()

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

戻り値:

javax.xml.namespace.QName型の要素を含むjava.util.Iteratorを返す

例外:

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

getWSDLDocumentLocation

public abstract URL getWSDLDocumentLocation()

このサービスのWSDL文書の位置を取得します。

戻り値:

このサービスのWSDL文書の位置を示すURL

getHandlerResolver

public abstract HandlerResolver getHandlerResolver()

構成済みのハンドラ・リゾルバを返します。

戻り値:

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

setHandlerResolver

public abstract void setHandlerResolver(HandlerResolver handlerResolver)

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

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

パラメータ:

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

関連項目:

HandlerResolver

getExecutor

public abstract Executor getExecutor()

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

戻り値:

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

関連項目:

Executor

setExecutor

public abstract void setExecutor(Executor executor)

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

パラメータ:

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

例外:

SecurityException - セキュリティ上の理由により、インスタンスがexecutorを設定することをサポートしていない場合(たとえば、必要なアクセス権が不足している場合)。

関連項目:

Executor