public abstract class Endpoint extends ObjectSE
エンドポイントは、このクラスで定義された静的メソッドを使用して作成されます。エンドポイントは常に 1 つの Binding
と 1 つの実装者に関連付けられており、どちらもエンドポイントの作成時に設定されます。
エンドポイントは、公開済みまたは未公開の状態です。publish
メソッドを使用してエンドポイントの公開を開始できます。その時点で、エンドポイントは受信リクエストの受け入れを開始します。逆に、stop
メソッドを使用して、受信リクエストの受け入れを停止し、エンドポイントを停止することができます。一度停止すると、エンドポイントを再度公開することはできません。
受信リクエストのディスパッチに使用されるスレッドをより適切に制御するために、エンドポイントに Executor
を設定できます。たとえば、ThreadPoolExecutor
を作成してエンドポイントに登録することで、特定のパラメーターを使用したスレッドプールを有効にできます。
ハンドラーチェーンは、含まれている Binding
を使用して設定できます。
エンドポイントには、WSDL や XMLSchema ドキュメントなどのメタデータドキュメントのリストがバインドされている場合があります。公開時に、Jakarta XML Web Services 実装は、実装者に存在するアノテーションに基づいて新しいメタデータを生成するのではなく、そのメタデータを可能な限り再利用しようとします。
Binding
, BindingType
, SOAPBinding
, Executor
SE修飾子と型 | フィールドと説明 |
---|---|
static StringSE | WSDL_PORT 標準プロパティ: WSDL ポートの名前。 |
static StringSE | WSDL_SERVICE 標準プロパティ: WSDL サービスの名前。 |
コンストラクターと説明 |
---|
Endpoint() |
修飾子と型 | メソッドと説明 |
---|---|
static Endpoint | create(ObjectSE implementor) 指定された実装オブジェクトでエンドポイントを作成します。 |
static Endpoint | create(ObjectSE implementor, WebServiceFeature... features) 指定された実装オブジェクトと Web サービス機能を使用してエンドポイントを作成します。 |
static Endpoint | create(StringSE bindingId, ObjectSE implementor) 指定されたバインディング型と実装オブジェクトを使用してエンドポイントを作成します。 |
static Endpoint | create(StringSE bindingId, ObjectSE implementor, WebServiceFeature... features) 指定されたバインディング型、実装オブジェクト、Web サービス機能を使用してエンドポイントを作成します。 |
abstract Binding | getBinding() このエンドポイントのバインディングを返します。 |
abstract <T extends EndpointReference> | getEndpointReference(ClassSE<T> clazz, ElementSE... referenceParameters) この Endpoint インスタンスに関連付けられている EndpointReference を返します。 |
abstract EndpointReference | getEndpointReference(ElementSE... referenceParameters) この Endpoint インスタンスに関連付けられている EndpointReference を返します。 |
abstract ExecutorSE | getExecutor() この Endpoint インスタンスのエグゼキュータを返します。 |
abstract ObjectSE | getImplementor() このエンドポイントの実装オブジェクトを返します。 |
abstract ListSE<SourceSE> | getMetadata() サービスのメタデータドキュメントのリストを返します。 |
abstract MapSE<StringSE, ObjectSE> | getProperties() この Endpoint インスタンスのプロパティバッグを返します。 |
abstract boolean | isPublished() エンドポイントが公開状態の場合は true を返します。 |
void | publish(HttpContext serverContext) 提供されたサーバーコンテキストでこのエンドポイントを公開します。 |
abstract void | publish(ObjectSE serverContext) 提供されたサーバーコンテキストでこのエンドポイントを公開します。 |
abstract void | publish(StringSE address) 指定されたアドレスでこのエンドポイントを公開します。 |
static Endpoint | publish(StringSE address, ObjectSE implementor) 指定されたアドレスに、指定された実装オブジェクトのエンドポイントを作成して公開します。 |
static Endpoint | publish(StringSE address, ObjectSE implementor, WebServiceFeature... features) 指定されたアドレスに、指定された実装オブジェクトのエンドポイントを作成して公開します。 |
void | setEndpointContext(EndpointContext ctxt) EndpointContext を設定することにより、Jakarta XML Web Services ランタイムはアプリケーション内の他のエンドポイントのアドレスを認識します。 |
abstract void | setExecutor(ExecutorSE executor) この Endpoint インスタンスのエグゼキュータを設定します。 |
abstract void | setMetadata(ListSE<SourceSE> metadata) このエンドポイントのメタデータを設定します。 |
abstract void | setProperties(MapSE<StringSE, ObjectSE> properties) この Endpoint インスタンスのプロパティバッグを設定します。 |
abstract void | stop() このエンドポイントの公開を停止します。 |
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
public static final StringSE WSDL_SERVICE
タイプ: javax.xml.namespace.QName
public static Endpoint create(ObjectSE implementor)
新しく作成されたエンドポイントは、publish(String)
メソッドと publish(Object)
メソッドのいずれかを呼び出すことによって公開できます。
implementor
- エンドポイントの実装者。public static Endpoint create(ObjectSE implementor, WebServiceFeature... features)
新しく作成されたエンドポイントは、publish(String)
メソッドと publish(Object)
メソッドのいずれかを呼び出すことによって公開できます。
implementor
- エンドポイントの実装者。features
- エンドポイントで構成する WebServiceFeature のリスト。features
パラメーターに含まれていないサポートされている機能には、デフォルト値があります。public static Endpoint create(StringSE bindingId, ObjectSE implementor)
新しく作成されたエンドポイントは、publish(String)
メソッドと publish(Object)
メソッドのいずれかを呼び出すことによって公開できます。
bindingId
- 使用するバインディングを指定する URI。bindingID が null
であり、BindingType アノテーションを介してバインディングが指定されていない場合は、デフォルトの SOAP 1.1/HTTP バインディングを使用する必要があります。implementor
- エンドポイントの実装者。public static Endpoint create(StringSE bindingId, ObjectSE implementor, WebServiceFeature... features)
新しく作成されたエンドポイントは、publish(String)
メソッドと publish(Object)
メソッドのいずれかを呼び出すことによって公開できます。
bindingId
- 使用するバインディングを指定する URI。bindingID が null
であり、BindingType アノテーションを介してバインディングが指定されていない場合は、デフォルトの SOAP 1.1/HTTP バインディングを使用する必要があります。implementor
- エンドポイントの実装者。features
- エンドポイントで構成する WebServiceFeature のリスト。features
パラメーターに含まれていないサポートされている機能には、デフォルト値があります。public abstract Binding getBinding()
public abstract ObjectSE getImplementor()
public abstract void publish(StringSE address)
publish(Object)
メソッドを使用してください。address
- 使用するアドレスを指定する URI。アドレスは、エンドポイントの作成時に指定されたバインディングと互換性がなければなりません。IllegalArgumentExceptionSE
- 指定されたアドレス URI がエンドポイントのバインディングと組み合わせて使用できない場合。IllegalStateExceptionSE
- エンドポイントがすでに公開されているか、停止されている場合。SecurityExceptionSE
- java.lang.SecurityManger
が使用されていて、アプリケーションに WebServicePermission("publishEndpoint")
権限がない場合。public static Endpoint publish(StringSE address, ObjectSE implementor)
必要なサーバーインフラストラクチャは、いくつかのデフォルト構成を使用して Jakarta XML Web Services 実装によって作成および構成されます。サーバー構成をより細かく制御するには、代わりに create(String,Object)
メソッドと publish(Object)
メソッドを使用してください。
address
- 使用するアドレスとトランスポート / プロトコルを指定する URI。http:URI では、SOAP 1.1/HTTP バインディングが使用される必要があります。実装は他の URI スキームをサポートする場合があります。implementor
- エンドポイントの実装者。SecurityExceptionSE
- java.lang.SecurityManger
が使用されていて、アプリケーションに WebServicePermission("publishEndpoint")
権限がない場合。public static Endpoint publish(StringSE address, ObjectSE implementor, WebServiceFeature... features)
必要なサーバーインフラストラクチャは、いくつかのデフォルト構成を使用して Jakarta XML Web Services 実装によって作成および構成されます。サーバー構成をより細かく制御するには、代わりに create(String,Object)
メソッドと publish(Object)
メソッドを使用してください。
address
- 使用するアドレスとトランスポート / プロトコルを指定する URI。http:URI では、SOAP 1.1/HTTP バインディングが使用される必要があります。実装は他の URI スキームをサポートする場合があります。implementor
- エンドポイントの実装者。features
- エンドポイントで構成する WebServiceFeature のリスト。features
パラメーターに含まれていないサポートされている機能には、デフォルト値があります。SecurityExceptionSE
- java.lang.SecurityManger
が使用されていて、アプリケーションに WebServicePermission("publishEndpoint")
権限がない場合。public abstract void publish(ObjectSE serverContext)
serverContext
- エンドポイントの公開に使用されるサーバーコンテキストを表すオブジェクト。IllegalArgumentExceptionSE
- 提供されたサーバーコンテキストが実装でサポートされていない場合、またはエンドポイントのバインディングと組み合わせて使用できないことが判明した場合。IllegalStateExceptionSE
- エンドポイントがすでに公開されているか、停止されている場合。SecurityExceptionSE
- java.lang.SecurityManger
が使用されていて、アプリケーションに WebServicePermission("publishEndpoint")
権限がない場合。public void publish(HttpContext serverContext)
これは、コンテナー開発者がエンドポイントを移植可能に公開することを目的としており、エンド開発者を対象としていません。
serverContext
- エンドポイントの公開に使用されるサーバーコンテキストを表すオブジェクト。IllegalArgumentExceptionSE
- 提供されたサーバーコンテキストが実装でサポートされていない場合、またはエンドポイントのバインディングと組み合わせて使用できないことが判明した場合。IllegalStateExceptionSE
- エンドポイントがすでに公開されているか、停止されている場合。SecurityExceptionSE
- java.lang.SecurityManger
が使用されていて、アプリケーションに WebServicePermission("publishEndpoint")
権限がない場合。public abstract void stop()
public abstract boolean isPublished()
true
。public abstract ListSE<SourceSE> getMetadata()
List<javax.xml.transform.Source>
サービスのメタデータドキュメントのリスト public abstract void setMetadata(ListSE<SourceSE> metadata)
metadata
- エンドポイントのメタデータ情報を含む XML ドキュメントソースのリスト (たとえば WSDL または XML スキーマドキュメント)IllegalStateExceptionSE
- エンドポイントがすでに公開されている場合。public abstract ExecutorSE getExecutor()
Endpoint
インスタンスのエグゼキュータを返します。エグゼキュータは、受信リクエストを実装オブジェクトにディスパッチするために使用されます。java.util.concurrent.Executor
。Executor
SEpublic abstract void setExecutor(ExecutorSE executor)
Endpoint
インスタンスのエグゼキュータを設定します。エグゼキュータは、受信リクエストを実装オブジェクトにディスパッチするために使用されます。この Endpoint
が publish(Object)
メソッドを使用して公開され、指定されたサーバーコンテキストが独自のスレッド動作を定義している場合、エグゼキュータは無視される可能性があります。executor
- リクエストのディスパッチに使用される java.util.concurrent.Executor
。SecurityExceptionSE
- インスタンスがセキュリティ上の理由でエグゼキュータの設定をサポートしていない場合(たとえば、必要な権限がない場合)。Executor
SEpublic abstract MapSE<StringSE,ObjectSE> getProperties()
Endpoint
インスタンスのプロパティバッグを返します。public abstract void setProperties(MapSE<StringSE,ObjectSE> properties)
Endpoint
インスタンスのプロパティバッグを設定します。properties
- このインスタンスに関連付けられているプロパティバッグ。public abstract EndpointReference getEndpointReference(ElementSE... referenceParameters)
Endpoint
インスタンスに関連付けられている EndpointReference
を返します。 この bindingProvider
のバインディングが SOAP1.1/HTTP または SOAP1.2/HTTP の場合、W3CEndpointReference
を返さなければなりません。
referenceParameters
- 返された EndpointReference
インスタンスに関連付けられる参照パラメーター。Endpoint
インスタンスの EndpointReference。返された EndpointReference
の型が W3CEndpointReference
の場合、指定された referenceParameters
が含まれている必要があります。WebServiceException
- EndpointReference
の作成でエラーが発生した場合、または Endpoint
が公開状態にない場合。UnsupportedOperationExceptionSE
- この BindingProvider
が XML/HTTP バインディングを使用する場合。W3CEndpointReference
public abstract <T extends EndpointReference> T getEndpointReference(ClassSE<T> clazz, ElementSE... referenceParameters)
Endpoint
インスタンスに関連付けられている EndpointReference
を返します。T
- EndpointReference の型。clazz
- 返さなければならない EndpointReference の型を指定します。referenceParameters
- 返された EndpointReference
インスタンスに関連付けられる参照パラメーター。Endpoint
インスタンスの型 clazz
の EndpointReference。返された EndpointReference
の型が W3CEndpointReference
の場合、指定された referenceParameters
が含まれている必要があります。WebServiceException
- EndpointReference
の作成でエラーが発生した場合、Endpoint
が公開状態にない場合、clazz
がサポートされている EndpointReference
型ではない場合。UnsupportedOperationExceptionSE
- この BindingProvider
が XML/HTTP バインディングを使用する場合。public void setEndpointContext(EndpointContext ctxt)
EndpointContext
を設定することにより、Jakarta XML Web Services ランタイムはアプリケーション内の他のエンドポイントのアドレスを認識します。複数のエンドポイントが WSDL の異なるポートを共有している場合、WSDL にアクセスすると、複数のポートアドレスにパッチが適用されます。これは、エンドポイントを公開する前に設定する必要があります。
ctxt
- 複数のエンドポイントで共有されます IllegalStateExceptionSE
- エンドポイントがすでに公開されているか、停止されている場合。Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.