javax.faces.webapp.ConverterTag Maven / Gradle / Ivy
/*
* 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.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 javax.faces.webapp;
import javax.el.ValueExpression;
import javax.faces.component.UIComponent;
import javax.faces.component.ValueHolder;
import javax.faces.context.FacesContext;
import javax.faces.convert.Converter;
import javax.faces.convert.ConverterException;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.TagSupport;
/**
* ConverterTag is a base class for all JSP custom actions
* that create and register a Converter instance on the
* {@link ValueHolder} associated with our most immediate
* surrounding instance of a tag whose implementation class is a subclass
* of {@link UIComponentTag}. To avoid creating duplicate instances when
* a page is redisplayed, creation and registration of a {@link Converter}
* occurs only if the corresponding {@link UIComponent} was
* created (by the owning {@link UIComponentTag}) during the execution of the
* current page.
*
* This class may be used directly to implement a generic converter
* registration tag (based on the converter-id specified by the
* converterId attribute), or as a base class for tag
* instances that support specific {@link Converter} subclasses. This
* converterId attribute must refer to one of the well
* known converter-ids, or a custom converter-id as defined in a
* faces-config.xml file.
*
* Subclasses of this class must implement the
* createConverter() method, which creates and returns a
* {@link Converter} instance. Any configuration properties that specify
* behavior of this {@link Converter} must have been set by the
* createConverter() method. Generally, this occurs
* by copying corresponding attribute values on the tag instance.
*
* This tag creates no output to the page currently being created. It
* is used solely for the side effect of {@link Converter} creation.
*
* @deprecated This has been partially replaced by {@link
* ConverterELTag}. The remainder of the functionality, namely, the
* binding facility and the implementation of the {@link
* #createConverter} method, is now an implementation detail.
*/
public class ConverterTag extends TagSupport {
// ---------------------------------------------------------- Static Members
private static final long serialVersionUID = -5909792518081427720L;
// -------------------------------------------------------------- Attributes
/**
* The identifier of the {@link Converter} instance to be created.
*/
private String converterId = null;
/**
* The {@link ValueExpression} that evaluates to an object that
* implements {@link Converter}.
*/
private String binding = null;
/**
* Set the identifer of the {@link Converter} instance to be created.
*
* @param converterId The identifier of the converter instance to be
* created.
*/
public void setConverterId(String converterId) {
this.converterId = converterId;
}
/**
*
Set the expression that will be used to create a {@link ValueExpression}
* that references a backing bean property of the {@link Converter} instance to
* be created.
*
* @param binding The new expression
*
* @throws JspException if a JSP error occurs
*/
public void setBinding(String binding)
throws JspException {
if (binding!= null && !UIComponentTag.isValueReference(binding)) {
// PENDING i18n
throw new JspException("Invalid Expression:"+binding);
}
this.binding = binding;
}
// ---------------------------------------------------------- Public Methods
/**
* Create a new instance of the specified {@link Converter}
* class, and register it with the {@link UIComponent} instance associated
* with our most immediately surrounding {@link UIComponentTag} instance, if
* the {@link UIComponent} instance was created by this execution of the
* containing JSP page. If the localValue of the
* {@link UIComponent} is a String, attempt to convert it.
*
* @throws JspException if a JSP error occurs
*/
@Override
public int doStartTag() throws JspException {
// Locate our parent UIComponentTag
UIComponentClassicTagBase tag =
UIComponentClassicTagBase.getParentUIComponentClassicTagBase(pageContext);
if (tag == null) { // PENDING - i18n
throw new JspException("Not nested in a UIComponentTag Error for tag with handler class:"+
this.getClass().getName());
}
// Nothing to do unless this tag created a component
if (!tag.getCreated()) {
return (SKIP_BODY);
}
UIComponent component = tag.getComponentInstance();
if (component == null) {
//PENDING i18n
throw new JspException("Can't create Component from tag.");
}
if (!(component instanceof ValueHolder)) {
//PENDING i18n
throw new JspException("Not nested in a tag of proper type. Error for tag with handler class:"+
this.getClass().getName());
}
Converter converter = createConverter();
if (converter == null) {
//noinspection NonConstantStringShouldBeStringBuffer
String converterError = null;
if (binding != null) {
converterError = binding;
}
if (converterId != null) {
if (converterError != null) {
converterError += " or " + converterId;
} else {
converterError = converterId;
}
}
// PENDING i18n
throw new JspException("Can't create class of type:"+
"javax.faces.convert.Converter for:"+converterError);
}
ValueHolder vh = (ValueHolder)component;
FacesContext context = FacesContext.getCurrentInstance();
// Register an instance with the appropriate component
vh.setConverter(converter);
// Once the converter has been set, attempt to convert the
// incoming "value"
Object localValue = vh.getLocalValue();
if (localValue instanceof String) {
try {
localValue = converter.getAsObject(context, (UIComponent)vh, (String) localValue);
vh.setValue(localValue);
}
catch (ConverterException ce) {
// PENDING - Ignore? Throw an exception? Set the local
// value back to "null" and log a warning?
}
}
return (SKIP_BODY);
}
/**
* Release references to any acquired resources.
*/
@Override
public void release() {
this.converterId = null;
}
// ------------------------------------------------------- Protected Methods
/**
*
Create and return a new {@link Converter} to be registered
* on our surrounding {@link UIComponent}.
*
* @throws JspException if a new instance cannot be created
*
* @return the {@code Converter}
*/
protected Converter createConverter()
throws JspException {
FacesContext context = FacesContext.getCurrentInstance();
Converter converter = null;
ValueExpression vb = null;
// If "binding" is set, use it to create a converter instance.
if (binding != null) {
try {
vb =
context.getApplication().getExpressionFactory().createValueExpression(context.getELContext(), binding, Object.class);
if (vb != null) {
converter = (Converter)vb.getValue(context.getELContext());
if (converter != null) {
return converter;
}
}
} catch (Exception e) {
throw new JspException(e);
}
}
// If "converterId" is set, use it to create the converter
// instance. If "converterId" and "binding" are both set, store the
// converter instance in the value of the property represented by
// the value binding expression.
if (converterId != null) {
try {
String converterIdVal = converterId;
if (UIComponentTag.isValueReference(converterId)) {
ValueExpression idBinding =
context.getApplication().getExpressionFactory().createValueExpression(context.getELContext(), converterId, Object.class);
converterIdVal = (String) idBinding.getValue(context.getELContext());
}
converter = context.getApplication().createConverter(converterIdVal);
if (converter != null) {
if (vb != null) {
vb.setValue(context.getELContext(), converter);
}
}
} catch (Exception e) {
throw new JspException(e);
}
}
return converter;
}
}