All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.faces.el.ResourceELResolver Maven / Gradle / Ivy

/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package com.sun.faces.el;

import java.beans.FeatureDescriptor;
import java.util.Iterator;
import java.util.Map;

import com.sun.faces.util.MessageUtils;
import com.sun.faces.util.Util;

import jakarta.el.ELContext;
import jakarta.el.ELException;
import jakarta.el.ELResolver;
import jakarta.el.PropertyNotFoundException;
import jakarta.faces.application.Resource;
import jakarta.faces.application.ResourceHandler;
import jakarta.faces.component.UIComponent;
import jakarta.faces.context.ExternalContext;
import jakarta.faces.context.FacesContext;

/**
 * ELResolver to resolve expressions like the following:
 * 
    *
  • #{resource['library:resource']}
  • *
  • #{resource['resource']} *
*/ public class ResourceELResolver extends ELResolver { // ------------------------------------------------- Methods from ELResolver /** * If base and property are not null and base is an instance of {@link ResourceHandler}, perform the * following: *
    *
  • If property doesn't contain : treat property as the resource name and pass * property to {@link ResourceHandler#createResource(String)}
  • *
  • If property contains a single : treat the content before the : as the * library name, and the content after the : to be the resource name and pass both to * {@link jakarta.faces.application.ResourceHandler#createResource(String, String)}
  • *
  • If property contains more than one : then throw a ELException
  • *
  • If one of the above steps resulted in the creation of a {@link Resource} instance, call * ELContext.setPropertyResolved(true) and return the result of * {@link jakarta.faces.application.Resource#getRequestPath()}
  • *
* * @see ELResolver#getValue(jakarta.el.ELContext, Object, Object) */ @Override public Object getValue(ELContext context, Object base, Object property) { if (base == null && property == null) { String message = MessageUtils.getExceptionMessageString(MessageUtils.NULL_PARAMETERS_ERROR_MESSAGE_ID, "base and property"); // ????? throw new PropertyNotFoundException(message); } Object ret = null; if (base instanceof ResourceHandler) { ResourceHandler handler = (ResourceHandler) base; String prop = property.toString(); Resource res; if (!prop.contains(":")) { res = handler.createResource(prop); } else { if (!isPropertyValid(prop)) { // RELEASE_PENDING i18n throw new ELException("Invalid resource format. Property " + prop + " contains more than one colon (:)"); } Map appMap = FacesContext.getCurrentInstance().getExternalContext().getApplicationMap(); String[] parts = Util.split(appMap, prop, ":"); // If the enclosing entity for this expression is itself // a resource, the "this" syntax for the library name must // be supported. if (null != parts[0] && parts[0].equals("this")) { FacesContext facesContext = FacesContext.getCurrentInstance(); UIComponent currentComponent = UIComponent.getCurrentCompositeComponent(facesContext); Resource componentResource = (Resource) currentComponent.getAttributes().get(Resource.COMPONENT_RESOURCE_KEY); if (null != componentResource) { String libName = null; if (null != (libName = componentResource.getLibraryName())) { parts[0] = libName; } } } res = handler.createResource(parts[1], parts[0]); } if (res != null) { FacesContext facesContext = (FacesContext) context.getContext(FacesContext.class); ExternalContext extContext = facesContext.getExternalContext(); ret = extContext.encodeResourceURL(res.getRequestPath()); } context.setPropertyResolved(true); } return ret; } /** * @return null as this resolver only performs lookups * @throws PropertyNotFoundException if base and property are null */ @Override public Class getType(ELContext context, Object base, Object property) { if (base == null && property == null) { String message = MessageUtils.getExceptionMessageString(MessageUtils.NULL_PARAMETERS_ERROR_MESSAGE_ID, "base and property"); // ????? throw new PropertyNotFoundException(message); } return null; } /** * This is basically a no-op. * * @throws PropertyNotFoundException if base and property are null */ @Override public void setValue(ELContext context, Object base, Object property, Object value) { if (base == null && property == null) { String message = MessageUtils.getExceptionMessageString(MessageUtils.NULL_PARAMETERS_ERROR_MESSAGE_ID, "base and property"); // ????? throw new PropertyNotFoundException(message); } } /** * @return false (basically ignored by the EL system) * @throws PropertyNotFoundException if base and property are null */ @Override public boolean isReadOnly(ELContext context, Object base, Object property) { if (base == null && property == null) { String message = MessageUtils.getExceptionMessageString(MessageUtils.NULL_PARAMETERS_ERROR_MESSAGE_ID, "base and property"); // ????? throw new PropertyNotFoundException(message); } return false; } /** * @return null - there is no way to query the ResourceManager for all known resources */ @Override public Iterator getFeatureDescriptors(ELContext context, Object base) { return null; } /** * @return String.class - getType() expects String properties */ @Override public Class getCommonPropertyType(ELContext context, Object base) { return String.class; } // --------------------------------------------------------- Private Methods private boolean isPropertyValid(String property) { int idx = property.indexOf(':'); return property.indexOf(':', idx + 1) == -1; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy