ExMessageTag.java :  » J2EE » Expresso » com » jcorporate » expresso » ext » struts » taglib » bean » Java Open Source

/* ====================================================================
 * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
 *
 * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by Jcorporate Ltd.
 *        (http://www.jcorporate.com/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. "Jcorporate" and product names such as "Expresso" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written permission,
 *    please contact info@jcorporate.com.
 *
 * 5. Products derived from this software may not be called "Expresso",
 *    or other Jcorporate product names; nor may "Expresso" or other
 *    Jcorporate product names appear in their name, without prior
 *    written permission of Jcorporate Ltd.
 *
 * 6. No product derived from this software may compete in the same
 *    market space, i.e. framework, without prior written permission
 *    of Jcorporate Ltd. For written permission, please contact
 *    partners@jcorporate.com.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Jcorporate Ltd. Contributions back
 * to the project(s) are encouraged when you make modifications.
 * Please send them to support@jcorporate.com. For more information
 * on Jcorporate Ltd. and its products, please see
 * <http://www.jcorporate.com/>.
 *
 * Portions of this software are based upon other open source
 * products and are subject to their respective licenses.
 */

package com.jcorporate.expresso.ext.struts.taglib.bean;

import com.jcorporate.expresso.core.controller.ControllerResponse;
import com.jcorporate.expresso.ext.struts.taglib.ControllerUtils;
import com.jcorporate.expresso.ext.taglib.MessageUtil;
import org.apache.struts.taglib.bean.MessageTag;
import org.apache.struts.util.ResponseUtils;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.PageContext;


/**
 * Expresso-specific extension to the MessageTag from Struts:
 * this version gets it's message string from the ControllerRequest object,
 * which knows the current user's locale settings already, and also has
 * the application schema code, which allows us to use the appropriate message
 * bundle file for the current application, as Expresso support multiple
 * message bundles, one per schema
 *
 * @author Michael Nash
 */
public class ExMessageTag
        extends MessageTag {
    public final static String SCHEMA_KEY = "ExMessageTag.SCHEMA";
    public String schemaClass = null;

    public void setSchema(String newSchema) {
        schemaClass = newSchema;
    }

    public String getSchema() {
        return schemaClass;
    }
    // --------------------------------------------------------- Public Methods
    /**
     * Process the start tag.
     *
     * @return integer as defined in the standard tag library framework.
     * @throws JspException if a JSP exception has occurred
     */
    public int doStartTag()
            throws JspException {

        // Construct the optional arguments array we will be using
        Object[] args = new Object[5];
        args[0] = arg0;
        args[1] = arg1;
        args[2] = arg2;
        args[3] = arg3;
        args[4] = arg4;

        String useSchema = null;
        String message = null;

        /* If we weren't given a schema class */
        if (schemaClass == null) {
            useSchema = (String) pageContext.getAttribute(SCHEMA_KEY,
                    PageContext.PAGE_SCOPE);
        } else {
            useSchema = schemaClass;
            pageContext.setAttribute(SCHEMA_KEY, useSchema,
                    PageContext.PAGE_SCOPE);
        }
        /* If we didn't get a schema from the context */
        if (useSchema == null) {
            ControllerResponse myResponse = ControllerUtils.getResponse(pageContext);

            if (myResponse != null) {
                pageContext.setAttribute(SCHEMA_KEY, myResponse.getSchema(),
                        PageContext.PAGE_SCOPE);
            }
        }

        message = MessageUtil.getString(pageContext, key, args);

        if (message == null) {
            message = key;
        }

        // Print the retrieved message to our output writer
        ResponseUtils.write(pageContext, message);

        // Continue processing this page
        return (SKIP_BODY);
    }
}