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 javax.servlet.http.HttpServletRequest;
020
021/**
022 * Common interface for rejecting connections which are not meeting some of the security concerns.
023 * One example might be when the connection 'Origin' header does not match the origin of the
024 * application host
025 *
026 * @see WebSocketConnectionFilterCollection
027 * @author Gergely Nagy
028 */
029@FunctionalInterface
030public interface IWebSocketConnectionFilter {
031
032    /**
033     * Method for rejecting connections based on the current request
034     *
035     * @param servletRequest
036     *            The servlet request holding the request headers
037     */
038    ConnectionRejected doFilter(HttpServletRequest servletRequest);
039}