public abstract class Endpoint
extends ObjectSE

Web ソケットエンドポイントは、WebSocket 会話を処理できるオブジェクトを表します。開発者は、プログラムによる WebSocket エンドポイントを実装するために、このクラスを継承できます。Endpoint クラスは、WebSocket のオープン、エラー、クローズのイベントをインターセプトするためにオーバーライドできるライフサイクルメソッドを保持します。onOpen メソッドを実装することで、プログラムエンドポイントは Session オブジェクトにアクセスできます。開発者は、MessageHandler 実装を追加して、受信 WebSocket メッセージをインターセプトすることができます。WebSocket エンドポイントの各インスタンスは、アクティブな接続ごとに一度に複数のスレッドによって呼び出されないことが保証されています。

クライアントエンドポイントとしてデプロイされた場合、サーバーへの単一接続のために 1 回インスタンス化されます。

サーバーエンドポイントとしてデプロイされると、実装は javax.websocket.server.ServerEndpointConfig.Configurator#getEndpointInstance メソッドを使用して、新しいクライアント接続ごとに使用するエンドポイントインスタンスを取得します。開発者がデフォルトの javax.websocket.server.ServerEndpointConfig.Configurator を使用する場合、アクティブなクライアント接続ごとに正確に 1 つのエンドポイントインスタンスが存在します。この典型的なケースでは、Endpoint のメソッドを実装 / オーバーライドするときに、開発者は各エンドポイントインスタンスを一度に呼び出すスレッドが最大で 1 つあることが保証されます。

たとえば、複数のクライアント接続に単一のエンドポイントインスタンスを使用するなど、エンドポイントインスタンス作成のデフォルトポリシーを上書きするカスタム javax.websocket.server.ServerEndpointConfig.Configurator を開発者が提供する場合、開発者は同時に実行できるコードを記述する必要がある場合があります。

これは、受信テキストメッセージを送信者にエコーバックする単純なエンドポイントの例です。

 
 public class EchoServer extends Endpoint {

     public void onOpen(Session session, EndpointConfig config) {
         final RemoteEndpoint remote = session.getBasicRemote();
         session.addMessageHandler(String.class, new MessageHandler.Whole<String<() {
             public void onMessage(String text) {
                 try {
                     remote.sendString("Got your message (" + text + "). Thanks !");
                 } catch (IOException ioe) {
                     // handle send failure here
                 }
             }
         });
     }

 }