/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* Portions Copyright Apache Software Foundation.
*
* 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.html
* or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [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 org.apache.taglibs.standard.tag.common.fmt;
import java.io.IOException;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.MissingResourceException;
import java.util.ResourceBundle;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspTagException;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.jstl.fmt.LocalizationContext;
import javax.servlet.jsp.tagext.BodyTagSupport;
import javax.servlet.jsp.tagext.Tag;
import org.apache.taglibs.standard.tag.common.core.Util;
/**
* Support for tag handlers for <message>, the message formatting tag
* in JSTL 1.0.
*
* @author Jan Luehe
*/
public abstract class MessageSupport extends BodyTagSupport {
//*********************************************************************
// Public constants
public static final String UNDEFINED_KEY = "???";
//*********************************************************************
// Protected state
protected String keyAttrValue; // 'key' attribute value
protected boolean keySpecified; // 'key' attribute specified
protected LocalizationContext bundleAttrValue; // 'bundle' attribute value
protected boolean bundleSpecified; // 'bundle' attribute specified?
//*********************************************************************
// Private state
private String var; // 'var' attribute
private int scope; // 'scope' attribute
private List params;
//*********************************************************************
// Constructor and initialization
public MessageSupport() {
super();
params = new ArrayList();
init();
}
private void init() {
var = null;
scope = PageContext.PAGE_SCOPE;
keyAttrValue = null;
keySpecified = false;
bundleAttrValue = null;
bundleSpecified = false;
}
//*********************************************************************
// Tag attributes known at translation time
public void setVar(String var) {
this.var = var;
}
public void setScope(String scope) {
this.scope = Util.getScope(scope);
}
//*********************************************************************
// Collaboration with subtags
/**
* Adds an argument (for parametric replacement) to this tag's message.
*
* @see ParamSupport
*/
public void addParam(Object arg) {
params.add(arg);
}
//*********************************************************************
// Tag logic
public int doStartTag() throws JspException {
params.clear();
return EVAL_BODY_BUFFERED;
}
public int doEndTag() throws JspException {
String key = null;
LocalizationContext locCtxt = null;
// determine the message key by...
if (keySpecified) {
// ... reading 'key' attribute
key = keyAttrValue;
} else {
// ... retrieving and trimming our body
if (bodyContent != null && bodyContent.getString() != null)
key = bodyContent.getString().trim();
}
if ((key == null) || key.equals("")) {
try {
pageContext.getOut().print("??????");
} catch (IOException ioe) {
throw new JspTagException(ioe.toString(), ioe);
}
return EVAL_PAGE;
}
String prefix = null;
if (!bundleSpecified) {
Tag t = findAncestorWithClass(this, BundleSupport.class);
if (t != null) {
// use resource bundle from parent <bundle> tag
BundleSupport parent = (BundleSupport) t;
locCtxt = parent.getLocalizationContext();
prefix = parent.getPrefix();
} else {
locCtxt = BundleSupport.getLocalizationContext(pageContext);
}
} else {
// localization context taken from 'bundle' attribute
locCtxt = bundleAttrValue;
if (locCtxt.getLocale() != null) {
SetLocaleSupport.setResponseLocale(pageContext,
locCtxt.getLocale());
}
}
String message = UNDEFINED_KEY + key + UNDEFINED_KEY;
if (locCtxt != null) {
ResourceBundle bundle = locCtxt.getResourceBundle();
if (bundle != null) {
try {
// prepend 'prefix' attribute from parent bundle
if (prefix != null)
key = prefix + key;
message = bundle.getString(key);
// Perform parametric replacement if required
if (!params.isEmpty()) {
Object[] messageArgs = params.toArray();
MessageFormat formatter = new MessageFormat(""); // empty pattern, default Locale
if (locCtxt.getLocale() != null) {
formatter.setLocale(locCtxt.getLocale());
} else {
// For consistency with the <fmt:formatXXX> actions,
// we try to get a locale that matches the user's preferences
// as well as the locales supported by 'date' and 'number'.
//System.out.println("LOCALE-LESS LOCCTXT: GETTING FORMATTING LOCALE");
Locale locale = SetLocaleSupport.getFormattingLocale(pageContext);
//System.out.println("LOCALE: " + locale);
if (locale != null) {
formatter.setLocale(locale);
}
}
formatter.applyPattern(message);
message = formatter.format(messageArgs);
}
} catch (MissingResourceException mre) {
message = UNDEFINED_KEY + key + UNDEFINED_KEY;
}
}
}
if (var != null) {
pageContext.setAttribute(var, message, scope);
} else {
try {
pageContext.getOut().print(message);
} catch (IOException ioe) {
throw new JspTagException(ioe.toString(), ioe);
}
}
return EVAL_PAGE;
}
// Releases any resources we may have (or inherit)
public void release() {
init();
}
}