001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.protocol.ws.api;
018
019import org.apache.wicket.protocol.http.servlet.ServletWebRequest;
020import org.apache.wicket.request.http.WebRequest;
021
022import javax.servlet.http.HttpServletRequest;
023
024/**
025 * A {@link WebRequest} implementation used for the lifecycle of a web socket
026 * connection. It keeps a copy of the HttpServletRequest provided by the web container
027 * during the creation of the web socket connection (the http upgrade).
028 *
029 * @since 6.0
030 */
031public class WebSocketRequest extends ServletWebRequest
032{
033        /**
034         * Constructor.
035         *
036         * @param req
037         *      the copy of the HttpServletRequest used for the upgrade of the HTTP protocol
038         */
039        public WebSocketRequest(HttpServletRequest req, String filterPrefix)
040        {
041                super(req, filterPrefix);
042        }
043
044        @Override
045        public boolean isAjax()
046        {
047                return true;
048        }
049}