com.sun.webui.jsf.theme.JSFThemeContext Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007-2018 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://oss.oracle.com/licenses/CDDL+GPL-1.1
* or 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 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.
*/
/*
* $Id: JSFThemeContext.java,v 1.1.6.1 2009-12-29 04:57:17 jyeary Exp $
*/
package com.sun.webui.jsf.theme;
import java.beans.Beans;
import java.net.URL;
import java.util.Map;
import javax.faces.context.FacesContext;
import com.sun.webui.jsf.util.ClassLoaderFinder;
import com.sun.webui.theme.ServletThemeContext;
import com.sun.webui.theme.ThemeContext;
/**
* JSFThemeContext encapsulates the theme JSF runtime
* environment. It is different from other potential runtime environments
* in that JSF encapsulates runtime contexts in a FacesContext.
* This context could encapsulate a servlet context or a portlet context.
* As such application information affecting a theme may be obtained
* differently. This class encapsulates that behavior.
*/
public class JSFThemeContext extends ServletThemeContext {
/**
* An object to synchronize with.
*/
private static Object synchObj = new Object();
/**
* Construction is controlled by getInstance.
*/
protected JSFThemeContext(FacesContext context) {
super(context.getExternalContext().getInitParameterMap());
}
// Note that since a ThemeServlet MUST be defined then
// getInstance should never have to create a ThemeContext instance.
//
/**
* Return an instance of ThemeContext creating one
* if necessary and persisting it in the ApplicationMap.
*/
public static ThemeContext getInstance(FacesContext context) {
// Does it make sense call a "super.getInstance()" ?
//
// In a servlet environment the JSF ApplicationMap is the
// ServletContext and entires in the map are references by
// ServletContext.{get/set}Attribute().
// But a PortletContext is not a direct descendant of
// ServletContext and there is not "interface compatible".
//
// We need synchronization here because there is one
// ThemeContext per application servlet.
//
Map map = context.getExternalContext().getApplicationMap();
ThemeContext themeContext = (ThemeContext) map.get(THEME_CONTEXT);
if (themeContext == null) {
//FIXME synchronization on a non-final field.
synchronized (synchObj) {
// try again in case another thread created it.
//
themeContext = (ThemeContext) map.get(THEME_CONTEXT);
if (themeContext == null) {
themeContext = new JSFThemeContext(context);
map.put(THEME_CONTEXT, themeContext);
}
}
}
// It's not clear if this is necessary. Since this is a
// JSFThemeContext, it would not be unreasonable to just
// call "FacesContext.getCurrentInstance()" whenever
// a value from that context is required like the
// request context path, or referenced when calling
// "ThemeContext.getResourcePath()".
//
//String path = context.getExternalContext().getRequestContextPath();
//themeContext.setRequestContextPath(path);
return themeContext;
}
/**
* Return the default ClassLoader using ClassLoaderFinder.
* ClassLoaderFinder encapsulates Creator requirements.
*/
@Override
public ClassLoader getDefaultClassLoader() {
return ClassLoaderFinder.getCurrentLoader(JSFThemeContext.class);
}
/**
* This implementation is a no-op. See ClassLoaderFinder.
*/
@Override
public void setDefaultClassLoader(ClassLoader classLoader) {
}
/**
* This implementation always returns
* FacesContext.getCurrentInstance().getExternalContext().getRequestContextPath().
* This depends on the implementation of
* {@link com.sun.webui.theme.ThemeContext#getResourcePath()}
*/
@Override
public String getRequestContextPath() {
return FacesContext.getCurrentInstance().getExternalContext().
getRequestContextPath();
}
/**
* This implementation is a no-op.
* @see #getRequestContextPath()
*/
@Override
public void setRequestContextPath(String path) {
}
/**
* Return an appropriate resource path within this theme context.
* Use is Beans.isDesignTime to prevent ThemeServlet prefix from
* being appended. Creator handles doing the right thing with
* getRequestContextPath()
*/
@Override
public String getResourcePath(String path) {
String resourcePath = path;
if (Beans.isDesignTime()) {
ClassLoader cl = getDefaultClassLoader();
URL url = cl.getResource(path);
if (url != null) {
resourcePath = url.toExternalForm();
}
} else if (path != null) {
FacesContext context = FacesContext.getCurrentInstance();
String servletContext = getThemeServletContext();
StringBuilder sb = new StringBuilder(128);
// Just to make sure
//
if (!servletContext.startsWith("/")) {
sb.append("/");
}
sb.append(servletContext);
if (!path.startsWith("/") && !servletContext.endsWith("/")) {
sb.append("/");
}
sb.append(path);
resourcePath = context.getApplication().getViewHandler().
getResourceURL(context, sb.toString());
}
return resourcePath;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy