001/* 002 * (C) Copyright 2006-2009 Nuxeo SA (http://nuxeo.com/) and others. 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 * http://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 * Contributors: 017 * Nuxeo - initial API and implementation 018 * 019 * $Id$ 020 */ 021 022package org.nuxeo.ecm.platform.web.common.requestcontroller.service; 023 024import java.util.Map; 025 026import javax.servlet.FilterConfig; 027import javax.servlet.http.HttpServletRequest; 028 029import com.thetransactioncompany.cors.CORSFilter; 030 031/** 032 * Interface for the service used to manage what {@link HttpServletRequest} must be protected by the Filter. 033 * 034 * @author tiry 035 */ 036public interface RequestControllerManager { 037 038 RequestFilterConfig getConfigForRequest(HttpServletRequest request); 039 040 /** 041 * Get contributed CORS Filter for an HttpServletRequest. 042 * 043 * @return the CORS filter if there is a matching request, otherwise {@code null} 044 * @since 10.1 045 */ 046 CORSFilter getCorsFilterForRequest(HttpServletRequest request); 047 048 /** 049 * Get contributed FilterConfig for an HttpServletRequest. 050 * 051 * @return filter config to init CorsFilter if there is a matching request, null otherwise. 052 * @since 5.7.2 053 * @deprecated since 10.1, unused, use {@link #getCorsFilterForRequest(HttpServletRequest)} instead 054 */ 055 @Deprecated 056 FilterConfig getCorsConfigForRequest(HttpServletRequest request); 057 058 /** 059 * @since 6.0 060 * @return a map with the header names to add to the HTTP response with their values 061 */ 062 Map<String, String> getResponseHeaders(); 063}