public class Service extends ObjectSE
Service オブジェクトは、Web サービスのクライアントビューを提供します。Service は、次のファクトリとして機能します。
Dispatch のインスタンス。 サービスで使用可能なポートは、getPorts メソッドを使用して列挙できます。または、サービスエンドポイントインターフェースを単項 getPort メソッドに渡して、ランタイムに互換性のあるポートを選択させることもできます。
Service によって作成されたすべてのオブジェクトのハンドラーチェーンは、HandlerResolver を使用して設定できます。
非同期コールバックのディスパッチに使用されるスレッドをより適切に制御するために、Executor をサービスに設定できます。たとえば、ThreadPoolExecutor を作成してサービスに登録することで、特定のパラメーターを使用したスレッドプールを有効にできます。
Provider, HandlerResolver, ExecutorSE| 修飾子と型 | クラスと説明 |
|---|---|
static class | Service.Mode 動的なクライアントまたはサービスの方向。 |
| 修飾子 | コンストラクターと説明 |
|---|---|
protected | Service(URLSE wsdlDocumentLocation, QNameSE serviceName)Service を作成します。 |
protected | Service(URLSE wsdlDocumentLocation, QNameSE serviceName, WebServiceFeature... features)Service を作成します。 |
| 修飾子と型 | メソッドと説明 |
|---|---|
void | addPort(QNameSE portName, StringSE bindingId, StringSE endpointAddress) サービスの新しいポートを作成します。 |
static Service | create(QNameSE serviceName)Service インスタンスを作成します。 |
static Service | create(QNameSE serviceName, WebServiceFeature... features)Service インスタンスを作成します。 |
static Service | create(URLSE wsdlDocumentLocation, QNameSE serviceName)Service インスタンスを作成します。 |
static Service | create(URLSE wsdlDocumentLocation, QNameSE serviceName, WebServiceFeature... features)Service インスタンスを作成します。 |
<T> Dispatch<T> | createDispatch(EndpointReference endpointReference, ClassSE<T> type, Service.Mode mode, WebServiceFeature... features) クライアントが選択したオブジェクトで使用する Dispatch インスタンスを作成します。 |
Dispatch<ObjectSE> | createDispatch(EndpointReference endpointReference, JAXBContext context, Service.Mode mode, WebServiceFeature... features)Jakarta XML Binding で生成されたオブジェクトで使用する Dispatch インスタンスを作成します。 |
<T> Dispatch<T> | createDispatch(QNameSE portName, ClassSE<T> type, Service.Mode mode) クライアントが選択したオブジェクトで使用する Dispatch インスタンスを作成します。 |
<T> Dispatch<T> | createDispatch(QNameSE portName, ClassSE<T> type, Service.Mode mode, WebServiceFeature... features) クライアントが選択したオブジェクトで使用する Dispatch インスタンスを作成します。 |
Dispatch<ObjectSE> | createDispatch(QNameSE portName, JAXBContext context, Service.Mode mode)Jakarta XML Binding で生成されたオブジェクトで使用する Dispatch インスタンスを作成します。 |
Dispatch<ObjectSE> | createDispatch(QNameSE portName, JAXBContext context, Service.Mode mode, WebServiceFeature... features)Jakarta XML Binding で生成されたオブジェクトで使用する Dispatch インスタンスを作成します。 |
ExecutorSE | getExecutor() この Service インスタンスのエグゼキュータを返します。 |
HandlerResolver | getHandlerResolver() 構成されたハンドラーリゾルバーを返します。 |
<T> T | getPort(ClassSE<T> serviceEndpointInterface)getPort メソッドはプロキシを返します。 |
<T> T | getPort(ClassSE<T> serviceEndpointInterface, WebServiceFeature... features)getPort メソッドはプロキシを返します。 |
<T> T | getPort(EndpointReference endpointReference, ClassSE<T> serviceEndpointInterface, WebServiceFeature... features)getPort メソッドはプロキシを返します。 |
<T> T | getPort(QNameSE portName, ClassSE<T> serviceEndpointInterface)getPort メソッドはプロキシを返します。 |
<T> T | getPort(QNameSE portName, ClassSE<T> serviceEndpointInterface, WebServiceFeature... features)getPort メソッドはプロキシを返します。 |
IteratorSE<QNameSE> | getPorts() このサービスによってグループ化されたサービスエンドポイントの QName のリストの Iterator を返します |
QNameSE | getServiceName() このサービスの名前を取得します。 |
URLSE | getWSDLDocumentLocation() このサービスの WSDL ドキュメントの場所を取得します。 |
void | setExecutor(ExecutorSE executor) この Service インスタンスのエグゼキュータを設定します。 |
void | setHandlerResolver(HandlerResolver handlerResolver) この Service インスタンスの HandlerResolver を設定します。 |
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSEprotected Service(URLSE wsdlDocumentLocation, QNameSE serviceName)
Service を作成します。指定された WSDL ドキュメントの場所とサービス修飾名は、wsdl:service 要素を一意に識別しなければなりません(MUST)。wsdlDocumentLocation - サービスの WSDL ドキュメントの場所の URL serviceName - サービスの QName protected Service(URLSE wsdlDocumentLocation, QNameSE serviceName, WebServiceFeature... features)
Service を作成します。作成されたインスタンスは、Web サービス機能で構成されます。指定された WSDL ドキュメントの場所とサービス修飾名は、wsdl:service 要素を一意に識別しなければなりません(MUST)。wsdlDocumentLocation - サービスの WSDL ドキュメントの場所の URL serviceName - サービスの QName features - サービスで構成する必要がある Web サービス機能。プロバイダーが機能を理解していない場合は、WebServiceException をスローする必要があります。public <T> T getPort(QNameSE portName, ClassSE<T> serviceEndpointInterface)
getPort メソッドはプロキシを返します。サービスクライアントは、このプロキシを使用して、ターゲットサービスエンドポイントで操作を呼び出します。serviceEndpointInterface は、作成された動的プロキシインスタンスによってサポートされるサービスエンドポイントインターフェースを指定します。T - サービスエンドポイントインターフェース。portName - WSDL サービス記述内のサービスエンドポイントの修飾名。serviceEndpointInterface - 動的プロキシインスタンスでサポートされるサービスエンドポイントインターフェース。WebServiceException - この例外は、次の場合にスローされます。serviceEndpointInterface または portName が指定された場合。ProxySE, InvocationHandlerSEpublic <T> T getPort(QNameSE portName, ClassSE<T> serviceEndpointInterface, WebServiceFeature... features)
getPort メソッドはプロキシを返します。サービスクライアントは、このプロキシを使用して、ターゲットサービスエンドポイントで操作を呼び出します。serviceEndpointInterface は、作成された動的プロキシインスタンスによってサポートされるサービスエンドポイントインターフェースを指定します。T - サービスエンドポイントインターフェース。portName - WSDL サービス記述内のサービスエンドポイントの修飾名。serviceEndpointInterface - 動的プロキシインスタンスでサポートされるサービスエンドポイントインターフェース。features - プロキシで構成する WebServiceFeatures のリスト。features パラメーターに含まれていないサポートされている機能には、デフォルト値があります。WebServiceException - この例外は、次の場合にスローされます。serviceEndpointInterface または portName が指定された場合。ProxySE, InvocationHandlerSE, WebServiceFeaturepublic <T> T getPort(ClassSE<T> serviceEndpointInterface)
getPort メソッドはプロキシを返します。パラメーター serviceEndpointInterface は、返されたプロキシによってサポートされるサービスエンドポイントインターフェースを指定します。このメソッドの実装では、Jakarta XML Web Services ランタイムシステムがプロトコルバインディング(およびポート)を選択し、それに応じてプロキシを構成する責任を負います。返されたプロキシは、クライアントが再構成しないでください。T - サービスエンドポイントインターフェース。serviceEndpointInterface - サービスエンドポイントインターフェース。WebServiceException -serviceEndpointInterface が指定された場合。public <T> T getPort(ClassSE<T> serviceEndpointInterface, WebServiceFeature... features)
getPort メソッドはプロキシを返します。パラメーター serviceEndpointInterface は、返されたプロキシによってサポートされるサービスエンドポイントインターフェースを指定します。このメソッドの実装では、Jakarta XML Web Services ランタイムシステムがプロトコルバインディング(およびポート)を選択し、それに応じてプロキシを構成する責任を負います。返されたプロキシは、クライアントが再構成しないでください。T - サービスエンドポイントインターフェース。serviceEndpointInterface - サービスエンドポイントインターフェース。features - プロキシで構成する WebServiceFeatures のリスト。features パラメーターに含まれていないサポートされている機能には、デフォルト値があります。WebServiceException -serviceEndpointInterface が指定された場合。WebServiceFeaturepublic <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 -endpointReference メタデータがこの Service インスタンスの serviceName と一致しない場合。portName を WSDL または endpointReference メタデータから抽出できない場合。endpointReference が指定された場合。serviceEndpointInterface が指定された場合。public void addPort(QNameSE portName, StringSE bindingId, StringSE endpointAddress)
Dispatch インスタンスの作成にのみ使用できます。portName - ターゲットサービスエンドポイントの修飾名。bindingId - バインディングの文字列識別子。endpointAddress - URI としてのターゲットサービスエンドポイントのアドレス。WebServiceException - ポートの作成でエラーが発生した場合。SOAPBinding.SOAP11HTTP_BINDING, SOAPBinding.SOAP12HTTP_BINDING, HTTPBinding.HTTP_BINDINGpublic <T> Dispatch<T> createDispatch(QNameSE portName, ClassSE<T> type, Service.Mode mode)
Dispatch インスタンスを作成します。T - メッセージまたはペイロードの型 portName - ターゲットサービスエンドポイントの修飾名 type - メッセージまたはメッセージペイロードに使用されるオブジェクトのクラス。使用中のバインディングに応じて、javax.xml.transform.Source、jakarta.xml.soap.SOAPMessage、jakarta.activation.DataSource をサポートするための実装が必要です。mode - 作成されたディスパッチインスタンスがメッセージ指向かペイロード指向か、つまり、クライアントが完全なプロトコルメッセージまたはメッセージペイロードを処理するかどうかを制御します。例: SOAP プロトコルを使用する場合、このパラメーターは、クライアントが SOAP メッセージを処理するか SOAP 本文のコンテンツを処理するかを制御します。型が SOAPMessage の場合、モードは MESSAGE である必要があります。WebServiceException - Dispatch オブジェクトの作成でエラーが発生した場合。SourceSE, SOAPMessagepublic <T> Dispatch<T> createDispatch(QNameSE portName, ClassSE<T> type, Service.Mode mode, WebServiceFeature... features)
Dispatch インスタンスを作成します。T - メッセージまたはペイロードの型 portName - ターゲットサービスエンドポイントの修飾名 type - メッセージまたはメッセージペイロードに使用されるオブジェクトのクラス。javax.xml.transform.Source および jakarta.xml.soap.SOAPMessage をサポートするには、実装が必要です。mode - 作成されたディスパッチインスタンスがメッセージ指向かペイロード指向か、つまり、クライアントが完全なプロトコルメッセージまたはメッセージペイロードを処理するかどうかを制御します。例: SOAP プロトコルを使用する場合、このパラメーターは、クライアントが SOAP メッセージを処理するか SOAP 本文のコンテンツを処理するかを制御します。型が SOAPMessage の場合、モードは MESSAGE でなければなりません。features - プロキシで構成する WebServiceFeatures のリスト。features パラメーターに含まれていないサポートされている機能には、デフォルト値があります。WebServiceException - Dispatch オブジェクトの作成でエラーが発生した場合、またはこのポートと互換性がないかサポートされていない機能が有効になっている場合。SourceSE, SOAPMessage, WebServiceFeaturepublic <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 - メッセージまたはペイロードの型 endpointReference - 返された Dispatch オブジェクトによって呼び出されるターゲットサービスエンドポイントの EndpointReference。type - メッセージまたはメッセージペイロードに使用されるオブジェクトのクラス。javax.xml.transform.Source および jakarta.xml.soap.SOAPMessage をサポートするには、実装が必要です。mode - 作成されたディスパッチインスタンスがメッセージ指向かペイロード指向か、つまり、クライアントが完全なプロトコルメッセージまたはメッセージペイロードを処理するかどうかを制御します。例: SOAP プロトコルを使用する場合、このパラメーターは、クライアントが SOAP メッセージを処理するか SOAP 本文のコンテンツを処理するかを制御します。型が SOAPMessage の場合、モードは MESSAGE でなければなりません。features - プロキシで構成する WebServiceFeatures の配列。features パラメーターに含まれていないサポートされている機能には、デフォルト値があります。WebServiceException -endpointReference メタデータが、この Service インスタンスに関連付けられた WSDL の serviceName または portName と一致しない場合。EndpointReference メタデータから portName を判別できない場合。Dispatch オブジェクトの作成でエラーが発生した場合。SourceSE, SOAPMessage, WebServiceFeaturepublic Dispatch<ObjectSE> createDispatch(QNameSE portName, JAXBContext context, Service.Mode mode)
Dispatch インスタンスを作成します。portName - ターゲットサービスエンドポイントの修飾名 context - メッセージまたはメッセージペイロードをマーシャルおよびアンマーシャルするために使用される JAXBContext。mode - 作成されたディスパッチインスタンスがメッセージ指向かペイロード指向か、つまり、クライアントが完全なプロトコルメッセージまたはメッセージペイロードを処理するかどうかを制御します。例: SOAP プロトコルを使用する場合、このパラメーターは、クライアントが SOAP メッセージを処理するか SOAP 本文のコンテンツを処理するかを制御します。WebServiceException - Dispatch オブジェクトの作成でエラーが発生した場合。JAXBContextpublic Dispatch<ObjectSE> createDispatch(QNameSE portName, JAXBContext context, Service.Mode mode, WebServiceFeature... features)
Dispatch インスタンスを作成します。portName - ターゲットサービスエンドポイントの修飾名 context - メッセージまたはメッセージペイロードをマーシャルおよびアンマーシャルするために使用される JAXBContext。mode - 作成されたディスパッチインスタンスがメッセージ指向かペイロード指向か、つまり、クライアントが完全なプロトコルメッセージまたはメッセージペイロードを処理するかどうかを制御します。例: SOAP プロトコルを使用する場合、このパラメーターは、クライアントが SOAP メッセージを処理するか SOAP 本文のコンテンツを処理するかを制御します。features - プロキシで構成する WebServiceFeatures のリスト。features パラメーターに含まれていないサポートされている機能には、デフォルト値があります。WebServiceException - Dispatch オブジェクトの作成でエラーが発生した場合、またはこのポートと互換性がないかサポートされていない機能が有効になっている場合。JAXBContext, WebServiceFeaturepublic Dispatch<ObjectSE> createDispatch(EndpointReference endpointReference, JAXBContext context, 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, context, mode, features);
ここで、portName は WSDL または endpointReference メタデータから取得されます。endpointReference - 返された Dispatch オブジェクトによって呼び出されるターゲットサービスエンドポイントの EndpointReference。context - メッセージまたはメッセージペイロードをマーシャルおよびアンマーシャルするために使用される Jakarta XML Binding コンテキスト。mode - 作成されたディスパッチインスタンスがメッセージ指向かペイロード指向か、つまり、クライアントが完全なプロトコルメッセージまたはメッセージペイロードを処理するかどうかを制御します。例: SOAP プロトコルを使用する場合、このパラメーターは、クライアントが SOAP メッセージを処理するか SOAP 本文のコンテンツを処理するかを制御します。features - プロキシで構成する WebServiceFeatures の配列。features パラメーターに含まれていないサポートされている機能には、デフォルト値があります。WebServiceException -endpointReference メタデータが、この Service インスタンスに関連付けられた WSDL の serviceName または portName と一致しない場合。EndpointReference メタデータから portName を判別できない場合。Dispatch オブジェクトの作成でエラーが発生した場合。JAXBContext, WebServiceFeaturepublic QNameSE getServiceName()
public IteratorSE<QNameSE> getPorts()
QName のリストの Iterator を返します javax.xml.namespace.QName の要素を持つ java.util.Iterator を返します。WebServiceException - このサービスクラスが必要な WSDL メタデータにアクセスできない場合。public URLSE getWSDLDocumentLocation()
public HandlerResolver getHandlerResolver()
Service インスタンスによって使用されている HandlerResolver、または存在しない場合は null。public void setHandlerResolver(HandlerResolver handlerResolver)
Service インスタンスの HandlerResolver を設定します。ハンドラーリゾルバーが存在する場合は、作成されるプロキシまたはディスパッチインスタンスごとに 1 回呼び出され、リゾルバーによって返されるハンドラーチェーンがインスタンスに設定されます。
handlerResolver - その後に作成されるすべてのプロキシ / ディスパッチオブジェクトに使用する HandlerResolver。HandlerResolverpublic ExecutorSE getExecutor()
Service インスタンスのエグゼキュータを返します。エグゼキュータは、コールバックを必要とするすべての非同期呼び出しに使用されます。java.util.concurrent.Executor。ExecutorSEpublic void setExecutor(ExecutorSE executor)
Service インスタンスのエグゼキュータを設定します。エグゼキュータは、コールバックを必要とするすべての非同期呼び出しに使用されます。executor - コールバックを呼び出すために使用される java.util.concurrent.Executor。SecurityExceptionSE - インスタンスがセキュリティ上の理由でエグゼキュータの設定をサポートしていない場合(たとえば、必要な権限がない場合)。ExecutorSEpublic static Service create(URLSE wsdlDocumentLocation, QNameSE serviceName)
Service インスタンスを作成します。指定された WSDL ドキュメントの場所とサービス修飾名は、wsdl:service 要素を一意に識別しなければなりません(MUST)。wsdlDocumentLocation - サービスの WSDL ドキュメントの場所の URL serviceName - サービスの QName WebServiceException - 指定されたサービスの作成中にエラーが発生した場合。public static Service create(URLSE wsdlDocumentLocation, QNameSE serviceName, WebServiceFeature... features)
Service インスタンスを作成します。作成されたインスタンスは、Web サービス機能で構成されます。指定された WSDL ドキュメントの場所とサービス修飾名は、wsdl:service 要素を一意に識別しなければなりません(MUST)。wsdlDocumentLocation - サービスの WSDL ドキュメントの場所の URL serviceName - サービスの QName features - サービスで構成する必要がある Web サービス機能。プロバイダーが機能を理解していない場合は、WebServiceException をスローする必要があります。WebServiceException - 指定されたサービスの作成中にエラーが発生した場合。public static Service create(QNameSE serviceName)
Service インスタンスを作成します。serviceName - サービスの QName WebServiceException - 指定されたサービスの作成中にエラーが発生した場合 public static Service create(QNameSE serviceName, WebServiceFeature... features)
Service インスタンスを作成します。作成されたインスタンスは、Web サービス機能で構成されます。serviceName - サービスの QName features - サービスで構成する必要がある Web サービス機能。プロバイダーが機能を理解していない場合は、WebServiceException をスローする必要があります。WebServiceException - 指定されたサービスの作成中にエラーが発生した場合 Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.