Annotation Type PathParam



  • @Retention(RUNTIME)
    @Target(PARAMETER)
    public @interface PathParam
    This annotation may be used to annotate method parameters on server endpoints where a URI-template has been used in the path-mapping of the ServerEndpoint annotation. The method parameter may be of type String, any Java primitive type or any boxed version thereof. If a client URI matches the URI-template, but the requested path parameter cannot be decoded, then the websocket's error handler will be called.

    For example:-

    
     @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
         }
     }
     

    For example:-

    
     @ServerEndpoint("/rewards/{vip-level}")
     public class RewardServer {
     
         @OnMessage
         public void processReward(@PathParam("vip-level") Integer vipLevel, String message, Session session) {
             // process reward here
         }
     }
     
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String value
      The name of the variable used in the URI-template.
    • Element Detail

      • value

        java.lang.String value
        The name of the variable used in the URI-template. If the name does not match a path variable in the URI-template, the value of the method parameter this annotation annotates is null.
        Returns:
        the name of the variable used in the URI-template.