TestMu Conference is Back! Future of Testing + AIHow to use SessionEnricherHandshakeInterceptor class of com.consol.citrus.websocket.interceptor package
Best Citrus code snippet using com.consol.citrus.websocket.interceptor.SessionEnricherHandshakeInterceptor
Source:CitrusWebSocketDispatcherServlet.java 
...18import com.consol.citrus.http.servlet.CitrusDispatcherServlet;19import com.consol.citrus.websocket.endpoint.WebSocketEndpoint;20import com.consol.citrus.websocket.handler.CitrusWebSocketHandler;21import com.consol.citrus.websocket.handler.WebSocketUrlHandlerMapping;22import com.consol.citrus.websocket.interceptor.SessionEnricherHandshakeInterceptor;23import com.consol.citrus.websocket.server.WebSocketServer;24import org.springframework.context.ApplicationContext;25import org.springframework.util.CollectionUtils;26import org.springframework.web.socket.server.HandshakeHandler;27import org.springframework.web.socket.server.support.DefaultHandshakeHandler;28import org.springframework.web.socket.server.support.WebSocketHttpRequestHandler;29import java.util.*;30/**31 * Citrus dispatcher servlet extends Spring's message dispatcher servlet and just32 * adds optional configuration settings for default mapping strategies and so on.33 *34 * @author Christoph Deppisch35 * @since 1.436 */37public class CitrusWebSocketDispatcherServlet extends CitrusDispatcherServlet {38 /** Http server hosting the servlet */39 private WebSocketServer webSocketServer;40 /** Default bean names used in default configuration for supporting WebSocket endpoints */41 protected static final String URL_HANDLER_MAPPING_BEAN_NAME = "citrusUrlHandlerMapping";42 private static final String HANDSHAKE_HANDLER_BEAN_NAME = "citrusHandshakeHandler";43 /**44 * Default constructor using http server instance that45 * holds this servlet.46 * @param webSocketServer47 */48 public CitrusWebSocketDispatcherServlet(WebSocketServer webSocketServer) {49 super(webSocketServer);50 this.webSocketServer = webSocketServer;51 }52 @Override53 protected void initStrategies(ApplicationContext context) {54 super.initStrategies(context);55 configureWebSockerHandler(context);56 }57 private void configureWebSockerHandler(ApplicationContext context) {58 List<WebSocketEndpoint> webSocketEndpoints = webSocketServer.getWebSockets();59 if (CollectionUtils.isEmpty(webSocketEndpoints)) {60 return;61 }62 if (context.containsBean(URL_HANDLER_MAPPING_BEAN_NAME)) {63 WebSocketUrlHandlerMapping urlHandlerMapping = context.getBean(URL_HANDLER_MAPPING_BEAN_NAME, WebSocketUrlHandlerMapping.class);64 HandshakeHandler handshakeHandler = new DefaultHandshakeHandler();65 if (context.containsBean(HANDSHAKE_HANDLER_BEAN_NAME)) {66 handshakeHandler = context.getBean(HANDSHAKE_HANDLER_BEAN_NAME, HandshakeHandler.class);67 }68 Map<String, Object> wsHandlers = new HashMap<>();69 for (WebSocketEndpoint webSocketEndpoint : webSocketEndpoints) {70 String wsPath = webSocketEndpoint.getEndpointConfiguration().getEndpointUri();71 CitrusWebSocketHandler handler = new CitrusWebSocketHandler();72 webSocketEndpoint.setWebSocketHandler(handler);73 WebSocketHttpRequestHandler wsRequestHandler = new WebSocketHttpRequestHandler(handler, handshakeHandler);74 SessionEnricherHandshakeInterceptor handshakeInterceptor = new SessionEnricherHandshakeInterceptor(webSocketEndpoint.getName(), wsPath);75 wsRequestHandler.getHandshakeInterceptors().add(handshakeInterceptor);76 wsHandlers.put(wsPath, wsRequestHandler);77 }78 urlHandlerMapping.setUrlMap(wsHandlers);79 urlHandlerMapping.postRegisterUrlHandlers(wsHandlers);80 } else {81 throw new CitrusRuntimeException(String.format("Invalid WebSocket configuration - missing bean. Expected to find bean with name '%s' in Spring application context", URL_HANDLER_MAPPING_BEAN_NAME));82 }83 }84}...
Source:SessionEnricherHandshakeInterceptor.java
...27 *28 * @author Martin Maher29 * @since 2.330 */31public class SessionEnricherHandshakeInterceptor implements HandshakeInterceptor {32 /** Id and path of web socket */33 private String wsId;34 private String wsPath;35 /**36 * Default constructor initializing fields.37 * @param wsId38 * @param wsPath39 */40 public SessionEnricherHandshakeInterceptor(String wsId, String wsPath) {41 this.wsId = wsId;42 this.wsPath = wsPath;43 }44 @Override45 public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String, Object> attributes) throws Exception {46 if (request instanceof ServletServerHttpRequest) {47 attributes.put(WebSocketMessageHeaders.WEB_SOCKET_ID, wsId);48 attributes.put(WebSocketMessageHeaders.WEB_SOCKET_PATH, wsPath);49 }50 return true;51 }52 @Override53 public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception exception) {54 }...
SessionEnricherHandshakeInterceptor
Using AI Code Generation
1public ServerEndpointExporter serverEndpointExporter() {2 ServerEndpointExporter serverEndpointExporter = new ServerEndpointExporter();3 serverEndpointExporter.setHandshakeInterceptors(Collections.singletonList(new SessionEnricherHandshakeInterceptor()));4 return serverEndpointExporter;5}6public WebSocketClient webSocketClient() {7 return CitrusEndpoints.websocket().client()8 .autoStart(true)9 .build();10}11public WebSocketServer webSocketServer() {12 return CitrusEndpoints.websocket().server()13 .port(8080)14 .autoStart(true)15 .build();16}17public WebSocketEndpoint webSocketEndpoint() {18 return CitrusEndpoints.websocket().endpoint()19 .client(webSocketClient())20 .server(webSocketServer())21 .build();22}23public EchoEndpoint echoEndpoint() {24 return new EchoEndpoint();25}26public EchoEndpointConfigurator echoEndpointConfigurator() {27 return new EchoEndpointConfigurator();28}29public EchoEndpointServer echoEndpointServer() {30 return new EchoEndpointServer();31}32public EchoEndpointServerConfigurator echoEndpointServerConfigurator() {33 return new EchoEndpointServerConfigurator();34}35public EchoEndpointClient echoEndpointClient() {36 return new EchoEndpointClient();37}38public EchoEndpointClientConfigurator echoEndpointClientConfigurator() {39 return new EchoEndpointClientConfigurator();40}41public EchoEndpointClientServer echoEndpointClientServer() {42 return new EchoEndpointClientServer();43}
SessionEnricherHandshakeInterceptor
Using AI Code Generation
1import com.consol.citrus.dsl.endpoint.CitrusEndpoints;2import com.consol.citrus.endpoint.websocket.client.WebSocketClient;3import com.consol.citrus.websocket.interceptor.SessionEnricherHandshakeInterceptor;4import org.springframework.web.socket.client.WebSocketClient;5import org.springframework.web.socket.client.standard.StandardWebSocketClient;6import org.springframework.web.socket.sockjs.client.SockJsClient;7import java.util.ArrayList;8import java.util.List;9public class WebSocketClientConfig {10 public WebSocketClient webSocketClient() {11 List<org.springframework.web.socket.client.WebSocketClient> webSocketClients = new ArrayList<>();12 webSocketClients.add(new StandardWebSocketClient());13 return new SockJsClient(webSocketClients);14 }15 public WebSocketClient webSocketClient2() {16 List<org.springframework.web.socket.client.WebSocketClient> webSocketClients = new ArrayList<>();17 webSocketClients.add(new StandardWebSocketClient());18 return new SockJsClient(webSocketClients);19 }20 public WebSocketClient webSocketClient3() {21 List<org.springframework.web.socket.client.WebSocketClient> webSocketClients = new ArrayList<>();22 webSocketClients.add(new StandardWebSocketClient());23 return new SockJsClient(webSocketClients);24 }25 public WebSocketClient webSocketClient4() {26 List<org.springframework.web.socket.client.WebSocketClient> webSocketClients = new ArrayList<>();27 webSocketClients.add(new StandardWebSocketClient());28 return new SockJsClient(webSocketClients);29 }30 public WebSocketClient webSocketClient5() {31 List<org.springframework.web.socket.client.WebSocketClient> webSocketClients = new ArrayList<>();32 webSocketClients.add(new StandardWebSocketClient());33 return new SockJsClient(webSocketClients);34 }35 public WebSocketClient webSocketClient6() {36 List<org.springframework.web.socket.client.WebSocketClient> webSocketClients = new ArrayList<>();37 webSocketClients.add(new StandardWebSocketClient());38 return new SockJsClient(webSocketClients);39 }40 public WebSocketClient webSocketClient7() {41 List<org.springframework.web.socket.client.WebSocketClient> webSocketClients = new ArrayList<>();42 webSocketClients.add(new StandardWebSocketClient());43 return new SockJsClient(webSocketClients);44 }45 public WebSocketClient webSocketClient8() {
SessionEnricherHandshakeInterceptor
Using AI Code Generation
1import com.consol.citrus.websocket.interceptor.SessionEnricherHandshakeInterceptor;2import com.consol.citrus.websocket.server.WebSocketServer;3import org.springframework.web.socket.WebSocketHandler;4import org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor;5import java.util.ArrayList;6import java.util.List;7public class WebsocketServer {8 public static void main(String[] args) {9 WebSocketServer server = new WebSocketServer();10 server.setPort(8080);11 server.setPath("/websocket");12 server.setHandler(new WebSocketHandler() {});13 List<HttpSessionHandshakeInterceptor> interceptors = new ArrayList<>();14 interceptors.add(new SessionEnricherHandshakeInterceptor());15 server.start();16 }17}18import com.consol.citrus.websocket.interceptor.SessionEnricherHandshakeInterceptor;19import com.consol.citrus.websocket.server.WebSocketServer;20import org.springframework.web.socket.WebSocketHandler;21import org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor;22import java.util.ArrayList;23import java.util.List;24public class WebsocketServer {25 public static void main(String[] args) {26 WebSocketServer server = new WebSocketServer();27 server.setPort(8080);28 server.setPath("/websocket");29 server.setHandler(new WebSocketHandler() {});30 List<HttpSessionHandshakeInterceptor> interceptors = new ArrayList<>();31 interceptors.add(new SessionEnricherHandshakeInterceptor());32 server.start();33 }34}35import com.consol.citrus.websocket.interceptor.SessionEnricherHandshakeInterceptor;36import com.consol.citrus.websocket.server.WebSocketServer;37import org.springframework.web.socket.WebSocketHandler;38import org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor;39import java.util.ArrayList;40import java.util.List;41public class WebsocketServer {42 public static void main(String[] args) {43 WebSocketServer server = new WebSocketServer();44 server.setPort(8080);45 server.setPath("/websocket");46 server.setHandler(new WebSocketHandler() {});
SessionEnricherHandshakeInterceptor
Using AI Code Generation
1package com.consol.citrus.websocket.interceptor;2import java.util.Map;3import java.util.Set;4import org.springframework.web.socket.WebSocketSession;5import org.springframework.web.socket.server.HandshakeInterceptor;6import com.consol.citrus.Citrus;7import com.consol.citrus.context.TestContext;8import com.consol.citrus.exceptions.CitrusRuntimeException;9public class SessionEnricherHandshakeInterceptor implements HandshakeInterceptor {10 private final Map<String, String> headers;11 public SessionEnricherHandshakeInterceptor(Map<String, String> headers) {12 this.headers = headers;13 }14 public boolean beforeHandshake(org.springframework.http.server.ServerHttpRequest request,15 Map<String, Object> attributes) throws Exception {16 return true;17 }18 public void afterHandshake(org.springframework.http.server.ServerHttpRequest request,19 org.springframework.web.socket.WebSocketHandler wsHandler, Exception exception) {20 }21 public void afterHandshake(WebSocketSession session, org.springframework.web.socket.WebSocketHandler wsHandler,22 Exception exception) {23 TestContext context = Citrus.getCitrusContext().getReferenceResolver().resolve("citrus", TestContext.class);24 if (context == null) {25 throw new CitrusRuntimeException("Unable to find Citrus test context - please make sure you have a Citrus bean in your Spring application context");26 }27 Set<String> keySet = headers.keySet();28 for (String key : keySet) {29 session.getAttributes().put(key, context.replaceDynamicContentInString(headers.get(key)));30 }31 }32}33package com.consol.citrus.websocket.interceptor;34import java.util.HashMap;35import java.util.Map;36import org.springframework.web.socket.WebSocketHandler;37import org.springframework.web.socket.server.support.DefaultHandshakeHandler;38import com.consol.citrus.Citrus;39import com.consol.citrus
SessionEnricherHandshakeInterceptor
Using AI Code Generation
1public class 3.java extends TestNGCitrusTestDesigner {2 public void configure() {3 websocket().client()4 .autoStart(true)5 .interceptor(new SessionEnricherHandshakeInterceptor())6 .interceptor(new MyHandshakeInterceptor())7 .connect();8 send("Hello World!");9 receive("Hello World!");10 }11}12public class 4.java extends TestNGCitrusTestDesigner {13 public void configure() {14 websocket().client()15 .autoStart(true)16 .interceptor(new CustomHandshakeInterceptor())17 .connect();18 send("Hello World!");19 receive("Hello World!");20 }21}22public class 5.java extends TestNGCitrusTestDesigner {23 public void configure() {24 websocket().client()25 .autoStart(true)26 .interceptor(new CustomWebSocketClientInterceptor())27 .connect();28 send("Hello World!");29 receive("Hello World!");30 }31}32public class 6.java extends TestNGCitrusTestDesigner {33 public void configure() {34 websocket().client()35 .autoStart(true)36 .interceptor(new CustomWebSocketClientInterceptor())37 .connect();38 send("Hello World!");39 receive("Hello World!");40 }41}42public class 7.java extends TestNGCitrusTestDesigner {43 public void configure() {44 websocket().client()45 .autoStart(true)46 .interceptor(new CustomWebSocketSessionDecorator())47 .connect();48 send("
SessionEnricherHandshakeInterceptor
Using AI Code Generation
1public WebSocketClient webSocketClient() {2 return CitrusEndpoints.webSocketClient()3 .interceptor(new SessionEnricherHandshakeInterceptor())4 .build();5}6public WebSocketClient webSocketClient() {7 return CitrusEndpoints.webSocketClient()8 .interceptor(new SessionEnricherHandshakeInterceptor(Collections.singletonMap("user", "citrus")))9 .build();10}11public WebSocketClient webSocketClient() {12 Map<String, Object> attributes = new HashMap<>();13 attributes.put("user", "citrus");14 attributes.put("password", "12345");15 return CitrusEndpoints.webSocketClient()16 .interceptor(new SessionEnricherHandshakeInterceptor(attributes))17 .build();18}
SessionEnricherHandshakeInterceptor
Using AI Code Generation
1import com.consol.citrus.endpoint.websocket.WebSocketClient;2import com.consol.citrus.endpoint.websocket.WebSocketClientBuilder;3import com.consol.citrus.endpoint.websocket.WebSocketEndpointConfiguration;4import com.consol.citrus.endpoint.websocket.WebSocketMessage;5import com.consol.citrus.endpoint.websocket.WebSocketMessageConverter;6import com.consol.citrus.endpoint.websocket.WebSocketMessageConverterConfiguration;7import com.consol.citrus.endpoint.websocket.client.WebSocketClientBuilderSupport;8import com.consol.citrus.endpoint.websocket.client.WebSocketClientConfiguration;9import com.consol.citrus.endpoint.websocket.interceptor.SessionEnricherHandshakeInterceptor;10import com.consol.citrus.message.DefaultMessage;11import org.springframework.web.socket.client.standard.StandardWebSocketClient;12import org.springframework.web.socket.messaging.WebSocketStompClient;13public class WebSocketClientTest {14public static void main(String[] args) {15WebSocketClientConfiguration clientConfiguration = new WebSocketClientConfiguration();16clientConfiguration.setEndpoint("echo");17clientConfiguration.setSubprotocol("v10.stomp");18WebSocketClientBuilder clientBuilder = new WebSocketClientBuilder();19clientBuilder.setClientConfiguration(clientConfiguration);20WebSocketClient client = clientBuilder.build();21WebSocketEndpointConfiguration endpointConfiguration = new WebSocketEndpointConfiguration();22endpointConfiguration.setEndpoint("echo");23endpointConfiguration.setSubprotocol("v10.stomp");24WebSocketMessageConverterConfiguration messageConverterConfiguration = new WebSocketMessageConverterConfiguration();25endpointConfiguration.setMessageConverterConfiguration(messageConverterConfiguration);26WebSocketMessageConverter messageConverter = new WebSocketMessageConverter(endpointConfiguration);27WebSocketClientBuilderSupport clientBuilderSupport = new WebSocketClientBuilderSupport();28clientBuilderSupport.setClient(client);29clientBuilderSupport.setMessageConverter(messageConverter);
Automation Testing Tutorials
Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.
LambdaTest Learning Hubs:
- JUnit Tutorial
- TestNG Tutorial
- Webdriver Tutorial
- WebDriverIO Tutorial
- Protractor Tutorial
- Selenium 4 Tutorial
- Jenkins Tutorial
- NUnit Tutorial
- Jest Tutorial
- Playwright Tutorial
- Cypress Tutorial
- PyTest Tutorial
YouTube
You could also refer to video tutorials over LambdaTest YouTube channel to get step by step demonstration from industry experts.
Run Citrus automation tests on LambdaTest cloud grid
Perform automation testing on 3000+ real desktop and mobile devices online.
Most used methods in SessionEnricherHandshakeInterceptor
Try LambdaTest Now !!
Get 100 minutes of automation test minutes FREE!!
Was this article helpful?
