Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
FacesConfigurationMerger |
|
| 1.0;1 |
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 org.apache.myfaces.config.element.FacesConfigData; | |
22 | ||
23 | import javax.faces.context.ExternalContext; | |
24 | ||
25 | /** | |
26 | * SPI that uses the FacesConfigurationProvider-SPI to get all FacesConfig data | |
27 | * and then it combines it into one FacesConfigData instance. For this merging | |
28 | * process the ordering and sorting rules of the JSF spec must be applied. | |
29 | * | |
30 | * With this SPI it is possible to store the result of the complex ordering and | |
31 | * sorting algorithm in order to skip it if no configuration changes are applied | |
32 | * upon redeploy. | |
33 | * | |
34 | * Implementations of this SPI can take advantage of the decorator pattern in | |
35 | * order to use the default SPI-impl. | |
36 | * | |
37 | * @author Jakob Korherr | |
38 | * @since 2.0.3 | |
39 | */ | |
40 | 0 | public abstract class FacesConfigurationMerger |
41 | { | |
42 | ||
43 | /** | |
44 | * Returns an object that collect all config information used by MyFaces | |
45 | * to initialize the web application. | |
46 | * | |
47 | * @param ectx | |
48 | * @return | |
49 | */ | |
50 | public abstract FacesConfigData getFacesConfigData(ExternalContext ectx); | |
51 | ||
52 | } |