javax.websocket.server

Annotation Type PathParam


  • @Retention(value=RUNTIME)
     @Target(value=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
         }
     }
     
    Author:
    dannycoward
    • Element Detail

      • value

        public abstract 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.

Traduction non disponible

Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.

Version en cache

07/10/2025 04:09:17 Cette version de la page est en cache (à la date du 07/10/2025 04:09:17) afin d'accélérer le traitement.
Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.

Document créé le 11/06/2005, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/websocket/server/PathParam.html

L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.

Références

  1. Consulter le document html Langue du document :fr Manuel PHP : https://docs.oracle.com/en/java/, Annotation Type PathParam

Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.