javax.xml.ws.spi

クラス Provider

java.lang.Object

javax.xml.ws.spi.Provider

public abstract class Provider
extends Object

ServiceDelegate および Endpoint オブジェクトのサービスプロバイダです。

導入されたバージョン:

JAX-WS 2.0

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
static String	JAXWSPROVIDER_PROPERTY Provider 実装クラスの名前の検索に使用されるプロパティーを表す定数です。

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

コンストラクタ

修飾子	コンストラクタと説明
protected	Provider() 新しい Provider インスタンスを作成します

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
abstract Endpoint	createAndPublishEndpoint(String address, Object implementor) 与えられたアドレスと実装オブジェクトを持つ端点オブジェクトを作成および発行します。
Endpoint	createAndPublishEndpoint(String address, Object implementor, WebServiceFeature... features) 指定されたアドレス、実装オブジェクト、および Web サービス機能を持つ端点オブジェクトを作成して発行します。
Endpoint	createEndpoint(String bindingId, Class<?> implementorClass, Invoker invoker, WebServiceFeature... features) 指定されたバインディング、実装クラス、インボーカ、および Web サービス機能を持つ端点オブジェクトを作成します。
abstract Endpoint	createEndpoint(String bindingId, Object implementor) 指定されたバインディングおよび実装オブジェクトを持つ、端点オブジェクトを作成します。
Endpoint	createEndpoint(String bindingId, Object implementor, WebServiceFeature... features) 指定されたバインディング、実装オブジェクト、および Web サービス機能を持つ端点オブジェクトを作成します。
abstract ServiceDelegate	createServiceDelegate(URL wsdlDocumentLocation, QName serviceName, Class<? extends Service> serviceClass) サービス委譲オブジェクトを作成します。
ServiceDelegate	createServiceDelegate(URL wsdlDocumentLocation, QName serviceName, Class<? extends Service> serviceClass, WebServiceFeature... features) サービス委譲オブジェクトを作成します。
abstract W3CEndpointReference	createW3CEndpointReference(String address, QName serviceName, QName portName, List<Element> metadata, String wsdlDocumentLocation, List<Element> referenceParameters) W3CEndpointReference を作成するファクトリメソッドです。
W3CEndpointReference	createW3CEndpointReference(String address, QName interfaceName, QName serviceName, QName portName, List<Element> metadata, String wsdlDocumentLocation, List<Element> referenceParameters, List<Element> elements, Map<QName,String> attributes) W3CEndpointReference を作成するファクトリメソッドです。
abstract <T> T	getPort(EndpointReference endpointReference, Class<T> serviceEndpointInterface, WebServiceFeature... features) getPort メソッドはプロキシを返します。
static Provider	provider() 新しいプロバイダオブジェクトを作成します。
abstract EndpointReference	readEndpointReference(Source eprInfoset) eprInfoset に含まれている情報セットから EndpointReference を読み取ります。

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

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

フィールドの詳細

JAXWSPROVIDER_PROPERTY

public static final String JAXWSPROVIDER_PROPERTY

Provider 実装クラスの名前の検索に使用されるプロパティーを表す定数です。

関連項目:

定数フィールド値

コンストラクタの詳細

Provider

protected Provider()

新しい Provider インスタンスを作成します

メソッドの詳細

provider

public static Provider provider()

新しいプロバイダオブジェクトを作成します。

プロバイダのサブクラスの場所を特定するために使用されるアルゴリズムは、次のステップから構成されます。

• META-INF/services/javax.xml.ws.spi.Provider という名前のリソースが存在する場合、それの最初の行 (存在する場合) が実装クラスの UTF-8 エンコード名として使用されます。
• $java.home/lib/jaxws.properties ファイルが存在し、java.util.Properties.load(InputStream) メソッドによって読み込み可能であり、キーが javax.xml.ws.spi.Provider であるエントリが含まれる場合、そのエントリの値が実装クラスの名前として使用されます。
• javax.xml.ws.spi.Provider という名前のシステムプロパティーが定義されている場合、その値が実装クラスの名前として使用されます。
• 最後に、デフォルト実装クラス名が使用されます。

createServiceDelegate

public abstract ServiceDelegate createServiceDelegate(URL wsdlDocumentLocation,
                                    QName serviceName,
                                    Class<? extends Service> serviceClass)

サービス委譲オブジェクトを作成します。

パラメータ:

wsdlDocumentLocation - サービス用の WSDL ドキュメントをポイントする URL。存在しない場合は null。

serviceName - サービスの修飾名。

serviceClass - javax.xml.ws.Service、または、そのサブクラスのいずれかであるサービスクラス。

戻り値:

新しく作成されたサービス委譲。

createServiceDelegate

public ServiceDelegate createServiceDelegate(URL wsdlDocumentLocation,
                                    QName serviceName,
                                    Class<? extends Service> serviceClass,
                                    WebServiceFeature... features)

サービス委譲オブジェクトを作成します。

パラメータ:

wsdlDocumentLocation - サービス用の WSDL ドキュメントをポイントする URL。存在しない場合は null。

serviceName - サービスの修飾名。

serviceClass - javax.xml.ws.Service、または、そのサブクラスのいずれかであるサービスクラス。

features - サービスに構成される必要がある Web サービス機能。プロバイダが機能を理解しない場合、WebServiceException をスローする必要があります。

戻り値:

新しく作成されたサービス委譲。

導入されたバージョン:

JAX-WS 2.2

createEndpoint

public abstract Endpoint createEndpoint(String bindingId,
                      Object implementor)

指定されたバインディングおよび実装オブジェクトを持つ、端点オブジェクトを作成します。

パラメータ:

bindingId - 希望するバインディング (SOAP/HTTP など) を指定する URI

implementor - 着信要求のディスパッチ先となるサービス実装オブジェクト。対応しているクラスが、すべての必要な Web サービス注釈で注釈されている必要がある。

戻り値:

新しく作成された端点。

createAndPublishEndpoint

public abstract Endpoint createAndPublishEndpoint(String address,
                                Object implementor)

与えられたアドレスと実装オブジェクトを持つ端点オブジェクトを作成および発行します。

パラメータ:

address - 使用するアドレス、および、トランスポートまたはプロトコルを指定する URI。http:URI が、使用されている SOAP 1.1/HTTP バインディングに帰着する必要がある。実装がその他の URI スキームをサポートすることも可能である。

implementor - 着信要求のディスパッチ先となるサービス実装オブジェクト。対応しているクラスが、すべての必要な Web サービス注釈で注釈されている必要がある。

戻り値:

新しく作成された端点。

readEndpointReference

public abstract EndpointReference readEndpointReference(Source eprInfoset)

eprInfoset に含まれている情報セットから EndpointReference を読み取ります。

パラメータ:

eprInfoset - EndpointReference の情報セット

戻り値:

eprInfoset から非整列化された EndpointReference。このメソッドが null を返すことはない。

例外:

WebServiceException - EndpointReference を指定の eprInfoset から作成するときにエラーが発生した場合。

NullPointerException - 指定された eprInfoset の値が null の場合。

導入されたバージョン:

JAX-WS 2.1

getPort

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

getPort メソッドはプロキシを返します。endpointReference に参照パラメータがある場合は、端点に送信されるすべてのメッセージにそれらの参照パラメータを SOAP ヘッダーとして含め、それらが参照パラメータであることを示す必要があります。パラメータ serviceEndpointInterface は、戻り値のプロキシによってサポートされるサービス端点インタフェースを指定します。パラメータ endpointReference は、戻り値のプロキシによって呼び出される端点を指定します。このメソッドの実装では、serviceEndpointInterface の WSDL メタデータおよび EndpointReference に従って、JAX-WS 実行システムがプロトコルバインディング (およびポート) の選択とプロキシの構成を行います。このメソッドで正常にプロキシを取得するには、WSDL メタデータが利用可能であることと、実装で認識される serviceName メタデータが endpointReference に含まれていることが必要です。

パラメータ:

endpointReference - 戻り値のプロキシによって呼び出される EndpointReference。

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

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

戻り値:

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

例外:

WebServiceException -

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

導入されたバージョン:

JAX-WS 2.1

関連項目:

WebServiceFeature

createW3CEndpointReference

public abstract W3CEndpointReference createW3CEndpointReference(String address,
                                              QName serviceName,
                                              QName portName,
                                              List<Element> metadata,
                                              String wsdlDocumentLocation,
                                              List<Element> referenceParameters)

W3CEndpointReference を作成するファクトリメソッドです。

このメソッドを使用して、address プロパティーと必要なほかのプロパティーを指定することにより、任意の端点の W3CEndpointReference を作成できます。このメソッドを使用して、同じ Java EE アプリケーションによって発行される端点の W3CEndpointReference を作成することもできます。そのためには、address プロパティーを指定することもできますが、そうでない場合このメソッドでは、serviceName および portName プロパティーで識別される同じ Java EE アプリケーションによって発行された端点の address を自動的に判定することができます。address が null の場合に、serviceName と portName で識別される対象が同じ Java EE アプリケーションから発行された端点でないときは、javax.lang.IllegalStateException をスローする必要があります。

パラメータ:

address - ターゲット端点のアドレスを指定する

serviceName - WSDL 内のサービスの修飾名。

portName - WSDL 内の端点の修飾名。

metadata - W3CEndpointReference インスタンスの wsa:metadata 要素に追加する要素のリスト。

wsdlDocumentLocation - サービスの WSDL ドキュメントの位置を示す URL。

referenceParameters - 返される EndpointReference インスタンスに関連付けられる参照パラメータ。

戻り値:

serviceName、portName、metadata、wsdlDocumentLocation、および referenceParameters から作成された W3CEndpointReference。このメソッドが null を返すことはない。

例外:

IllegalStateException -

• address、serviceName、および portName がすべて null の場合。
• serviceName サービスが null で、portName が null でない場合。
• address プロパティーが null の場合に、serviceName と portName で指定される対象が同じ Java EE アプリケーションから発行された有効な端点でないとき。
• serviceName が null でなく、指定の WSDL 内に存在しない場合。
• portName ポートが null でなく、WSDL の serviceName サービス内に存在しない場合。
• wsdlDocumentLocation が null でなく、有効な WSDL を表していない場合。

WebServiceException - W3CEndpointReference の作成中にエラーが発生した場合。

導入されたバージョン:

JAX-WS 2.1

createW3CEndpointReference

public W3CEndpointReference createW3CEndpointReference(String address,
                                              QName interfaceName,
                                              QName serviceName,
                                              QName portName,
                                              List<Element> metadata,
                                              String wsdlDocumentLocation,
                                              List<Element> referenceParameters,
                                              List<Element> elements,
                                              Map<QName,String> attributes)

W3CEndpointReference を作成するファクトリメソッドです。このメソッドを使用すると、拡張要素と属性を使って W3CEndpointReference インスタンスを作成できます。Provider の実装は、デフォルト実装をオーバーライドする必要があります。

このメソッドを使用して、address プロパティーと必要なほかのプロパティーを指定することにより、任意の端点の W3CEndpointReference を作成できます。このメソッドを使用して、同じ Java EE アプリケーションによって発行される端点の W3CEndpointReference を作成することもできます。そのためには、address プロパティーを指定することもできますが、そうでない場合このメソッドでは、serviceName および portName プロパティーで識別される同じ Java EE アプリケーションによって発行された端点の address を自動的に判定することができます。address が null の場合に、serviceName と portName で識別される対象が同じ Java EE アプリケーションから発行された端点でないときは、javax.lang.IllegalStateException をスローする必要があります。

パラメータ:

address - ターゲット端点のアドレスを指定する

interfaceName - wsa:Metadata 要素内の wsam:InterfaceName 要素。

serviceName - WSDL 内のサービスの修飾名。

portName - WSDL 内の端点の修飾名。

metadata - W3CEndpointReference インスタンスの wsa:metadata 要素に追加する要素のリスト。

wsdlDocumentLocation - サービスの WSDL ドキュメントの位置を示す URL。

referenceParameters - 返される EndpointReference インスタンスに関連付けられる参照パラメータ。

elements - 返される EndpointReference インスタンスに関連付けられる拡張要素。

attributes - 返される EndpointReference インスタンスに関連付けられる拡張属性。

戻り値:

serviceName、portName、metadata、wsdlDocumentLocation、および referenceParameters から作成された W3CEndpointReference。このメソッドが null を返すことはない。

例外:

IllegalStateException -

• address、serviceName、および portName がすべて null の場合。
• serviceName サービスが null で、portName が null でない場合。
• address プロパティーが null の場合に、serviceName と portName で指定される対象が同じ Java EE アプリケーションから発行された有効な端点でないとき。
• serviceName が null でなく、指定の WSDL 内に存在しない場合。
• portName ポートが null でなく、WSDL の serviceName サービス内に存在しない場合。
• wsdlDocumentLocation が null でなく、有効な WSDL を表していない場合。
• wsdlDocumentLocation が null ではないが、使用可能なメタデータから wsdli:wsdlLocation の名前空間名を取得できない場合。

WebServiceException - W3CEndpointReference の作成中にエラーが発生した場合。

導入されたバージョン:

JAX-WS 2.2

createAndPublishEndpoint

public Endpoint createAndPublishEndpoint(String address,
                                Object implementor,
                                WebServiceFeature... features)

指定されたアドレス、実装オブジェクト、および Web サービス機能を持つ端点オブジェクトを作成して発行します。Provider 実装は、デフォルトの実装をオーバーライドする必要があります。

パラメータ:

address - 使用するアドレス、および、トランスポートまたはプロトコルを指定する URI。http:URI が、使用されている SOAP 1.1/HTTP バインディングに帰着する必要がある。実装がその他の URI スキームをサポートすることも可能である。

implementor - 着信要求のディスパッチ先となるサービス実装オブジェクト。対応しているクラスが、すべての必要な Web サービス注釈で注釈されている必要がある。

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

戻り値:

新しく作成された端点。

導入されたバージョン:

JAX-WS 2.2

createEndpoint

public Endpoint createEndpoint(String bindingId,
                      Object implementor,
                      WebServiceFeature... features)

提供されたバインディング、実装オブジェクト、および Web サービス機能を持つ端点オブジェクトを作成します。Provider 実装は、デフォルトの実装をオーバーライドする必要があります。

パラメータ:

bindingId - 希望するバインディング (SOAP/HTTP など) を指定する URI

implementor - 着信要求のディスパッチ先となるサービス実装オブジェクト。対応しているクラスが、すべての必要な Web サービス注釈で注釈されている必要がある。

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

戻り値:

新しく作成された端点。

導入されたバージョン:

JAX-WS 2.2

createEndpoint

public Endpoint createEndpoint(String bindingId,
                      Class<?> implementorClass,
                      Invoker invoker,
                      WebServiceFeature... features)

指定されたバインディング、実装クラス、インボーカ、および Web サービス機能を持つ端点オブジェクトを作成します。コンテナは、通常、これを使用して端点オブジェクトを作成します。Provider 実装は、デフォルトの実装をオーバーライドする必要があります。

パラメータ:

bindingId - 希望するバインディング (SOAP/HTTP など) を指定する URI。null も可。

implementorClass - すべての必要な Web サービス注釈で注釈されていなければならないサービス実装クラス。

invoker - サービスインスタンスの実際の呼び出しを行う。

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

戻り値:

新しく作成された端点。

導入されたバージョン:

JAX-WS 2.2