View Javadoc
1   /*
2    * Copyright 2002-2014 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.springframework.web.socket.messaging;
18  
19  import org.springframework.messaging.Message;
20  
21  /**
22   * Event raised when a new WebSocket client using a Simple Messaging Protocol
23   * (e.g. STOMP) as the WebSocket sub-protocol issues a connect request.
24   *
25   * <p>Note that this is not the same as the WebSocket session getting established
26   * but rather the client's first attempt to connect within the the sub-protocol,
27   * for example sending the STOMP CONNECT frame.
28   *
29   * @author Rossen Stoyanchev
30   * @since 4.0.3
31   */
32  @SuppressWarnings("serial")
33  public class SessionConnectEvent extends AbstractSubProtocolEvent {
34  
35  	/**
36  	 * Create a new SessionConnectEvent.
37  	 * @param source the component that published the event (never {@code null})
38  	 * @param message the connect message
39  	 */
40  	public SessionConnectEvent(Object source, Message<byte[]> message) {
41  		super(source, message);
42  	}
43  
44  }