Google Git
Sign in
apache / struts-site / refs/heads/asf-site / . / output / tag-developers / url-tag.html
blob: 34b9d9b885c3174efe7d080a42b46ee8ca9f12b5 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta name="Date-Revision-yyyymmdd" content="20140918"/>
<meta http-equiv="Content-Language" content="en"/>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>url tag</title>
<link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css">
<link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet">
<link href="/css/main.css" rel="stylesheet">
<link href="/css/custom.css" rel="stylesheet">
<link href="/css/syntax.css" rel="stylesheet">
<script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="/bootstrap/js/bootstrap.js"></script>
<script type="text/javascript" src="/js/community.js"></script>
<!-- Matomo -->
<script>
var _paq = window._paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
/* We explicitly disable cookie tracking to avoid privacy issues */
_paq.push(['disableCookies']);
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u="//analytics.apache.org/";
_paq.push(['setTrackerUrl', u+'matomo.php']);
_paq.push(['setSiteId', '41']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Matomo Code -->
</head>
<body>
<a href="https://github.com/apache/struts" class="github-ribbon">
<img decoding="async" loading="lazy" style="position: absolute; right: 0; border: 0;" width="149" height="149" src="https://github.blog/wp-content/uploads/2008/12/forkme_right_red_aa0000.png?resize=149%2C149" class="attachment-full size-full" alt="Fork me on GitHub" data-recalc-dims="1">
</a>
<header>
<nav>
<div role="navigation" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<button type="button" data-toggle="collapse" data-target="#struts-menu" class="navbar-toggle">
Menu
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a href="/index.html" class="navbar-brand logo"><img src="/img/struts-logo.svg"></a>
</div>
<div id="struts-menu" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Home<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="/index.html">Welcome</a></li>
<li><a href="/download.cgi">Download</a></li>
<li><a href="/releases.html">Releases</a></li>
<li><a href="/announce-2024.html">Announcements</a></li>
<li><a href="http://www.apache.org/licenses/">License</a></li>
<li><a href="https://www.apache.org/foundation/thanks.html">Thanks!</a></li>
<li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
<li><a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a></li>
</ul>
</li>
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Support<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="/mail.html">User Mailing List</a></li>
<li><a href="https://issues.apache.org/jira/browse/WW">Issue Tracker</a></li>
<li><a href="/security.html">Reporting Security Issues</a></li>
<li><a href="/commercial-support.html">Commercial Support</a></li>
<li class="divider"></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/Migration+Guide">Version Notes</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/Security+Bulletins">Security Bulletins</a></li>
<li class="divider"></li>
<li><a href="/maven/project-info.html">Maven Project Info</a></li>
<li><a href="/maven/struts2-core/dependencies.html">Struts Core Dependencies</a></li>
<li><a href="/maven/struts2-plugins/modules.html">Plugin Dependencies</a></li>
</ul>
</li>
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Documentation<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="/birdseye.html">Birds Eye</a></li>
<li><a href="/primer.html">Key Technologies</a></li>
<li><a href="/kickstart.html">Kickstart FAQ</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/Home">Wiki</a></li>
<li class="divider"></li>
<li><a href="/getting-started/">Getting Started</a></li>
<li><a href="/security/">Security Guide</a></li>
<li><a href="/core-developers/">Core Developers Guide</a></li>
<li><a href="/tag-developers/">Tag Developers Guide</a></li>
<li><a href="/maven-archetypes/">Maven Archetypes</a></li>
<li><a href="/plugins/">Plugins</a></li>
<li><a href="/maven/struts2-core/apidocs/index.html">Struts Core API</a></li>
<li><a href="/tag-developers/tag-reference.html">Tag reference</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/FAQs">FAQs</a></li>
<li><a href="http://cwiki.apache.org/S2PLUGINS/home.html">Plugin registry</a></li>
</ul>
</li>
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Contributing<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="/youatstruts.html">You at Struts</a></li>
<li><a href="/helping.html">How to Help FAQ</a></li>
<li><a href="/dev-mail.html">Development Lists</a></li>
<li class="divider"></li>
<li><a href="/submitting-patches.html">Submitting patches</a></li>
<li><a href="/builds.html">Source Code and Builds</a></li>
<li><a href="/coding-standards.html">Coding standards</a></li>
<li><a href="/contributors/">Contributors Guide</a></li>
<li class="divider"></li>
<li><a href="/release-guidelines.html">Release Guidelines</a></li>
<li><a href="/bylaws.html">PMC Charter</a></li>
<li><a href="/volunteers.html">Volunteers</a></li>
<li><a href="https://gitbox.apache.org/repos/asf?p=struts.git">Source Repository</a></li>
<li><a href="/updating-website.html">Updating the website</a></li>
</ul>
</li>
<li class="apache"><a href="http://www.apache.org/"><img src="/img/apache.png"></a></li>
</ul>
</div>
</div>
</div>
</nav>
</header>
<article class="container">
<section class="col-md-12">
<a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/url-tag.md" title="Edit this page on GitHub">Edit on GitHub</a>
<a href="tag-reference.html" title="back to Tag Reference"><< back to Tag Reference</a>
<h1 id="url">url</h1>
<p>Please make sure you have read the <a href="tag-syntax">Tag Syntax</a> document and understand how tag attribute syntax works.</p>
<blockquote>
<p><strong>NOTE</strong>: The <code class="language-plaintext highlighter-rouge">id</code> attribute is deprecated in Struts 2.1.x, and has been replaced by the <code class="language-plaintext highlighter-rouge">var</code> attribute.</p>
</blockquote>
<h2 id="description">Description</h2>
<p>This tag is used to create a URL.</p>
<p>You can use the &lt;param&gt; tag inside the body to provide additional request parameters. If the value of a param
is an Array or an Iterable all the values will be added to the URL.</p>
<blockquote>
<p><strong>NOTE</strong>: By default request parameters will be separated using escaped ampersands (i.e., &amp;). This is necessary
for XHTML compliance, however, when using the URL generated by this tag with the <code class="language-plaintext highlighter-rouge">&lt;s:property&gt;</code> tag, the <strong>escapeAmp</strong>
attribute should be used to disable ampersand escaping.</p>
</blockquote>
<blockquote>
<p><strong>NOTE</strong>: When includeParams is <code class="language-plaintext highlighter-rouge">all</code> or <code class="language-plaintext highlighter-rouge">get</code>, the parameter defined in a <code class="language-plaintext highlighter-rouge">&lt;param&gt;</code> tag will take precedence over
any params included due to the includeParams attribute. For example, in Example 3 below, if there is a id parameter
in the url where the page this tag is included like <code class="language-plaintext highlighter-rouge">http://&lt;host&gt;:&lt;port&gt;/&lt;context&gt;/editUser.action?id=3333&amp;name=John</code>
the generated url will be <code class="language-plaintext highlighter-rouge">http://&lt;host&gt;:&lt;port&gt;/&lt;context&gt;/editUser.action?id=22&amp;name=John</code>
because the parameter defined in the <code class="language-plaintext highlighter-rouge">param</code> tag will take precedence</p>
</blockquote>
<h3 id="setting-a-default-value-for-includeparams">Setting a default value for <code class="language-plaintext highlighter-rouge">includeParams</code></h3>
<p>The property <code class="language-plaintext highlighter-rouge">struts.url.includeParams</code> can be used to set the default value of the <code class="language-plaintext highlighter-rouge">includeParams</code> attribute.</p>
<p><strong>Setting the default value of includeParams</strong></p>
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt">&lt;struts&gt;</span>
...
<span class="nt">&lt;constant</span> <span class="na">name=</span><span class="s">"struts.url.includeParams"</span> <span class="na">value=</span><span class="s">"none"</span> <span class="nt">/&gt;</span>
...
<span class="nt">&lt;/struts&gt;</span>
</code></pre></div></div>
<p>See <a href="../core-developers/constant-configuration">Constant Configuration</a> for further information.</p>
<blockquote>
<p><strong>NOTE</strong>: As of Struts 2.1.3 the includeParams constant defaults to <code class="language-plaintext highlighter-rouge">none</code>.</p>
</blockquote>
<p>This tag is used to create a URL</p>
<h2 id="attributes">Attributes</h2>
<table class="tag-reference">
<tr>
<td colspan="6"><h4>Dynamic Attributes Allowed:</h4> false</td>
</tr>
<tr>
<td colspan="6"><hr /></td>
</tr>
<tr>
<th class="tag-header"><h4>Name</h4></th>
<th class="tag-header"><h4>Required</h4></th>
<th class="tag-header"><h4>Default</h4></th>
<th class="tag-header"><h4>Evaluated</h4></th>
<th class="tag-header"><h4>Type</h4></th>
<th class="tag-header"><h4>Description</h4></th>
</tr>
<tr>
<td class="tag-attribute">action</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute"></td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">String</td>
<td class="tag-attribute">The action to generate the URL for, if not using value</td>
</tr>
<tr>
<td class="tag-attribute">anchor</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute"></td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">String</td>
<td class="tag-attribute">The anchor for this URL</td>
</tr>
<tr>
<td class="tag-attribute">encode</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">true</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">Boolean</td>
<td class="tag-attribute">Whether to encode parameters</td>
</tr>
<tr>
<td class="tag-attribute">escapeAmp</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">true</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">Boolean</td>
<td class="tag-attribute">Specifies whether to escape ampersand (&amp;) to (&amp;amp;) or not</td>
</tr>
<tr>
<td class="tag-attribute">forceAddSchemeHostAndPort</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">Boolean</td>
<td class="tag-attribute">Specifies whether to force the addition of scheme, host and port or not</td>
</tr>
<tr>
<td class="tag-attribute">includeContext</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">true</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">Boolean</td>
<td class="tag-attribute">Whether actual context should be included in URL</td>
</tr>
<tr>
<td class="tag-attribute">includeParams</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">none</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">String</td>
<td class="tag-attribute">The includeParams attribute may have the value 'none', 'get' or 'all'</td>
</tr>
<tr>
<td class="tag-attribute">method</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute"></td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">String</td>
<td class="tag-attribute">The method of action to use</td>
</tr>
<tr>
<td class="tag-attribute">namespace</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute"></td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">String</td>
<td class="tag-attribute">The namespace to use</td>
</tr>
<tr>
<td class="tag-attribute">performClearTagStateForTagPoolingServers</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">Boolean</td>
<td class="tag-attribute">Whether to clear all tag state during doEndTag() processing (if applicable)</td>
</tr>
<tr>
<td class="tag-attribute">portletMode</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute"></td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">String</td>
<td class="tag-attribute">The resulting portlet mode</td>
</tr>
<tr>
<td class="tag-attribute">portletUrlType</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute"></td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">String</td>
<td class="tag-attribute">Specifies if this should be a portlet render or action URL. Default is "render". To create an action URL, use "action".</td>
</tr>
<tr>
<td class="tag-attribute">scheme</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute"></td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">String</td>
<td class="tag-attribute">Set scheme attribute</td>
</tr>
<tr>
<td class="tag-attribute">value</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute"></td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">String</td>
<td class="tag-attribute">The target value to use, if not using action</td>
</tr>
<tr>
<td class="tag-attribute">var</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute"></td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">String</td>
<td class="tag-attribute">Name used to reference the value pushed into the Value Stack (scope: action).</td>
</tr>
<tr>
<td class="tag-attribute">windowState</td>
<td class="tag-attribute">false</td>
<td class="tag-attribute"></td>
<td class="tag-attribute">false</td>
<td class="tag-attribute">String</td>
<td class="tag-attribute">The resulting portlet window state</td>
</tr>
</table>
<blockquote>
<p><strong>NOTE</strong>: When the <code class="language-plaintext highlighter-rouge">var</code> attribute is used with the <code class="language-plaintext highlighter-rouge">url</code> tag, the tag’s generated URL value will be placed into the request scope
<strong>in addition to</strong> the action scope.</p>
</blockquote>
<h2 id="examples">Examples</h2>
<div class="language-jsp highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c">&lt;!-- Example 1 --&gt;</span>
<span class="nt">&lt;s:url </span><span class="na">value=</span><span class="s">"editGadget.action"</span><span class="nt">&gt;</span>
<span class="nt">&lt;s:param </span><span class="na">name=</span><span class="s">"id"</span><span class="na"> value=</span><span class="s">"%{selected}"</span> <span class="nt">/&gt;</span>
<span class="nt">&lt;/s:url&gt;</span>
<span class="c">&lt;!-- Example 2 --&gt;</span>
<span class="nt">&lt;s:url </span><span class="na">action=</span><span class="s">"editGadget"</span><span class="nt">&gt;</span>
<span class="nt">&lt;s:param </span><span class="na">name=</span><span class="s">"id"</span><span class="na"> value=</span><span class="s">"%{selected}"</span> <span class="nt">/&gt;</span>
<span class="nt">&lt;/s:url&gt;</span>
<span class="c">&lt;!-- Example 3--&gt;</span>
<span class="nt">&lt;s:url </span><span class="na">includeParams=</span><span class="s">"get"</span><span class="nt">&gt;</span>
<span class="nt">&lt;s:param </span><span class="na">name=</span><span class="s">"id"</span><span class="na"> value=</span><span class="s">"%{'22'}"</span> <span class="nt">/&gt;</span>
<span class="nt">&lt;/s:url&gt;</span>
</code></pre></div></div>
</section>
</article>
<footer class="container">
<div class="col-md-12">
Copyright &copy; 2000-2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>.
Apache Struts, Struts, Apache, the Apache feather logo, and the Apache Struts project logos are
trademarks of The Apache Software Foundation. All Rights Reserved.
</div>
<div class="col-md-12">Logo and website design donated by <a href="https://softwaremill.com/">SoftwareMill</a>.</div>
</footer>
<script>!function (d, s, id) {
var js, fjs = d.getElementsByTagName(s)[0];
if (!d.getElementById(id)) {
js = d.createElement(s);
js.id = id;
js.src = "//platform.twitter.com/widgets.js";
fjs.parentNode.insertBefore(js, fjs);
}
}(document, "script", "twitter-wjs");</script>
<script src="https://apis.google.com/js/platform.js" async="async" defer="defer"></script>
<div id="fb-root"></div>
<script>(function (d, s, id) {
var js, fjs = d.getElementsByTagName(s)[0];
if (d.getElementById(id)) return;
js = d.createElement(s);
js.id = id;
js.src = "//connect.facebook.net/en_GB/all.js#xfbml=1";
fjs.parentNode.insertBefore(js, fjs);
}(document, 'script', 'facebook-jssdk'));</script>
</body>
</html>