1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 package org.apache.myfaces.spi; 20 21 import java.util.List; 22 23 import javax.faces.context.ExternalContext; 24 25 /** 26 * SPI to provide a custom WebConfigProvider implementation. 27 * 28 * @author Leonardo Uribe 29 * @since 2.0.3 30 */ 31 public abstract class WebConfigProvider 32 { 33 34 /** 35 * Return the mappings configured on web.xml related to JSF FacesServlet. 36 * <p> 37 * By default, the algorithm contemplate these three options: 38 * </p> 39 * <ol> 40 * <li>Mappings related to registered servlet class javax.faces.webapp.FacesServlet.</li> 41 * <li>Mappings related to registered servlet class implementing 42 * org.apache.myfaces.shared.webapp.webxml.DelegatedFacesServlet interface.</li> 43 * <li>Mappings related to registered servlet class registered 44 * using org.apache.myfaces.DELEGATE_FACES_SERVLET web config param.</li> 45 * </ol> 46 * 47 * @param externalContext 48 * @return 49 */ 50 public abstract List<ServletMapping> getFacesServletMappings(ExternalContext externalContext); 51 52 /** 53 * Indicate if an error page is configured on web.xml file 54 * 55 * @param externalContext 56 * @return 57 */ 58 public abstract boolean isErrorPagePresent(ExternalContext externalContext); 59 60 }