com.sun.faces.config.processor.RenderKitConfigProcessor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of javax.faces Show documentation
Show all versions of javax.faces Show documentation
This is the master POM file for Oracle's Implementation of the JSF 2.2 Specification.
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.faces.config.processor;
import com.sun.faces.util.FacesLogger;
import com.sun.faces.util.MessageUtils;
import com.sun.faces.config.ConfigurationException;
import com.sun.faces.config.DocumentInfo;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.w3c.dom.Element;
import javax.faces.FactoryFinder;
import javax.faces.render.ClientBehaviorRenderer;
import javax.faces.render.RenderKit;
import javax.faces.render.RenderKitFactory;
import javax.faces.render.Renderer;
import javax.faces.render.FacesRenderer;
import javax.faces.render.FacesBehaviorRenderer;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.util.LinkedHashMap;
import java.text.MessageFormat;
import javax.faces.context.FacesContext;
import javax.servlet.ServletContext;
/**
*
* This ConfigProcessor
handles all elements defined under
* /faces-config/render-kit
.
*
*/
public class RenderKitConfigProcessor extends AbstractConfigProcessor {
private static final Logger LOGGER = FacesLogger.CONFIG.getLogger();
/**
* /faces-config/render-kit
*/
private static final String RENDERKIT = "render-kit";
/**
* /faces-config/render-kit/render-kit-id
*/
private static final String RENDERKIT_ID = "render-kit-id";
/**
* /faces-config/render-kit/render-kit-class
*/
private static final String RENDERKIT_CLASS = "render-kit-class";
/**
* /faces-config/render-kit/renderer
*/
private static final String RENDERER = "renderer";
/**
* /faces-config/render-kit/renderer/component-family
*/
private static final String RENDERER_FAMILY = "component-family";
/**
* /faces-config/render-kit/renderer/renderer-type
*/
private static final String RENDERER_TYPE = "renderer-type";
/**
* /faces-config/render-kit/renderer/renderer-class
*/
private static final String RENDERER_CLASS = "renderer-class";
/**
* /faces-config/render-kit/client-behavior-renderer
*/
private static final String CLIENT_BEHAVIOR_RENDERER = "client-behavior-renderer";
/**
* /faces-config/render-kit/client-behavior-renderer/client-behavior-renderer-type
*/
private static final String CLIENT_BEHAVIOR_RENDERER_TYPE = "client-behavior-renderer-type";
/**
* /faces-config/render-kit/client-behavior-renderer/client-behavior-renderer-class
*/
private static final String CLIENT_BEHAVIOR_RENDERER_CLASS = "client-behavior-renderer-class";
// -------------------------------------------- Methods from ConfigProcessor
/**
* @see ConfigProcessor#process(javax.servlet.ServletContext,com.sun.faces.config.DocumentInfo[])
*/
public void process(ServletContext sc, DocumentInfo[] documentInfos)
throws Exception {
Map>> renderers =
new LinkedHashMap>>();
Map>> behaviorRenderers =
new LinkedHashMap>>();
RenderKitFactory rkf = (RenderKitFactory)
FactoryFinder.getFactory(FactoryFinder.RENDER_KIT_FACTORY);
for (int i = 0; i < documentInfos.length; i++) {
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.log(Level.FINE,
MessageFormat.format(
"Processing render-kit elements for document: ''{0}''",
documentInfos[i].getSourceURI()));
}
Document document = documentInfos[i].getDocument();
String namespace = document.getDocumentElement()
.getNamespaceURI();
NodeList renderkits = document.getDocumentElement()
.getElementsByTagNameNS(namespace, RENDERKIT);
if (renderkits != null && renderkits.getLength() > 0) {
addRenderKits(sc, renderkits, document, renderers, behaviorRenderers, rkf);
}
}
// process annotated Renderers, ClientBehaviorRenderers first as Renderers configured
// via config files take precedence
processAnnotations(FacesRenderer.class);
processAnnotations(FacesBehaviorRenderer.class);
// now add the accumulated renderers to the RenderKits
for (Map.Entry>> entry : renderers.entrySet()) {
RenderKit rk = rkf.getRenderKit(null, entry.getKey());
if (rk == null) {
throw new ConfigurationException(
MessageUtils.getExceptionMessageString(
MessageUtils.RENDERER_CANNOT_BE_REGISTERED_ID,
entry.getKey()));
}
for (Map.Entry> renderEntry : entry.getValue().entrySet()) {
addRenderers(sc, rk, renderEntry.getKey(), renderEntry.getValue());
}
}
// now add the accumulated behavior renderers to the RenderKits
for (Map.Entry>> entry : behaviorRenderers.entrySet()) {
RenderKit rk = rkf.getRenderKit(null, entry.getKey());
if (rk == null) {
throw new ConfigurationException(
MessageUtils.getExceptionMessageString(
MessageUtils.RENDERER_CANNOT_BE_REGISTERED_ID,
entry.getKey()));
}
for (Map.Entry> renderEntry : entry.getValue().entrySet()) {
addClientBehaviorRenderers(sc, rk, renderEntry.getKey(), renderEntry.getValue());
}
}
invokeNext(sc, documentInfos);
}
// --------------------------------------------------------- Private Methods
private void addRenderKits(ServletContext sc, NodeList renderKits,
Document owningDocument,
Map>> renderers,
Map>> behaviorRenderers,
RenderKitFactory rkf) {
String namespace = owningDocument.getDocumentElement()
.getNamespaceURI();
for (int i = 0, size = renderKits.getLength(); i < size; i++) {
Node renderKit = renderKits.item(i);
NodeList children = ((Element) renderKit)
.getElementsByTagNameNS(namespace, "*");
String rkId = null;
String rkClass = null;
List renderersList =
new ArrayList(children.getLength());
List behaviorRenderersList =
new ArrayList(children.getLength());
for (int c = 0, csize = children.getLength(); c < csize; c++) {
Node n = children.item(c);
if (RENDERKIT_ID.equals(n.getLocalName())) {
rkId = getNodeText(n);
} else if (RENDERKIT_CLASS.equals(n.getLocalName())) {
rkClass = getNodeText(n);
} else if (RENDERER.equals(n.getLocalName())) {
renderersList.add(n);
} else if (CLIENT_BEHAVIOR_RENDERER.equals(n.getLocalName())) {
behaviorRenderersList.add(n);
}
}
rkId = ((rkId == null)
? RenderKitFactory.HTML_BASIC_RENDER_KIT
: rkId);
if (rkClass != null) {
RenderKit previous = rkf.getRenderKit(FacesContext.getCurrentInstance(),
rkId);
RenderKit rk = (RenderKit) createInstance(sc, rkClass,
RenderKit.class,
previous,
renderKit);
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.log(Level.FINE,
MessageFormat.format(
"Calling RenderKitFactory.addRenderKit({0}, {1})",
rkId,
rkClass));
}
rkf.addRenderKit(rkId, rk);
}
Map> existingRenderers = renderers.get(rkId);
if (existingRenderers != null) {
List list = existingRenderers.get(owningDocument);
if (list != null) {
list.addAll(renderersList);
} else {
existingRenderers.put(owningDocument, renderersList);
}
} else {
existingRenderers = new LinkedHashMap>();
existingRenderers.put(owningDocument, renderersList);
}
renderers.put(rkId, existingRenderers);
Map> existingBehaviorRenderers = behaviorRenderers.get(rkId);
if (existingBehaviorRenderers != null) {
List list = existingBehaviorRenderers.get(owningDocument);
if (list != null) {
list.addAll(behaviorRenderersList);
} else {
existingBehaviorRenderers.put(owningDocument, behaviorRenderersList);
}
} else {
existingBehaviorRenderers = new LinkedHashMap>();
existingBehaviorRenderers.put(owningDocument, behaviorRenderersList);
}
behaviorRenderers.put(rkId, existingBehaviorRenderers);
}
}
private void addRenderers(ServletContext sc, RenderKit renderKit,
Document owningDocument,
List renderers) {
String namespace = owningDocument.getDocumentElement()
.getNamespaceURI();
for (Node renderer : renderers) {
NodeList children = ((Element) renderer)
.getElementsByTagNameNS(namespace, "*");
String rendererFamily = null;
String rendererType = null;
String rendererClass = null;
for (int i = 0, size = children.getLength(); i < size; i++) {
Node n = children.item(i);
if (RENDERER_FAMILY.equals(n.getLocalName())) {
rendererFamily = getNodeText(n);
} else if (RENDERER_TYPE.equals(n.getLocalName())) {
rendererType = getNodeText(n);
} else if (RENDERER_CLASS.equals(n.getLocalName())) {
rendererClass = getNodeText(n);
}
}
if ((rendererFamily != null)
&& (rendererType != null)
&& (rendererClass != null)) {
Renderer r = (Renderer) createInstance(sc, rendererClass,
Renderer.class,
null,
renderer);
if (r != null) {
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.log(Level.FINE,
MessageFormat.format(
"Calling RenderKit.addRenderer({0},{1}, {2}) for RenderKit ''{3}''",
rendererFamily,
rendererType,
rendererClass,
renderKit.getClass()));
}
renderKit.addRenderer(rendererFamily, rendererType, r);
}
}
}
}
private void addClientBehaviorRenderers(ServletContext sc, RenderKit renderKit,
Document owningDocument,
List behaviorRenderers) {
String namespace = owningDocument.getDocumentElement()
.getNamespaceURI();
for (Node behaviorRenderer : behaviorRenderers) {
NodeList children = ((Element) behaviorRenderer)
.getElementsByTagNameNS(namespace, "*");
String behaviorRendererType = null;
String behaviorRendererClass = null;
for (int i = 0, size = children.getLength(); i < size; i++) {
Node n = children.item(i);
if (CLIENT_BEHAVIOR_RENDERER_TYPE.equals(n.getLocalName())) {
behaviorRendererType = getNodeText(n);
} else if (CLIENT_BEHAVIOR_RENDERER_CLASS.equals(n.getLocalName())) {
behaviorRendererClass = getNodeText(n);
}
}
if ((behaviorRendererType != null)
&& (behaviorRendererClass != null)) {
ClientBehaviorRenderer r = (ClientBehaviorRenderer) createInstance(sc, behaviorRendererClass,
ClientBehaviorRenderer.class,
null,
behaviorRenderer);
if (r != null) {
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.log(Level.FINE,
MessageFormat.format(
"Calling RenderKit.addClientBehaviorRenderer({0},{1}, {2}) for RenderKit ''{2}''",
behaviorRendererType,
behaviorRendererClass,
renderKit.getClass()));
}
renderKit.addClientBehaviorRenderer(behaviorRendererType, r);
}
}
}
}
}