-
@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 theServerEndpoint
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 isnull
.- Returns:
- the name of the variable used in the URI-template.
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/websocket/server/pathparam.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.