View Javadoc

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.io.IOException;
22  import java.net.URL;
23  import java.util.Collection;
24  
25  import javax.faces.context.ExternalContext;
26  
27  /**
28   * Locate facelet taglib xml files through classpath. These
29   * files has definitions that are used by facelets algorithm to parse view files.
30   * <p>
31   * By default it locate all files inside META-INF folder, ending with .taglib.xml
32   * </p> 
33   * 
34   * @since 2.0.2
35   * @author Leonardo Uribe 
36   */
37  public abstract class FaceletConfigResourceProvider
38  {
39      
40      /**
41       * Return a list of urls pointing to valid facelet taglib xml files. These
42       * files will be parsed later and used by facelets algorithm.
43       * 
44       * @param context
45       * @return
46       */
47      public abstract Collection<URL> getFaceletTagLibConfigurationResources(ExternalContext context) throws IOException;
48  }