org.springframework.web.socket.server.support.AbstractStandardUpgradeStrategy.java Source code

Introduction

Here is the source code for org.springframework.web.socket.server.support.AbstractStandardUpgradeStrategy.java

Source

/*
 * Copyright 2002-2013 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.web.socket.server.support;

import java.io.IOException;

import javax.websocket.Endpoint;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.adapter.StandardEndpointAdapter;
import org.springframework.web.socket.adapter.StandardWebSocketSessionAdapter;
import org.springframework.web.socket.server.HandshakeFailureException;
import org.springframework.web.socket.server.RequestUpgradeStrategy;

/**
 * A {@link RequestUpgradeStrategy} for containers that support standard Java WebSocket.
 *
 * @author Rossen Stoyanchev
 * @since 4.0
 */
public abstract class AbstractStandardUpgradeStrategy implements RequestUpgradeStrategy {

    protected final Log logger = LogFactory.getLog(getClass());

    private final ServerWebSocketSessionInitializer wsSessionInitializer = new ServerWebSocketSessionInitializer();

    @Override
    public void upgrade(ServerHttpRequest request, ServerHttpResponse response, String protocol,
            WebSocketHandler handler) throws IOException, HandshakeFailureException {

        StandardWebSocketSessionAdapter session = new StandardWebSocketSessionAdapter();
        this.wsSessionInitializer.initialize(request, response, session);
        StandardEndpointAdapter endpoint = new StandardEndpointAdapter(handler, session);
        upgradeInternal(request, response, protocol, endpoint);
    }

    protected abstract void upgradeInternal(ServerHttpRequest request, ServerHttpResponse response,
            String selectedProtocol, Endpoint endpoint) throws IOException, HandshakeFailureException;

}