001/*
002 * Copyright 2002-2019 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.sockjs.transport.handler;
018
019import java.util.Map;
020
021import org.springframework.http.MediaType;
022import org.springframework.http.server.ServerHttpRequest;
023import org.springframework.web.socket.WebSocketHandler;
024import org.springframework.web.socket.sockjs.frame.DefaultSockJsFrameFormat;
025import org.springframework.web.socket.sockjs.frame.SockJsFrameFormat;
026import org.springframework.web.socket.sockjs.transport.SockJsSession;
027import org.springframework.web.socket.sockjs.transport.TransportHandler;
028import org.springframework.web.socket.sockjs.transport.TransportType;
029import org.springframework.web.socket.sockjs.transport.session.PollingSockJsSession;
030
031/**
032 * A {@link TransportHandler} based on XHR (long) polling.
033 *
034 * @author Rossen Stoyanchev
035 * @since 4.0
036 */
037public class XhrPollingTransportHandler extends AbstractHttpSendingTransportHandler {
038
039        @Override
040        public TransportType getTransportType() {
041                return TransportType.XHR;
042        }
043
044        @Override
045        protected MediaType getContentType() {
046                return new MediaType("application", "javascript", UTF8_CHARSET);
047        }
048
049        @Override
050        protected SockJsFrameFormat getFrameFormat(ServerHttpRequest request) {
051                return new DefaultSockJsFrameFormat("%s\n");
052        }
053
054        @Override
055        public boolean checkSessionType(SockJsSession session) {
056                return (session instanceof PollingSockJsSession);
057        }
058
059        @Override
060        public PollingSockJsSession createSession(
061                        String sessionId, WebSocketHandler handler, Map<String, Object> attributes) {
062
063                return new PollingSockJsSession(sessionId, getServiceConfig(), handler, attributes);
064        }
065
066}