jp.terasoluna.fw.web.struts.taglib.LinkTag.java Source code

Introduction

Here is the source code for jp.terasoluna.fw.web.struts.taglib.LinkTag.java

Source

/*
 * Copyright (c) 2007 NTT DATA Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package jp.terasoluna.fw.web.struts.taglib;

import java.net.MalformedURLException;
import java.util.HashMap;
import java.util.Map;

import javax.servlet.jsp.JspException;

import jp.terasoluna.fw.web.RequestUtil;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.struts.taglib.TagUtils;
import org.apache.struts.taglib.logic.IterateTag;

/**
 * <p>g <code>link</code> ^O?B</p>
 *
 * <p>
 *  <code>Struts</code>  <code>&lt;html:link&gt;</code> ^Og?B
 *  @\?AANV <code>URL</code> LbVp_
 *  <code>ID</code> ?B
 *  lXg<code></code>iterateTag</code>
 *  <code>BODY</code><code>LinkTag</code>gp
 *  <code>indexed</code>??A<code>indexId</code>?L?B
 * </p>
 *
 * <br>
 *
 * <h5>^OT|?[g?</h5>
 * <p><code>&lt;html:link&gt;</code>^O<code>API</code> Q??B</p>
 *
 * <br>
 *
 * <h5>JX^^OXNveBO?</h5>
 * <p> <code>&lt;html:link&gt;</code> ^O <code>API</code> Q??B</p>
 *
 * <br>
 *
 * <h5>gp@</h5>
 * <p> <code>&lt;html:link&gt;</code> ^O <code>API</code> Q??B</p>
 *
 *
 *
 */
public class LinkTag extends org.apache.struts.taglib.html.LinkTag {

    /**
     * VAo?[WID
     */
    private static final long serialVersionUID = -2143604832271336809L;

    /**
     * ?ONX?B
     */
    private static Log log = LogFactory.getLog(LinkTag.class);

    /**
     * LbVp_IDp??[^?B
     */
    private static final String RANDOM_ID_KEY = RandomUtil.RANDOM_ID_KEY;

    /**
     * <p>URLLbVp_ID?B</p>
     *
     * <p>zbgX|bg?A<code>Struts 1.2.4</code> 
     * <code>LinkTag.calculate()</code> R?[hRs?[?X?B
     * <code>Struts</code> o?[W?X??
     * Kv??B</p>
     *
     * @return ???w
     * @exception JspException G?[?
     */
    @SuppressWarnings("unchecked")
    @Override
    protected String calculateURL() throws JspException {

        // Identify the parameters we will add to the completed URL
        Map<String, String> params = TagUtils.getInstance().computeParameters(pageContext, paramId, paramName,
                paramProperty, paramScope, name, property, scope, transaction);

        // ========== ?yg??z?==========
        if (params == null) {
            params = new HashMap<String, String>();
        }

        //_ID??????B
        forward = RequestUtil.deleteUrlParam(forward, RANDOM_ID_KEY);
        href = RequestUtil.deleteUrlParam(href, RANDOM_ID_KEY);
        page = RequestUtil.deleteUrlParam(page, RANDOM_ID_KEY);
        action = RequestUtil.deleteUrlParam(action, RANDOM_ID_KEY);

        //p??[^}bv_ID?B
        params.put(RANDOM_ID_KEY, RandomUtil.generateRandomID());

        // if "indexed=true", add "index=x" parameter to query string
        // * @since Struts 1.1
        if (indexed) {

            // look for outer iterate tag
            IterateTag iterateTag = (IterateTag) findAncestorWithClass(this, IterateTag.class);
            if (iterateTag == null) {
                // iterateTagbodygp??O
                JspException e = new JspException(messages.getMessage("indexed.noEnclosingIterate"));
                TagUtils.getInstance().saveException(pageContext, e);

                log.error("iterateTag is null.");
                throw e;
            }

            if (indexId != null) {
                params.put(indexId, Integer.toString(iterateTag.getIndex()));
            } else {
                params.put("index", Integer.toString(iterateTag.getIndex()));
            }
        }
        // ========== ?yg??z?==========

        String url = null;
        try {
            url = TagUtils.getInstance().computeURLWithCharEncoding(pageContext, forward, href, page, action,
                    module, params, anchor, false, useLocalEncoding);
        } catch (MalformedURLException e) {
            TagUtils.getInstance().saveException(pageContext, e);

            log.error("Malformed URL has occurred.");
            throw new JspException(messages.getMessage("rewrite.url", e.toString()));
        }
        return (url);

    }
}