javax.xml.ws
クラス Service

java.lang.Object
  javax.xml.ws.Service

public class Service
extends Object

Service オブジェクトは、Web サービスのクライアントビューを提供します。

Service は、次のファクトリとして動作します。

• ターゲットサービス端点のプロキシ。
• リモート操作の動的なメッセージ指向の呼び出しのための javax.xml.ws.Dispatch インスタンス。

サービスで利用可能なポートは、getPorts メソッドを使用して列挙できます。あるいは、サービス端点インタフェースを単項 getPort メソッドに渡し、適合するポートを実行時に選択させることができます。

Service によって作成されるすべてのオブジェクトのハンドラチェーンを HandlerResolver を使用して設定することができます。

非同期的コールバックをディスパッチするために使用されるスレッドをより強力に制御するため、Executor をサービスに設定することができます。たとえば、ThreadPoolExecutor を作成し、サービスにそれを登録することによって、特定のパラメータを伴うスレッドプールを有効にできます。

導入されたバージョン:

JAX-WS 2.0

関連項目:

Provider, HandlerResolver, Executor

入れ子のクラスの概要

static class

Service.Mode 動的クライアントまたはサービスの方向です。

コンストラクタの概要

protected

Service(URL wsdlDocumentLocation, QName serviceName)

メソッドの概要

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

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

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

コンストラクタの詳細

Service

protected Service(URL wsdlDocumentLocation,
                  QName serviceName)

メソッドの詳細

getPort

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

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

パラメータ:

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

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

戻り値:

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

例外:

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

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

関連項目:

Proxy, InvocationHandler

getPort

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

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

パラメータ:

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

戻り値:

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

例外:

WebServiceException -

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

addPort

public void addPort(QName portName,
                    String bindingId,
                    String endpointAddress)

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

パラメータ:

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

bindingId - バインディングの文字列識別子

endpointAddress - ターゲットサービス端点の URI 形式のアドレス

例外:

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

関連項目:

SOAPBinding.SOAP11HTTP_BINDING, SOAPBinding.SOAP12HTTP_BINDING, HTTPBinding.HTTP_BINDING

createDispatch

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

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

パラメータ:

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

type - メッセージまたはメッセージペイロードに使用されるオブジェクトのクラス。使用しているバインディングに応じて、実装は javax.xml.transform.Source、javax.xml.soap.SOAPMessage、javax.activation.DataSource をサポートする必要がある

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

戻り値:

Dispatch インスタンス

例外:

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

関連項目:

Source, SOAPMessage

createDispatch

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

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

パラメータ:

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

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

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

戻り値:

Dispatch インスタンス

例外:

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

関連項目:

JAXBContext

getServiceName

public QName getServiceName()

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

戻り値:

このサービスの修飾名

getPorts

public Iterator<QName> getPorts()

このサービスによってグループ化されたサービス端点の QName リストの Iterator を返す

戻り値:

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

例外:

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

getWSDLDocumentLocation

public URL getWSDLDocumentLocation()

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

戻り値:

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

getHandlerResolver

public HandlerResolver getHandlerResolver()

設定済みのハンドラリゾルバを返します。

戻り値:

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

setHandlerResolver

public void setHandlerResolver(HandlerResolver handlerResolver)

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

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

パラメータ:

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

関連項目:

HandlerResolver

getExecutor

public Executor getExecutor()

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

戻り値:

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

関連項目:

Executor

setExecutor

public void setExecutor(Executor executor)

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

パラメータ:

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

例外:

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

関連項目:

Executor

create

public static Service create(URL wsdlDocumentLocation,
                             QName serviceName)

Service インスタンスを作成します。 指定された WSDL 文書の位置とサービス修飾名は、一意で wsdl:service 要素を識別する必要があります。

パラメータ:

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

serviceName - サービスの QName

例外:

WebServiceException - 指定したサービスの作成でエラーが発生した場合

create

public static Service create(QName serviceName)

Service インスタンスを作成します。

パラメータ:

serviceName - サービスの QName

例外:

WebServiceException - 指定したサービスの作成でエラーが発生した場合