パッケージ jakarta.websocket.server

アノテーションインターフェース PathParam


@RetentionSE(RUNTIMESE) @TargetSE(PARAMETERSE) public @interface PathParam
このアノテーションは、ServerEndpoint アノテーションのパスマッピングで URI テンプレートが使用されているサーバーエンドポイントのメソッドパラメーターにアノテーションを付けるために使用できます。メソッドパラメーターは、String 型、Java プリミティブ型、そのボックス化されたバージョンのいずれかです。クライアント URI が URI テンプレートと一致するが、リクエストされたパスパラメーターをデコードできない場合、WebSocket のエラーハンドラーが呼び出されます。

例: -

 
 @ServerEndpoint("/bookings/{guest-id}")
 public class BookingServer {

     @OnMessage
     public void processBookingRequest(@PathParam("guest-id") String guestID, String message, Session session) {
         // process booking from the given guest here
     }
 }
 
 

例: -

 
 @ServerEndpoint("/rewards/{vip-level}")
 public class RewardServer {

     @OnMessage
     public void processReward(@PathParam("vip-level") Integer vipLevel, String message, Session session) {
         // process reward here
     }
 }
 
 
作成者:
dannycoward
  • 必須定数のサマリー

    必須要素
    修飾子と型
    必須要素
    説明
    URI テンプレートで使用される変数の名前。
  • 要素の詳細

    • value

      StringSE value
      URI テンプレートで使用される変数の名前。名前が URI テンプレートのパス変数と一致しない場合、このアノテーションがアノテーションを付けるメソッドパラメーターの値は null です。
      戻り値:
      URI テンプレートで使用される変数の名前。