1 /*
2 * Copyright 2002-2013 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.sockjs.transport;
18
19 import java.util.Map;
20
21 import org.springframework.web.socket.WebSocketHandler;
22
23 /**
24 * A factory for creating a SockJS session. {@link TransportHandler}s typically also serve
25 * as SockJS session factories.
26 *
27 * @author Rossen Stoyanchev
28 * @since 4.0
29 */
30 public interface SockJsSessionFactory {
31
32 /**
33 * Create a new SockJS session.
34 * @param sessionId the ID of the session
35 * @param handler the underlying {@link WebSocketHandler}
36 * @param attributes handshake request specific attributes
37 * @return a new session, never {@code null}
38 */
39 SockJsSession createSession(String sessionId, WebSocketHandler handler, Map<String, Object> attributes);
40
41 }