パッケージ jakarta.xml.ws

クラス Endpoint

  • public abstract class Endpoint
extends ObjectSE
    Web サービスエンドポイント。

    エンドポイントは、このクラスで定義された静的メソッドを使用して作成されます。エンドポイントは常に 1 つの Binding と 1 つの実装者に関連付けられており、どちらもエンドポイントの作成時に設定されます。

    エンドポイントは、公開済みまたは未公開の状態です。publish メソッドを使用してエンドポイントの公開を開始できます。その時点で、エンドポイントは受信リクエストの受け入れを開始します。逆に、stop メソッドを使用して、受信リクエストの受け入れを停止し、エンドポイントを停止することができます。一度停止すると、エンドポイントを再度公開することはできません。

    受信リクエストのディスパッチに使用されるスレッドをより適切に制御するために、エンドポイントに Executor を設定できます。たとえば、ThreadPoolExecutor を作成してエンドポイントに登録することで、特定のパラメーターを使用したスレッドプールを有効にできます。

    ハンドラーチェーンは、含まれている Binding を使用して設定できます。

    エンドポイントには、WSDL や XMLSchema ドキュメントなどのメタデータドキュメントのリストがバインドされている場合があります。公開時に、Jakarta XML Web Services 実装は、実装者に存在するアノテーションに基づいて新しいメタデータを生成するのではなく、そのメタデータを可能な限り再利用しようとします。

    導入:
    1.6、JAX-WS 2.0
    関連事項:
    Binding, BindingType, SOAPBinding, ExecutorSE

    • フィールドの詳細

      • WSDL_SERVICE

        public static final StringSE WSDL_SERVICE
        標準プロパティ: WSDL サービスの名前。

        タイプ: javax.xml.namespace.QName

        関連事項:
        定数フィールド値

      • WSDL_PORT

        public static final StringSE WSDL_PORT
        標準プロパティ: WSDL ポートの名前。

        タイプ: javax.xml.namespace.QName

        関連事項:
        定数フィールド値

    • コンストラクターの詳細

      • Endpoint

        public Endpoint()

    • メソッドの詳細

      • create

        public static Endpoint create​(ObjectSE implementor)
        指定された実装オブジェクトでエンドポイントを作成します。BindingType アノテーションを介して指定されたバインディングがある場合は、それを使用する必要があります。それ以外の場合は、デフォルトの SOAP 1.1/HTTP バインディングを使用する必要があります。

        新しく作成されたエンドポイントは、publish(String) メソッドと publish(Object) メソッドのいずれかを呼び出すことによって公開できます。

        パラメーター:
        implementor - エンドポイントの実装者。
        戻り値:
        新しく作成されたエンドポイント。

      • create

        public static Endpoint create​(ObjectSE implementor,
                              WebServiceFeature... features)
        指定された実装オブジェクトと Web サービス機能を使用してエンドポイントを作成します。BindingType アノテーションを介して指定されたバインディングがある場合は、それを使用する必要があります。それ以外の場合は、デフォルトの SOAP 1.1/HTTP バインディングを使用する必要があります。

        新しく作成されたエンドポイントは、publish(String) メソッドと publish(Object) メソッドのいずれかを呼び出すことによって公開できます。

        パラメーター:
        implementor - エンドポイントの実装者。
        features - エンドポイントで構成する WebServiceFeature のリスト。features  パラメーターに含まれていないサポートされている機能には、デフォルト値があります。
        戻り値:
        新しく作成されたエンドポイント。
        導入:
        1.7、JAX-WS 2.2

      • create

        public static Endpoint create​(StringSE bindingId,
                              ObjectSE implementor)
        指定されたバインディング型と実装オブジェクトを使用してエンドポイントを作成します。

        新しく作成されたエンドポイントは、publish(String) メソッドと publish(Object) メソッドのいずれかを呼び出すことによって公開できます。

        パラメーター:
        bindingId - 使用するバインディングを指定する URI。bindingID が null であり、BindingType アノテーションを介してバインディングが指定されていない場合は、デフォルトの SOAP 1.1/HTTP バインディングを使用する必要があります。
        implementor - エンドポイントの実装者。
        戻り値:
        新しく作成されたエンドポイント。

      • create

        public static Endpoint create​(StringSE bindingId,
                              ObjectSE implementor,
                              WebServiceFeature... features)
        指定されたバインディング型、実装オブジェクト、Web サービス機能を使用してエンドポイントを作成します。

        新しく作成されたエンドポイントは、publish(String) メソッドと publish(Object) メソッドのいずれかを呼び出すことによって公開できます。

        パラメーター:
        bindingId - 使用するバインディングを指定する URI。bindingID が null であり、BindingType アノテーションを介してバインディングが指定されていない場合は、デフォルトの SOAP 1.1/HTTP バインディングを使用する必要があります。
        implementor - エンドポイントの実装者。
        features - エンドポイントで構成する WebServiceFeature のリスト。features  パラメーターに含まれていないサポートされている機能には、デフォルト値があります。
        戻り値:
        新しく作成されたエンドポイント。
        導入:
        1.7、JAX-WS 2.2

      • getBinding

        public abstract Binding getBinding()
        このエンドポイントのバインディングを返します。
        戻り値:
        このエンドポイントのバインディング

      • getImplementor

        public abstract ObjectSE getImplementor()
        このエンドポイントの実装オブジェクトを返します。
        戻り値:
        このエンドポイントの実装者

      • publish

        public abstract void publish​(StringSE address)
        指定されたアドレスでこのエンドポイントを公開します。必要なサーバーインフラストラクチャは、いくつかのデフォルト構成を使用して Jakarta XML Web Services 実装によって作成および構成されます。サーバー構成をより細かく制御するには、代わりに publish(Object) メソッドを使用してください。
        パラメーター:
        address - 使用するアドレスを指定する URI。アドレスは、エンドポイントの作成時に指定されたバインディングと互換性がなければなりません。
        例外:
        IllegalArgumentExceptionSE - 指定されたアドレス URI がエンドポイントのバインディングと組み合わせて使用できない場合。
        IllegalStateExceptionSE - エンドポイントがすでに公開されているか、停止されている場合。
        SecurityExceptionSE - java.lang.SecurityManger が使用されていて、アプリケーションに WebServicePermission("publishEndpoint") 権限がない場合。

      • publish

        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") 権限がない場合。

      • publish

        public static Endpoint publish​(StringSE address,
                               ObjectSE implementor,
                               WebServiceFeature... features)
        指定されたアドレスに、指定された実装オブジェクトのエンドポイントを作成して公開します。作成されたエンドポイントは、Web サービス機能で構成されます。

        必要なサーバーインフラストラクチャは、いくつかのデフォルト構成を使用して 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") 権限がない場合。
        導入:
        1.7、JAX-WS 2.2

      • publish

        public abstract void publish​(ObjectSE serverContext)
        提供されたサーバーコンテキストでこのエンドポイントを公開します。サーバーコンテキストは、特定のトランスポートのサーバーインフラストラクチャとアドレス指定情報をカプセル化します。このメソッドの呼び出しが成功するには、引数として渡されるサーバーコンテキストがエンドポイントのバインディングと互換性がある必要があります。
        パラメーター:
        serverContext - エンドポイントの公開に使用されるサーバーコンテキストを表すオブジェクト。
        例外:
        IllegalArgumentExceptionSE - 提供されたサーバーコンテキストが実装でサポートされていない場合、またはエンドポイントのバインディングと組み合わせて使用できないことが判明した場合。
        IllegalStateExceptionSE - エンドポイントがすでに公開されているか、停止されている場合。
        SecurityExceptionSE - java.lang.SecurityManger が使用されていて、アプリケーションに WebServicePermission("publishEndpoint") 権限がない場合。

      • publish

        public void publish​(HttpContext serverContext)
        提供されたサーバーコンテキストでこのエンドポイントを公開します。サーバーコンテキストは、特定のトランスポートのサーバーインフラストラクチャとアドレス指定情報をカプセル化します。このメソッドの呼び出しが成功するには、引数として渡されるサーバーコンテキストがエンドポイントのバインディングと互換性がある必要があります。

        これは、コンテナー開発者がエンドポイントを移植可能に公開することを目的としており、エンド開発者を対象としていません。

        パラメーター:
        serverContext - エンドポイントの公開に使用されるサーバーコンテキストを表すオブジェクト。
        例外:
        IllegalArgumentExceptionSE - 提供されたサーバーコンテキストが実装でサポートされていない場合、またはエンドポイントのバインディングと組み合わせて使用できないことが判明した場合。
        IllegalStateExceptionSE - エンドポイントがすでに公開されているか、停止されている場合。
        SecurityExceptionSE - java.lang.SecurityManger が使用されていて、アプリケーションに WebServicePermission("publishEndpoint") 権限がない場合。
        導入:
        1.7、JAX-WS 2.2

      • stop

        public abstract void stop()
        このエンドポイントの公開を停止します。エンドポイントが公開状態でない場合、この方法は効果がありません。

      • isPublished

        public abstract boolean isPublished()
        エンドポイントが公開状態の場合は true を返します。
        戻り値:
        エンドポイントが公開状態の場合は true。

      • getMetadata

        public abstract ListSE<SourceSE> getMetadata()
        サービスのメタデータドキュメントのリストを返します。
        戻り値:
        List<javax.xml.transform.Source> サービスのメタデータドキュメントのリスト

      • setMetadata

        public abstract void setMetadata​(ListSE<SourceSE> metadata)
        このエンドポイントのメタデータを設定します。
        パラメーター:
        metadata - エンドポイントのメタデータ情報を含む XML ドキュメントソースのリスト (たとえば WSDL または XML スキーマドキュメント)
        例外:
        IllegalStateExceptionSE - エンドポイントがすでに公開されている場合。

      • getExecutor

        public abstract ExecutorSE getExecutor()
        この Endpoint インスタンスのエグゼキュータを返します。エグゼキュータは、受信リクエストを実装オブジェクトにディスパッチするために使用されます。
        戻り値:
        リクエストのディスパッチに使用される java.util.concurrent.Executor。
        関連事項:
        ExecutorSE

      • setExecutor

        public abstract void setExecutor​(ExecutorSE executor)
        この Endpoint インスタンスのエグゼキュータを設定します。エグゼキュータは、受信リクエストを実装オブジェクトにディスパッチするために使用されます。この Endpoint が publish(Object) メソッドを使用して公開され、指定されたサーバーコンテキストが独自のスレッド動作を定義している場合、エグゼキュータは無視される可能性があります。
        パラメーター:
        executor - リクエストのディスパッチに使用される java.util.concurrent.Executor。
        例外:
        SecurityExceptionSE - インスタンスがセキュリティ上の理由でエグゼキュータの設定をサポートしていない場合（たとえば、必要な権限がない場合）。
        関連事項:
        ExecutorSE

      • getProperties

        public abstract MapSE<StringSE,​ObjectSE> getProperties()
        この Endpoint インスタンスのプロパティバッグを返します。
        戻り値:
        Map <String、Object> このインスタンスに関連付けられているプロパティバッグ。

      • setProperties

        public abstract void setProperties​(MapSE<StringSE,​ObjectSE> properties)
        この Endpoint インスタンスのプロパティバッグを設定します。
        パラメーター:
        properties - このインスタンスに関連付けられているプロパティバッグ。

      • getEndpointReference

        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 バインディングを使用する場合。
        導入:
        1.6、JAX-WS 2.1
        関連事項:
        W3CEndpointReference

      • getEndpointReference

        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 バインディングを使用する場合。
        導入:
        1.6、JAX-WS 2.1

      • setEndpointContext

        public void setEndpointContext​(EndpointContext ctxt)
        EndpointContext を設定することにより、Jakarta XML Web Services ランタイムはアプリケーション内の他のエンドポイントのアドレスを認識します。複数のエンドポイントが WSDL の異なるポートを共有している場合、WSDL にアクセスすると、複数のポートアドレスにパッチが適用されます。

        これは、エンドポイントを公開する前に設定する必要があります。

        パラメーター:
        ctxt - 複数のエンドポイントで共有されます
        例外:
        IllegalStateExceptionSE - エンドポイントがすでに公開されているか、停止されている場合。
        導入:
        1.7、JAX-WS 2.2