org.infoglue.deliver.taglib.common
Class URLTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      org.infoglue.deliver.taglib.AbstractTag
          org.infoglue.deliver.taglib.TemplateControllerTag
              org.infoglue.deliver.taglib.common.URLTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.Tag

public class URLTag
extends TemplateControllerTag

This class implements the <common:urlBuilder> tag, which creates an url from a base url (user supplied or taken from the request), a query string (user supplied ot taken from the reuest) and any number of parameters specified using nested <common:parameter> tags.

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

URLTag()
Default constructor.

Method Summary

protected void	addParameter(java.lang.String name, java.lang.String value)
int	doEndTag() Generates the url and either sets the result attribute or writes the url to the output stream.
int	doStartTag() Initializes the parameters to make it accessible for the children tags (if any).
java.lang.String	generateURL() Generates the url string.
void	setAllowMultipleArguments(boolean allowMultipleArguments)
void	setBaseURL(java.lang.String baseURL) Sets the base url attribute.
void	setDisableNiceURI(boolean disableNiceURI)
void	setExcludedQueryStringParameters(java.lang.String excludedQueryStringParameters)
void	setFullBaseUrl(boolean fullBaseUrl)
void	setQuery(java.lang.String query) Sets the query attribute.

Methods inherited from class org.infoglue.deliver.taglib.TemplateControllerTag

getController

Methods inherited from class org.infoglue.deliver.taglib.AbstractTag

evaluate, evaluateCollection, evaluateInteger, evaluateList, evaluateString, produceResult, setId, setResultAttribute, write

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

URLTag

public URLTag()

Default constructor.

Method Detail

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Initializes the parameters to make it accessible for the children tags (if any).

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Returns:

indication of whether to evaluate the body or not.

Throws:

javax.servlet.jsp.JspException - if an error occurred while processing this tag.

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

Generates the url and either sets the result attribute or writes the url to the output stream.

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.TagSupport

Returns:

indication of whether to continue evaluating the JSP page.

Throws:

javax.servlet.jsp.JspException - if an error occurred while processing this tag.

addParameter

protected final void addParameter(java.lang.String name,
                                  java.lang.String value)

generateURL

public java.lang.String generateURL()

Generates the url string.

Returns:

the url.

setBaseURL

public void setBaseURL(java.lang.String baseURL)
                throws javax.servlet.jsp.JspException

Sets the base url attribute.

Parameters:

baseURL - the base url to use.

Throws:

javax.servlet.jsp.JspException - if an error occurs while evaluating base url parameter.

setQuery

public void setQuery(java.lang.String query)
              throws javax.servlet.jsp.JspException

Sets the query attribute.

Parameters:

query - the query to use.

Throws:

javax.servlet.jsp.JspException - if an error occurs while evaluating query parameter.

setExcludedQueryStringParameters

public void setExcludedQueryStringParameters(java.lang.String excludedQueryStringParameters)
                                      throws javax.servlet.jsp.JspException

Throws:

javax.servlet.jsp.JspException

setFullBaseUrl

public void setFullBaseUrl(boolean fullBaseUrl)

setDisableNiceURI

public void setDisableNiceURI(boolean disableNiceURI)

setAllowMultipleArguments

public void setAllowMultipleArguments(boolean allowMultipleArguments)