| <!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="/highlighter/github-theme.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> |
| </head> |
| <body> |
| |
| <a href="http://github.com/apache/struts" class="github-ribbon"> |
| <img style="position: absolute; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png" alt="Fork me on GitHub"> |
| </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-2021.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> |
| </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 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><a href="/contributors/">Contributors Guide</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="https://cwiki.apache.org/confluence/display/WW/Contributors+Guide">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="highlighter-rouge">id</code> attribute is deprecated in Struts 2.1.x, and has been replaced by the <code class="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 <param> 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., &). This is necessary |
| for XHTML compliance, however, when using the URL generated by this tag with the <code class="highlighter-rouge"><s:property></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="highlighter-rouge">all</code> or <code class="highlighter-rouge">get</code>, the parameter defined in a <code class="highlighter-rouge"><param></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="highlighter-rouge">http://<host>:<port>/<context>/editUser.action?id=3333&name=John</code> |
| the generated url will be <code class="highlighter-rouge">http://<host>:<port>/<context>/editUser.action?id=22&name=John</code> |
| because the parameter defined in the <code class="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="highlighter-rouge">includeParams</code></h3> |
| |
| <p>The property <code class="highlighter-rouge">struts.url.includeParams</code> can be used to set the default value of the <code class="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"><struts></span> |
| ... |
| <span class="nt"><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">/></span> |
| ... |
| <span class="nt"></struts></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="highlighter-rouge">none</code>.</p> |
| </blockquote> |
| |
| <p>This tag is used to create a URL</p> |
| |
| <h2 id="attributes">Attributes</h2> |
| |
| <table width="100%"> |
| <tr> |
| <td colspan="6"><h4>Dynamic Attributes Allowed:</h4> false</td> |
| </tr> |
| <tr> |
| <td colspan="6"> </td> |
| </tr> |
| <tr> |
| <th align="left" valign="top"><h4>Name</h4></th> |
| <th align="left" valign="top"><h4>Required</h4></th> |
| <th align="left" valign="top"><h4>Default</h4></th> |
| <th align="left" valign="top"><h4>Evaluated</h4></th> |
| <th align="left" valign="top"><h4>Type</h4></th> |
| <th align="left" valign="top"><h4>Description</h4></th> |
| </tr> |
| <tr> |
| <td align="left" valign="top">action</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top"></td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">String</td> |
| <td align="left" valign="top">The action to generate the URL for, if not using value</td> |
| </tr> |
| <tr> |
| <td align="left" valign="top">anchor</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top"></td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">String</td> |
| <td align="left" valign="top">The anchor for this URL</td> |
| </tr> |
| <tr> |
| <td align="left" valign="top">encode</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">true</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">Boolean</td> |
| <td align="left" valign="top">Whether to encode parameters</td> |
| </tr> |
| <tr> |
| <td align="left" valign="top">escapeAmp</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">true</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">Boolean</td> |
| <td align="left" valign="top">Specifies whether to escape ampersand (&) to (&amp;) or not</td> |
| </tr> |
| <tr> |
| <td align="left" valign="top">forceAddSchemeHostAndPort</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">Boolean</td> |
| <td align="left" valign="top">Specifies whether to force the addition of scheme, host and port or not</td> |
| </tr> |
| <tr> |
| <td align="left" valign="top">includeContext</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">true</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">Boolean</td> |
| <td align="left" valign="top">Whether actual context should be included in URL</td> |
| </tr> |
| <tr> |
| <td align="left" valign="top">includeParams</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">none</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">String</td> |
| <td align="left" valign="top">The includeParams attribute may have the value 'none', 'get' or 'all'</td> |
| </tr> |
| <tr> |
| <td align="left" valign="top">method</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top"></td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">String</td> |
| <td align="left" valign="top">The method of action to use</td> |
| </tr> |
| <tr> |
| <td align="left" valign="top">namespace</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top"></td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">String</td> |
| <td align="left" valign="top">The namespace to use</td> |
| </tr> |
| <tr> |
| <td align="left" valign="top">portletMode</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top"></td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">String</td> |
| <td align="left" valign="top">The resulting portlet mode</td> |
| </tr> |
| <tr> |
| <td align="left" valign="top">portletUrlType</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top"></td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">String</td> |
| <td align="left" valign="top">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 align="left" valign="top">scheme</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top"></td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">String</td> |
| <td align="left" valign="top">Set scheme attribute</td> |
| </tr> |
| <tr> |
| <td align="left" valign="top">value</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top"></td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">String</td> |
| <td align="left" valign="top">The target value to use, if not using action</td> |
| </tr> |
| <tr> |
| <td align="left" valign="top">var</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top"></td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">String</td> |
| <td align="left" valign="top">Name used to reference the value pushed into the Value Stack (scope: action).</td> |
| </tr> |
| <tr> |
| <td align="left" valign="top">windowState</td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top"></td> |
| <td align="left" valign="top">false</td> |
| <td align="left" valign="top">String</td> |
| <td align="left" valign="top">The resulting portlet window state</td> |
| </tr> |
| </table> |
| |
| <blockquote> |
| <p><strong>NOTE</strong>: When the <code class="highlighter-rouge">var</code> attribute is used with the <code class="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> |
| |
| <pre><code class="language-jsp"><!-- Example 1 --> |
| <s:url value="editGadget.action"> |
| <s:param name="id" value="%{selected}" /> |
| </s:url> |
| |
| <!-- Example 2 --> |
| <s:url action="editGadget"> |
| <s:param name="id" value="%{selected}" /> |
| </s:url> |
| |
| <!-- Example 3--> |
| <s:url includeParams="get"> |
| <s:param name="id" value="%{'22'}" /> |
| </s:url> |
| </code></pre> |
| |
| </section> |
| </article> |
| |
| |
| <footer class="container"> |
| <div class="col-md-12"> |
| Copyright © 2000-2018 <a href="http://www.apache.org/">The Apache Software Foundation </a>. |
| All Rights Reserved. |
| </div> |
| <div class="col-md-12"> |
| Apache Struts, Struts, Apache, the Apache feather logo, and the Apache Struts project logos are |
| trademarks of The Apache Software Foundation. |
| </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> |
