001/*
002 * Copyright 2002-2014 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.web.socket.messaging;
018
019import java.security.Principal;
020
021import org.springframework.lang.Nullable;
022import org.springframework.messaging.Message;
023
024/**
025 * Event raised when a new WebSocket client using a Simple Messaging Protocol
026 * (e.g. STOMP) as the WebSocket sub-protocol issues a connect request.
027 *
028 * <p>Note that this is not the same as the WebSocket session getting established
029 * but rather the client's first attempt to connect within the sub-protocol,
030 * for example sending the STOMP CONNECT frame.
031 *
032 * @author Rossen Stoyanchev
033 * @since 4.0.3
034 */
035@SuppressWarnings("serial")
036public class SessionConnectEvent extends AbstractSubProtocolEvent {
037
038        /**
039         * Create a new SessionConnectEvent.
040         * @param source the component that published the event (never {@code null})
041         * @param message the connect message
042         */
043        public SessionConnectEvent(Object source, Message<byte[]> message) {
044                super(source, message);
045        }
046
047        public SessionConnectEvent(Object source, Message<byte[]> message, @Nullable Principal user) {
048                super(source, message, user);
049        }
050
051}