/*
 * Copyright 1999,2004 The Apache Software Foundation.
 * 
 * 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 org.apache.taglibs.response;

import java.util.*;
import javax.servlet.*;
import javax.servlet.http.*;
import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;

/**
 * JSP Tag <b>comment</b>, used to set the comment of a cookie.
 * <p>
 * Must be nested within an <b>addCookie</b> tag.
 * <p>
 * The cookie comment is set to the content of the body of the <b>comment</b> tag.
 * <p>
 * JSP Tag Lib Descriptor
 * <p><pre>
 * &lt;name&gt;comment&lt;/name&gt;
 * &lt;tagclass&gt;org.apache.taglibs.response.CookieCommentTag&lt;/tagclass&gt;
 * &lt;bodycontent&gt;JSP&lt;/bodycontent&gt;
 * &lt;info&gt;Set a cookie comment.&lt;/info&gt;
 * </pre>
 *
 * @author Glenn Nielsen
 */

public class CookieCommentTag extends BodyTagSupport
{

    /**
     * Method called at start of tag, just returns EVAL_BODY_TAG
     *
     * @return EVAL_BODY_TAG
     */
    public final int doStartTag() throws JspException
    {
	return EVAL_BODY_TAG;
    }

    /**
     * Read the body of the comment tag to obtain the cookie comment.
     *
     * @return SKIP_BODY
     */
    public final int doAfterBody() throws JspException
    {
        // Use the body of the tag as cookie comment
        BodyContent body = getBodyContent();
        String s = body.getString().trim();
        // Clear the body since we only used it as input for the cookie
        // comment
        body.clearBody();

	// Get the parent addCookie tag
	AddCookieTag ac = null;
	try {
	    ac = (AddCookieTag)this.findAncestorWithClass(this,
		Class.forName("org.apache.taglibs.response.AddCookieTag"));
	} catch(Exception e) {
	    throw new JspException("Response comment tag must be nested inside an addCookie tag.");
	}

        // set the cookie comment
        ac.setComment(s);

        return SKIP_BODY;
    }
}