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;
018
019import org.apache.wicket.protocol.http.ResourceIsolationRequestCycleListener;
020import org.apache.wicket.protocol.ws.api.WebSocketMessageBroadcastHandler;
021import org.apache.wicket.protocol.ws.api.WebSocketRequestHandler;
022import org.apache.wicket.request.IRequestHandler;
023
024/**
025 * A specialization of {@link ResourceIsolationRequestCycleListener} that should be
026 * used when the application uses Web Sockets.
027 *
028 * <p>The HTTP upgrade request brings <em>Origin</em> and/or <em>Fetch Metadata</em>
029 * in its headers, but any Web socket frame doesn't bring it so
030 * {@link WebSocketRequestHandler} and {@link WebSocketMessageBroadcastHandler}
031 * should be ignored.</p>
032 */
033public class WebSocketAwareResourceIsolationRequestCycleListener extends ResourceIsolationRequestCycleListener
034{
035        @Override
036        protected boolean isChecked(IRequestHandler handler)
037        {
038                if (handler instanceof WebSocketRequestHandler || handler instanceof WebSocketMessageBroadcastHandler) {
039                        return false;
040                }
041                return super.isChecked(handler);
042        }
043}