com.sun.jsftemplating.layout.LayoutDefinitionManager Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://jsftemplating.dev.java.net/cddl1.html or
* jsftemplating/cddl1.txt.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at jsftemplating/cddl1.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
*/
package com.sun.jsftemplating.layout;
import com.sun.jsftemplating.annotation.FormatDefinitionAPFactory;
import com.sun.jsftemplating.annotation.HandlerAPFactory;
import com.sun.jsftemplating.annotation.HandlerInput;
import com.sun.jsftemplating.annotation.UIComponentFactoryAPFactory;
import com.sun.jsftemplating.component.factory.basic.GenericFactory;
import com.sun.jsftemplating.layout.descriptors.ComponentType;
import com.sun.jsftemplating.layout.descriptors.LayoutComponent;
import com.sun.jsftemplating.layout.descriptors.LayoutComposition;
import com.sun.jsftemplating.layout.descriptors.LayoutDefinition;
import com.sun.jsftemplating.layout.descriptors.LayoutElement;
import com.sun.jsftemplating.layout.descriptors.LayoutInsert;
import com.sun.jsftemplating.layout.descriptors.Resource;
import com.sun.jsftemplating.layout.descriptors.handler.HandlerDefinition;
import com.sun.jsftemplating.layout.descriptors.handler.IODescriptor;
import com.sun.jsftemplating.layout.facelets.DbFactory;
import com.sun.jsftemplating.layout.facelets.NSContext;
import com.sun.jsftemplating.layout.template.TemplateLayoutDefinitionManager;
import com.sun.jsftemplating.util.FileUtil;
import com.sun.jsftemplating.util.LogUtil;
import com.sun.jsftemplating.util.Util;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.lang.reflect.InvocationTargetException;
import java.net.JarURLConnection;
import java.net.URL;
import java.net.URLConnection;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.Stack;
import java.util.StringTokenizer;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArrayList;
import javax.faces.context.FacesContext;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
/**
* This abstract class provides the base functionality for all
* LayoutDefinitionManager implementations. It provides a
* static method used to obtain an instance of a concrete
* LayoutDefinitionManager:
* {@link #getLayoutDefinitionManager(FacesContext,String)}. However, in
* most cases is makes the most sense to call the static method:
* {@link #getLayoutDefinition(FacesContext,String)}. This method
* ensures that the cache is checked first before going through the effort
* of finding a LayoutDefinitionManager instance.
*
* This class also provides access to global {@link HandlerDefinition}s,
* {@link Resource}s, and {@link ComponentType}s.
*
* @author Ken Paulsen ([email protected])
*/
public abstract class LayoutDefinitionManager {
/**
* Constructor.
*/
protected LayoutDefinitionManager() {
super();
}
/**
* This method is responsible for finding/creating the requested
* {@link LayoutDefinition}.
*
* @param key The key used to identify the requested
* {@link LayoutDefinition}.
*/
public abstract LayoutDefinition getLayoutDefinition(String key) throws LayoutDefinitionException;
/**
* This method is used to determine if this
* LayoutDefinitionManager should process the given key.
* It does not necessarily mean that the
* LayoutDefinitionManager can process it.
* Parser errors do not necessarily mean that it should not process
* the file. In order to provide meaningful error messages, this
* method should return true if the format of the template matches the
* type that this LayoutDefinitionManager processes. It
* is understood that at times it may not be recognizable; in the case
* where no LayoutDefinitionManagers return
* true from this method, the parent
* ViewHandler will be used, which likely means that it
* will look for a .jsp and give error messages accordingly. Also,
* the existance of a file should not be used as a meassure of success
* as other LayoutDefinitionManagers may be more
* appropriate.
*/
public abstract boolean accepts(String key);
/**
* This method should be used to obtain a {@link LayoutDefinition}.
* It first checks to see if a cached {@link LayoutDefinition}
* already exists, if so it returns it. If one does not already
* exist, it will obtain the appropriate
* LayoutDefinitionManager instance and call
* {@link #getLayoutDefinition} and return the result.
*/
public static LayoutDefinition getLayoutDefinition(FacesContext ctx, String key) throws LayoutDefinitionException {
// Determine the key we should use to cache this
String cacheKey = FileUtil.cleanUpPath(key.startsWith("/") ?
key : FileUtil.getAbsolutePath(ctx, key));
// Check to see if we already have it.
LayoutDefinition def = getCachedLayoutDefinition(ctx, cacheKey);
//System.out.println("GET LD (" + cacheKey + ", " + isDebug(ctx) + "):" + def);
if (def == null) {
// Obtain the correct LDM, and get the LD
def = getLayoutDefinitionManager(ctx, key).getLayoutDefinition(key);
//System.out.println(" Found LD (" + cacheKey + ")?:" + def);
putCachedLayoutDefinition(ctx, cacheKey, def);
} else {
// In the case where we found a cached version,
// ensure we invoke "initPage" handlers
def.dispatchInitPageHandlers(ctx, def);
}
// FIXME: Flag a page as *not found* for performance reasons when JSP is used (or other view technologies)
// Return the LD
return def;
}
/**
* This method finds the (closest) requested
* LayoutComponent for the given clientId.
* If the viewId is not supplied, the current
* UIViewRoot will be used. If an exact match is not
* found, it will return the last {@link LayoutComponent} found while
* walking the tree -- this represents the last {@link LayoutComponent}
* in the hierarchy of the specified component. If nothing matches the
* given clientId, null will be returned.
*
* This is not an easy process since JSF components are not all
* NamingContainers, so the clientId is not
* sufficient to find it. This is unfortunate, but we we deal with
* it.
*
* @param ctx The FacesContext.
* @param ldKey The {@link LayoutDefinition} key to identify the
* {@link LayoutDefinition} tree to be searched.
* @param clientId The component clientId for which to
* obtain a {@link LayoutComponent}.
*/
public static LayoutComponent getLayoutComponent(FacesContext ctx, String ldKey, String clientId) throws LayoutDefinitionException {
// Find the page first...
LayoutElement layElt = null;
if (ldKey != null) {
// FIXME: This fixme probably belongs in getLD(ctx, key): initPage should only be invoked if the page is accessed for the first time on the request. This potentially calls it multiple times.
layElt = getLayoutDefinition(ctx, ldKey);
if (layElt == null) {
throw new LayoutDefinitionException(
"Unable to find LayoutDefinition ('" + ldKey + "')");
}
} else {
layElt = ViewRootUtil.getLayoutDefinition(
FacesContext.getCurrentInstance().getViewRoot());
}
// Save the current LayoutComposition Stack
// - This is needed b/c we may be in the middle of walking the tree
// - already and we need ot use this Stack... so we must save the
// - Stack and use a fresh one. We must restore it later.
Stack oldStack = LayoutComposition.getCompositionStack(ctx);
try {
LayoutComposition.setCompositionStack(
ctx, new Stack());
// Create a StringTokenizer over the clientId
StringTokenizer tok = new StringTokenizer(clientId, ":");
// Walk the LD looking for the individual id's specified in the
// clientId.
String id = null;
LayoutElement match = null;
while (tok.hasMoreTokens()) {
// I don't want to create a bunch of objects to check for
// instanceof NamingContainer. I can't check the class file
// b/c there is no way for me to know what class gets created
// before actually creating the UIComponent. This is because
// either the ComponentFactory can decide how to create the
// UIComponent, which it often uses the Application. The
// Application is driven off the faces-config.xml file(s).
//
// I will instead do a brute force search for a match. This
// has the potential to fail if non-naming containers have the
// same id's as naming containers. It may also fail for
// components with dynamic id's.
id = tok.nextToken();
match = findById(ctx, layElt, id);
if (match == null) {
// Can't go any further! We're as close as we're getting.
break;
}
layElt = match;
}
} finally {
// Restore the previous LayoutComposition Stack
LayoutComposition.setCompositionStack(ctx, oldStack);
}
// Make sure we're not still at the LayoutDefinition, if so do NOT
// accept this as a match.
if (layElt instanceof LayoutDefinition) {
layElt = null;
}
// Return the closest match (or null if nothing found)
return (LayoutComponent) layElt;
}
/**
* This method performs a breadth-first search for a child
* {@link LayoutComponent} with the given id of the given
* {@link LayoutElement} (elt). It will return null if
* none of the children (or children's children, etc.) equal the given
* id.
*/
private static LayoutComponent findById(FacesContext ctx, LayoutElement elt, String id) {
boolean shouldPop = false;
// Check for special LE's
if (elt instanceof LayoutComposition) {
// We have a LayoutComposition, this includes another file... we
// need to look there as well.
String viewId = ((LayoutComposition) elt).getTemplate();
if (viewId != null) {
// Add LayoutComposition to the stack
LayoutComposition.push(ctx, elt);
shouldPop = true;
// Get the new LD to walk
try {
elt = LayoutDefinitionManager.getLayoutDefinition(ctx, viewId);
} catch (LayoutDefinitionException ex) {
if (((LayoutComposition) elt).isRequired()) {
throw ex;
}
}
}
} else if (elt instanceof LayoutInsert) {
// We found a LayoutInsert, this includes content from a previous
// file... we need to go back there and look now.
}
// First search the direct child LayoutElement
LayoutComponent comp = null;
for (LayoutElement child : elt.getChildLayoutElements()) {
// I am *NOT* providing the parent UIComponent as it may not be
// available, this function is *not* guaranteed to work for
// dynamic ids
if (child.getId(ctx, null).equals(id)
&& (child instanceof LayoutComponent)) {
// Found it!
comp = (LayoutComponent) child;
}
}
// Not found directly under it, search children...
// NOTE: Must do a breadth first search, so 2 loops are necessary
if (comp == null) {
for (LayoutElement child : elt.getChildLayoutElements()) {
comp = findById(ctx, child, id);
if (comp != null) {
// Found it!
break;
}
}
}
// Remove the LayoutComposition from the stack
if (shouldPop) {
LayoutComposition.pop(ctx);
}
// Return the result, or null if not found
return comp;
}
/**
* This method obtains the LayoutDefinitionManager that
* is able to process the given key.
*
* This implementation uses the ExternalContext's
* initParams to look for the LayoutDefinitionManager
* class. If it exists, the specified concrete
* LayoutDefinitionManager class will be used as the
* "default" (i.e. the first LayoutDefinitionManager
* checked). "{@link #LAYOUT_DEFINITION_MANAGER_KEY}" is the
* initParam key.
*
* The key is used to test if desired
* LayoutDefinitionManager is able to read the requested
* {@link LayoutDefinition}.
*
* @param ctx The FacesContext.
* @param key The desired {@link LayoutDefinition}.
* @see #LAYOUT_DEFINITION_MANAGER_KEY
*/
public static LayoutDefinitionManager getLayoutDefinitionManager(FacesContext ctx, String key) throws LayoutDefinitionException {
List ldms = getLayoutDefinitionManagers(ctx);
//System.out.println("LDMS: " + ldms);
LayoutDefinitionManager mgr = null;
for (String className : ldms) {
mgr = getLayoutDefinitionManagerByClass(ctx, className);
//System.out.println("LDM ("+className+"): " + mgr);
if (mgr.accepts(key)) {
//System.out.println("Accepts!");
return mgr;
}
}
throw new LayoutDefinitionException("No LayoutDefinitionManager "
+ "available for '" + key + "'. This may mean the file cannot "
+ "be found, or is unrecognizable.");
}
/**
* This method is responsible for returning a List of
* known LayoutDefinitionManager instances. Each value
* of the list is a String representing the classname of
* a LayoutDefinitionManager implementation.
*/
public static List getLayoutDefinitionManagers(FacesContext ctx) {
if (ctx == null) {
ctx = FacesContext.getCurrentInstance();
}
List keys = null;
if (ctx != null) {
keys = (List) ctx.getExternalContext().
getApplicationMap().get(LDM_KEYS);
}
if (keys == null) {
// 1st time... initialize it
keys = new ArrayList();
// Check to see what the default should be...
if (ctx != null) {
Map initParams = ctx.getExternalContext().getInitParameterMap();
if (initParams.containsKey(LAYOUT_DEFINITION_MANAGER_KEY)) {
keys.add(((String) initParams.
get(LAYOUT_DEFINITION_MANAGER_KEY)).trim());
}
}
// Make "template" format the default (if none specified)
String tplFormat = TemplateLayoutDefinitionManager.class.getName();
if (!keys.contains(tplFormat)) {
keys.add(tplFormat);
}
try {
// Get all the files that define them
BufferedReader rdr = null;
InputStream is = null;
String line = null;
Enumeration urls = Util.getClassLoader(ctx).
getResources(FormatDefinitionAPFactory.FACTORY_FILE);
while (urls.hasMoreElements()) {
// Add all lines in each file to the list of LDMs
try {
is = urls.nextElement().openStream();
rdr = new BufferedReader(new InputStreamReader(is));
for (line = rdr.readLine(); line != null; line = rdr.readLine()) {
line = line.trim();
if (line.equals("") || line.startsWith("#")) {
// Skip comments
continue;
}
if (keys.contains(line)) {
// Skip ones already added...
continue;
}
// Add it!
keys.add(line);
}
} finally {
Util.closeStream(is);
}
}
} catch (IOException ex) {
throw new RuntimeException(ex);
}
if (ctx != null) {
// Save the result in Application Scope
ctx.getExternalContext().getApplicationMap().
put(LDM_KEYS, keys);
}
}
// Return the LDM keys
return keys;
}
/**
* This method is a singleton factory method for obtaining an instance
* of a LayoutDefintionManager. It is possible that
* multiple different implementations of
* LayoutDefinitionManagers will be used within the same
* application. This is OK. Someone may provide a different
* LayoutDefinitionManager to locate
* {@link LayoutDefinition}'s in a different way (XML, database, file,
* java code, new file format, etc.).
*/
public static LayoutDefinitionManager getLayoutDefinitionManagerByClass(FacesContext ctx, String className) {
if (ctx == null) {
ctx = FacesContext.getCurrentInstance();
}
Map ldms = null;
if (ctx != null) {
ldms = (Map)
ctx.getExternalContext().getApplicationMap().get(LDMS);
}
if (ldms == null) {
ldms = new HashMap(4);
if (ctx != null) {
ctx.getExternalContext().getApplicationMap().put(LDMS, ldms);
}
}
LayoutDefinitionManager ldm = ldms.get(className);
if (ldm == null) {
try {
ldm = (LayoutDefinitionManager)
Util.loadClass(className, className).
getMethod("getInstance", (Class[]) null).
invoke((Object) null, (Object[]) null);
} catch (ClassNotFoundException ex) {
throw new LayoutDefinitionException(
"Unable to find LDM: '" + className + "'.", ex);
} catch (NoSuchMethodException ex) {
throw new LayoutDefinitionException("LDM '" + className
+ "' does not have a 'getInstance()' method!", ex);
} catch (IllegalAccessException ex) {
throw new LayoutDefinitionException("Unable to access LDM: '"
+ className + "'!", ex);
} catch (InvocationTargetException ex) {
throw new LayoutDefinitionException("Error while attempting "
+ "to get LDM: '" + className + "'!", ex);
} catch (ClassCastException ex) {
throw new LayoutDefinitionException("LDM '" + className
+ "' must extend from '"
+ LayoutDefinitionManager.class.getName() + " and must "
+ "be loaded from the same ClassLoader!", ex);
} catch (NullPointerException ex) {
throw new LayoutDefinitionException(ex);
}
ldms.put(className, ldm);
}
return ldm;
}
/**
* This method may be used to obtain a cached
* {@link LayoutDefinition}. If it has not been cached, this method
* returns null.
*
* @param ctx The FacesContext.
* @param key Key for the cached {@link LayoutDefinition} to obtain.
*
* @return The {@link LayoutDefinition} or null.
*/
private static LayoutDefinition getCachedLayoutDefinition(FacesContext ctx, String key) {
if (ctx == null) {
ctx = FacesContext.getCurrentInstance();
}
if (isDebug(ctx)) {
if (ctx != null) {
// Make sure we cache during the life of the request, even
// in Debug mode
return (LayoutDefinition) ctx.getExternalContext().
getRequestMap().get(CACHE_PREFIX + key);
}
// Disable caching for debug mode
return null;
}
return getLayoutDefinitionMap(ctx).get(key);
}
/**
* This method returns the LD Map which is stored in application
* scope. If it has not been created yet, it will be created as a
* ConcurrentHashMap
.
*/
private static Map getLayoutDefinitionMap(FacesContext ctx) {
if (ctx == null) {
ctx = FacesContext.getCurrentInstance();
}
Map ldMap = null;
if (ctx != null) {
ldMap = (Map)
ctx.getExternalContext().getApplicationMap().get(LD_MAP);
}
if (ldMap == null) {
// 1st time... initialize it
// Consider using a SoftReference here...
ldMap = new ConcurrentHashMap(
400, 0.75f, 2);
if (ctx != null) {
ctx.getExternalContext().getApplicationMap().put(LD_MAP, ldMap);
}
}
// Return the map...
return ldMap;
}
/**
* In general, this method should be used by sub-classes to store a
* cached {@link LayoutDefinition}. It may also be used, however, to
* define {@link LayoutDefinition}s on the fly (not recommended unless
* you know what you're doing. ;)
*
* @param ctx The FacesContext.
* @param key The {@link LayoutDefinition} key to cache.
* @param value The {@link LayoutDefinition} to cache.
*/
public static void putCachedLayoutDefinition(FacesContext ctx, String key, LayoutDefinition value) {
//System.out.println("CACHING LD: " + key);
if (isDebug(ctx)) {
if (ctx != null) {
// Make sure we cache during the life of the request, even
// in Debug mode
ctx.getExternalContext().getRequestMap().
put(CACHE_PREFIX + key, value);
}
} else {
getLayoutDefinitionMap(ctx).put(key, value);
}
}
/**
* Retrieve an attribute by key.
*
* @param key The key used to retrieve the attribute.
*
* @return The requested attribute or null
*/
public Object getAttribute(String key) {
return _attributes.get(key);
}
/**
* Associate the given key with the given Object as an attribute.
*
* @param key The key associated with the given object (if this key
* is already in use, it will replace the previously set
* attribute object).
* @param value The Object to store.
*/
public void setAttribute(String key, Object value) {
_attributes.put(key, value);
}
/**
* This method returns the Map of global
* {@link ComponentType}s (the {@link ComponentType}s available across
* the application).
*
* It is recommended that this method not be used directly. The map
* returned by this method is shared across the application and is not
* thread safe. Instead access this Map via
* {@link LayoutDefinitionManager#getGlobalComponentType(FacesContext, String)}.
*
* This method will initialize the global {@link ComponentType}s if
* they are not initialized. It does this by finding all files in the
* classpath named:
* {@link UIComponentFactoryAPFactory#FACTORY_FILE}. It then reads
* each of these files (which must be Properties files)
* and stores each identifier / fully qualified classname as an entry
* in the Map<String, {@link ComponentType}>.
*
* @param ctx The FacesContext.
*/
public static Map getGlobalComponentTypes(FacesContext ctx) {
if (ctx == null) {
ctx = FacesContext.getCurrentInstance();
}
Map types = null;
if (ctx != null) {
types = (Map) ctx.getExternalContext().
getApplicationMap().get(CT_MAP);
}
if (types == null) {
// We haven't initialized the global ComponentTypes yet...
types = new ConcurrentHashMap(200, 0.75f, 2);
try {
Properties props = null;
URL url = null;
String id = null;
// Get all the properties files that define them
Enumeration urls =
Util.getClassLoader(types).
getResources(UIComponentFactoryAPFactory.FACTORY_FILE);
while (urls.hasMoreElements()) {
url = urls.nextElement();
props = new Properties();
// Load each Properties file
InputStream is = null;
try {
is = url.openStream();
props.load(is);
for (Map.Entry entry : props.entrySet()) {
// Add each property entry (key, ComponentType)
id = (String) entry.getKey();
types.put(id, new ComponentType(id, (String) entry.getValue()));
}
} finally {
Util.closeStream(is);
}
}
readComponentsFromTaglibXml(types);
} catch (IOException ex) {
throw new RuntimeException(ex);
}
// Save it for next time...
if (ctx != null) {
ctx.getExternalContext().getApplicationMap().put(CT_MAP, types);
}
}
// Return all the global ComponentTypes
return types;
}
private static void readComponentsFromTaglibXml(Map types) throws IOException {
Enumeration urls = Util.getClassLoader(types).getResources("META-INF/");
Set files = new HashSet();
while (urls.hasMoreElements()) {
URL url = urls.nextElement();
URLConnection conn = url.openConnection();
conn.setUseCaches(false);
conn.setDefaultUseCaches(false);
if (conn instanceof JarURLConnection) {
JarURLConnection jarConn = (JarURLConnection) conn;
JarFile jarFile = jarConn.getJarFile();
Enumeration entries = jarFile.entries();
while (entries.hasMoreElements()) {
JarEntry entry = entries.nextElement();
String entryName = entry.getName();
if (entryName.startsWith("META-INF") && entryName.endsWith("taglib.xml")) {
Enumeration e = Util.getClassLoader(types).getResources(entryName);
while (e.hasMoreElements()) {
files.add(e.nextElement());
}
}
}
} else {
// TODO: I have yet to hit this branch
// File dir = new File(url.getFile());
// String fileList[] = dir.list(new FilenameFilter() {
// public boolean accept(File file, String fileName) {
// return fileName.endsWith("taglib.xml");
// } });
}
}
if(files.size() >0) {
for (URL url : files) {
processTaglibXml(url, types);
}
}
}
private static void processTaglibXml(URL url, Map types) {
InputStream is = null;
try {
is = url.openStream();
DocumentBuilder builder = DbFactory.getInstance();
Document document = builder.parse(is);
XPath xpath = XPathFactory.newInstance().newXPath();
NSContext ns = new NSContext();
ns.addNamespace("f", "http://java.sun.com/JSF/Facelet");
// Although the following should work, XPath doesn't attempt to
// get the namespace when no namespace is supplied.
//ns.setDefaultNSURI("http://java.sun.com/JSF/Facelet");
xpath.setNamespaceContext(ns);
String nameSpace = xpath.evaluate("/f:facelet-taglib/f:namespace", document);
// Process elements
NodeList nl = (NodeList) xpath.evaluate("/f:facelet-taglib/f:tag", document, XPathConstants.NODESET);
for (int i = 0; i < nl.getLength(); i++) {
Node node = nl.item(i);
String tagName = xpath.evaluate("f:tag-name", node);
String componentType = xpath.evaluate("f:component/f:component-type", node);
String id = nameSpace + ":" + tagName;
types.put(id,
new ComponentType(id, GenericFactory.class.getName(), componentType));
}
} catch (Exception e) {
if (LogUtil.severeEnabled()) {
LogUtil.severe(e.getMessage());
}
throw new RuntimeException(e);
} finally {
Util.closeStream(is);
}
}
/**
* This method retrieves a globally defined {@link ComponentType} (a
* {@link ComponentType} available across the application).
*/
public static ComponentType getGlobalComponentType(FacesContext ctx, String typeID) {
return getGlobalComponentTypes(ctx).get(typeID);
}
/**
* This method allows a global {@link ComponentType} to be added.
* This way of adding a global {@link ComponentType} is discouraged.
* Instead, you should use a UIComponentFactory
* annotation in each ComponentFactory and compile
* using "apt".
*/
public static void addGlobalComponentType(FacesContext ctx, ComponentType type) {
getGlobalComponentTypes(ctx).put(type.getId(), type);
}
/**
* This method clears the cached global {@link ComponentType}s.
*/
public static void clearGlobalComponentTypes(FacesContext ctx) {
if (ctx == null) {
ctx = FacesContext.getCurrentInstance();
}
if (ctx != null) {
ctx.getExternalContext().getApplicationMap().remove(CT_MAP);
}
}
/**
* This method returns the Map of global
* {@link HandlerDefinition}s (the {@link HandlerDefinition}s
* available across the application).
*
* It is recommended that this method not be used. The map returned
* by this method is shared across the application and is not thread
* safe. Instead get values from the Map via:
* {@link LayoutDefinitionManager#getGlobalHandlerDefinition(String)}.
*
*
* This method will initialize the global {@link HandlerDefinition}s if
* they are not initialized. It does this by finding all files in the
* classpath named: {@link HandlerAPFactory#HANDLER_FILE}. It then
* reads each file (which must be a valid Properties
* file) and stores the information for later retrieval.
*/
public static Map getGlobalHandlerDefinitions() {
return getGlobalHandlerDefinitions(HandlerAPFactory.HANDLER_FILE);
}
/**
* This method is the same as {@link #getGlobalHandlerDefinitions()},
* however, it accepts the full name of the Handler.map
* to use. This allows different filenames to be used. It will only
* read the same filename one time, however, it will read
* all occurances of that file name (it calls
* ClassLoader.getResources(filename)
*/
public synchronized static Map getGlobalHandlerDefinitions(String filename) {
Map handlers = getApplicationHandlerDefinitions(null);
if (handlers.containsKey(filename)) {
// We've already done this, return the answer
return handlers;
}
// Copy the old ones while we modify it...
handlers = new HashMap(handlers);
// Add the 'filename' key as a flag that we've processed these
handlers.put(filename, NOOP_HD);
Properties props = null;
URL url = null;
try {
// Get all the properties files that define them
Enumeration urls = Util.getClassLoader(filename).
getResources(filename);
InputStream is = null;
while (urls.hasMoreElements()) {
try {
url = urls.nextElement();
props = new Properties();
// Load each Properties file
is = url.openStream();
props.load(is);
for (Map.Entry entry : props.entrySet()) {
if (((String) entry.getKey()).endsWith(".class")) {
// We will only process .class entries.
readGlobalHandlerDefinition(handlers,
(Map) props, entry);
}
}
} finally {
Util.closeStream(is);
}
}
} catch (IOException ex) {
throw new RuntimeException(ex);
}
// Store the results in application scope...
FacesContext ctx = FacesContext.getCurrentInstance();
ctx.getExternalContext().getApplicationMap().put(HD_MAP, handlers);
// return the complete Map
return handlers;
}
/**
* This method returns the current application's
* {@link HandlerDefinition} Map.
*/
private static Map getApplicationHandlerDefinitions(FacesContext ctx) {
if (ctx == null) {
ctx = FacesContext.getCurrentInstance();
}
Map map = null;
if (ctx != null) {
map = (Map) ctx.getExternalContext().
getApplicationMap().get(HD_MAP);
}
if (map == null) {
// Initialize it...
map = new HashMap();
if (ctx != null) {
ctx.getExternalContext().getApplicationMap().put(HD_MAP, map);
}
}
return map;
}
/**
* This method processes a single {@link HandlerDefinition}'s
* meta-data.
*/
private static void readGlobalHandlerDefinition(Map hdMap, Map props, Map.Entry entry) {
// Get the key.class value...
String key = (String) entry.getKey();
// Strip off .class
key = key.substring(0, key.lastIndexOf('.'));
// Create a new HandlerDefinition
HandlerDefinition def = new HandlerDefinition(key);
// Set the class / method
String value = props.get(key + '.' + "method");
def.setHandlerMethod((String) entry.getValue(), value);
// Read the input defs
def.setInputDefs(readIODefs(props, key, true));
// Read the output defs
def.setOutputDefs(readIODefs(props, key, false));
// Add the Handler...
hdMap.put(key, def);
}
/**
* This method reads and creates IODescriptors for the given key.
*/
private static Map readIODefs(Map map, String key, boolean input) {
String type;
String inOrOut = input ? "input" : "output";
int count = 0;
IODescriptor desc = null;
Map defs = new HashMap(5);
String value = map.get(key + "." + inOrOut + "[" + count + "].name");
while (value != null) {
// Get the type
type = map.get(key + "." + inOrOut + "[" + count + "].type");
if (type == null) {
type = DEFAULT_TYPE;
}
// Create an IODescriptor
desc = new IODescriptor(value, type);
defs.put(value, desc);
// If this is an output, we're done... for input we need to do more
if (input) {
// required?
value = map.get(key + "." + inOrOut + "[" + count + "].required");
if ((value != null) && Boolean.valueOf(value).booleanValue()) {
desc.setRequired(true);
}
// default?
value = map.get(key + "." + inOrOut + "[" + count + "].defaultValue");
if ((value != null) && !value.equals(HandlerInput.DEFAULT_DEFAULT_VALUE)) {
desc.setDefault(value);
}
}
// Look for next IO declaration
value = map.get(key + "." + inOrOut + "[" + (++count) + "].name");
}
return defs;
}
/**
* This method retrieves a globally defined {@link HandlerDefinition} (a
* {@link HandlerDefinition} available across the application).
*/
public static HandlerDefinition getGlobalHandlerDefinition(String id) {
return getGlobalHandlerDefinitions().get(id);
}
/**
* This method allows a global {@link HandlerDefinition} to be added.
* This way of adding a global {@link HandlerDefinition} is
* discouraged. It should be done implicitly through annotations,
* placement of a properties file in the correct location, or
* explicitly by declaring it the page (some template formats may not
* support this).
*
* @see LayoutDefinitionManager#getGlobalHandlerDefinitions()
*/
public static void addGlobalHandlerDefinition(HandlerDefinition def) {
synchronized (LayoutDefinitionManager.class) {
getGlobalHandlerDefinitions().put(def.getId(), def);
}
}
/**
* This method clears cached global application
* {@link HandlerDefinition}s.
*/
public static void clearGlobalHandlerDefinitions(FacesContext ctx) {
if (ctx == null) {
ctx = FacesContext.getCurrentInstance();
}
if (ctx != null) {
ctx.getExternalContext().getApplicationMap().remove(HD_MAP);
}
}
/**
* This method provides a means to add an additional global
* {@link Resource} (a {@link Resource} that is available across the
* application). It is recommended that this not be done using this
* method, but instead by registering the global {@link Resource}.
* This can be done by... FIXME: TBD...
*/
public static void addGlobalResource(Resource res) {
getGlobalResources(null).add(res);
}
/**
* This method returns a List of global
* {@link Resource}s. The List returned should not be
* changed, it is the actual internal List that is shared
* across the application and it is not thread safe.
*
* This method will find global resources by... FIXME: TBD...
*/
public static List getGlobalResources(FacesContext ctx) {
// FIXME: TBD...
if (ctx == null) {
ctx = FacesContext.getCurrentInstance();
}
List globalResources = null;
if (ctx != null) {
globalResources = (List) ctx.getExternalContext().
getApplicationMap().get(RES_MAP);
}
if (globalResources == null) {
globalResources = new CopyOnWriteArrayList();
// FIXME: Find / Initialize resources...
if (ctx != null) {
ctx.getExternalContext().getApplicationMap().
put(RES_MAP, globalResources);
}
}
// Return the Resources List
return globalResources;
}
/**
* This method clears the cached global {@link Resource}s.
*/
public static void clearGlobalResources(FacesContext ctx) {
if (ctx == null) {
ctx = FacesContext.getCurrentInstance();
}
if (ctx != null) {
ctx.getExternalContext().getApplicationMap().remove(RES_MAP);
}
}
/**
* Getter for the debug flag. This version of this method invokes
* the isDebug(FacesContext) method.
*/
public static boolean isDebug() {
return isDebug(null);
}
/**
* Returns true if this application is running in debug-mode. Note,
* because this method may be called during initialization before
* it is able to properly deterimine if this flag has been set, it
* will not cache its determination if it does not find an explicit
* setting for this flag. This means you should always set this flag
* for best performance since not setting it will force it to be
* calculated on every request for this value.
*
* A ServletContext initialization paramter by the
* name of {@link #DEBUG_FLAG}
* ("com.sun.jsftemplating.DEBUG") is the recommended means
* of setting this flag.
*/
public static boolean isDebug(FacesContext ctx) {
// Check Application Scope First...
if (ctx == null) {
ctx = FacesContext.getCurrentInstance();
}
Object objVal = null;
if (ctx != null) {
objVal = (Boolean) ctx.getExternalContext().
getApplicationMap().get(DEBUG_FLAG);
if (objVal != null) {
return (Boolean) objVal;
}
}
// Not found... next check for a system property...
String flag = System.getProperty(DEBUG_FLAG);
if (flag == null) {
if (ctx != null) {
flag = ctx.getExternalContext().getInitParameter(DEBUG_FLAG);
}
}
// Figure out what we have and save it if explicitly set...
boolean isDebug = false;
if ((ctx != null) && (flag != null)) {
// The environment may not be fully initialized, we don't want it
// to cache the value we may have incorrectly discovered... so only
// cache if found if explicitly found.
//
// Save it in application scope for easier resolution later...
isDebug = Boolean.parseBoolean(flag);
ctx.getExternalContext().getApplicationMap().
put(DEBUG_FLAG, isDebug);
}
// Return the flag value...
return isDebug;
}
/**
* Setter for the debug flag. Sets {@link #DEBUG_FLAG} equal to
* flag in application scope.
*/
public static void setDebug(FacesContext ctx, boolean flag) {
ctx.getExternalContext().getApplicationMap().
put(DEBUG_FLAG, flag);
}
/**
* This key stores the {@link HandlerDefinition}'s for this
* application.
*/
private static final String HD_MAP = "__jsft_HandlerDefs";
/**
* This key stores the {@link LayoutDefinitionManager} instances for
* this application.
*/
private static final String LDMS = "__jsft_LayoutDefMgrs";
/**
* This key stores the {@link LayoutDefinitionManager} class names
* for this application.
*/
private static final String LDM_KEYS = "__jsft_LayoutDefMgrKeys";
/**
* This key stores the {@link LayoutDefinition} instances for this
* application.
*/
private static final String LD_MAP = "__jsft_LayoutDefMap";
/**
* This key stores the {@link ComponentType} instances for this
* application.
*/
private static final String CT_MAP = "__jsft_ComponentTypeMap";
/**
* This key stores the global {@link Resource} instances for this
* application.
*/
private static final String RES_MAP = "__jsft_ResourceMap";
/**
* This map contains sub-class specific attributes that may be needed
* by specific implementations of
* LayoutDefinitionManagers. For example, setting an
* EntityResolver on a
* LayoutDefinitionManager that creates
* LayoutDefinitions from XML files.
*/
private Map _attributes = new HashMap();
/**
* This Map holds global {@link ComponentType}s so they
* can be defined once and shared across the application.
*/
private static Map _globalComponentTypes = null;
private static final HandlerDefinition NOOP_HD =
new HandlerDefinition("_NOOP_");
/**
* This is the default input and output type.
*/
public static final String DEFAULT_TYPE = "Object";
/**
* This constant defines the LayoutDefinitionManager
* implementation key for initParams.
* ("LayoutDefinitionManagerImpl")
*/
public static final String LAYOUT_DEFINITION_MANAGER_KEY =
"LayoutDefinitionManagerImpl";
/**
* This is the name of the initParameter or JVM variable used to set
* the DEBUG flag.
*/
public static final String DEBUG_FLAG = "com.sun.jsftemplating.DEBUG";
/**
* This is the prefix of a request-scoped variable that caches
* {@link LayoutDefinition}s.
*/
public static final String CACHE_PREFIX = "_LDCache";
}