blob: cd3a6a606137995c9ec34ee7467f82df19bfffb8 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ShiroHttpServletResponse (Apache Shiro :: Web 1.9.1 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ShiroHttpServletResponse (Apache Shiro :: Web 1.9.1 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav"><!-- 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="//matomo.privacy.apache.org/"; _paq.push(['setTrackerUrl', u+'matomo.php']); _paq.push(['setSiteId', '2']); 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 -->
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ShiroHttpServletResponse.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.shiro.web.servlet</a></div>
<h2 title="Class ShiroHttpServletResponse" class="title">Class ShiroHttpServletResponse</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">javax.servlet.ServletResponseWrapper</a></li>
<li>
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">javax.servlet.http.HttpServletResponseWrapper</a></li>
<li>
<ul class="inheritance">
<li>org.apache.shiro.web.servlet.ShiroHttpServletResponse</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletResponse</a></code>, <code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletResponse</a></code></dd>
</dl>
<hr>
<pre>public class <a href="../../../../../src-html/org/apache/shiro/web/servlet/ShiroHttpServletResponse.html#line.45">ShiroHttpServletResponse</a>
extends <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletResponseWrapper</a></pre>
<div class="block">HttpServletResponse implementation to support URL Encoding of Shiro Session IDs.
<p/>
It is only used when using Shiro's native Session Management configuration (and not when using the Servlet
Container session configuration, which is Shiro's default in a web environment). Because the servlet container
already performs url encoding of its own session ids, instances of this class are only needed when using Shiro
native sessions.
<p/>
Note that this implementation relies in part on source code from the Tomcat 6.x distribution for
encoding URLs for session ID URL Rewriting (we didn't want to re-invent the wheel). Since Shiro is also
Apache 2.0 license, all regular licenses and conditions have remained in tact.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>0.2</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.javax.servlet.http.HttpServletResponse">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;javax.servlet.http.<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletResponse</a></h3>
<code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_ACCEPTED" title="class or interface in javax.servlet.http" class="externalLink">SC_ACCEPTED</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_BAD_GATEWAY" title="class or interface in javax.servlet.http" class="externalLink">SC_BAD_GATEWAY</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_BAD_REQUEST" title="class or interface in javax.servlet.http" class="externalLink">SC_BAD_REQUEST</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_CONFLICT" title="class or interface in javax.servlet.http" class="externalLink">SC_CONFLICT</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_CONTINUE" title="class or interface in javax.servlet.http" class="externalLink">SC_CONTINUE</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_CREATED" title="class or interface in javax.servlet.http" class="externalLink">SC_CREATED</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_EXPECTATION_FAILED" title="class or interface in javax.servlet.http" class="externalLink">SC_EXPECTATION_FAILED</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_FORBIDDEN" title="class or interface in javax.servlet.http" class="externalLink">SC_FORBIDDEN</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_FOUND" title="class or interface in javax.servlet.http" class="externalLink">SC_FOUND</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_GATEWAY_TIMEOUT" title="class or interface in javax.servlet.http" class="externalLink">SC_GATEWAY_TIMEOUT</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_GONE" title="class or interface in javax.servlet.http" class="externalLink">SC_GONE</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_HTTP_VERSION_NOT_SUPPORTED" title="class or interface in javax.servlet.http" class="externalLink">SC_HTTP_VERSION_NOT_SUPPORTED</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_INTERNAL_SERVER_ERROR" title="class or interface in javax.servlet.http" class="externalLink">SC_INTERNAL_SERVER_ERROR</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_LENGTH_REQUIRED" title="class or interface in javax.servlet.http" class="externalLink">SC_LENGTH_REQUIRED</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_METHOD_NOT_ALLOWED" title="class or interface in javax.servlet.http" class="externalLink">SC_METHOD_NOT_ALLOWED</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_MOVED_PERMANENTLY" title="class or interface in javax.servlet.http" class="externalLink">SC_MOVED_PERMANENTLY</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_MOVED_TEMPORARILY" title="class or interface in javax.servlet.http" class="externalLink">SC_MOVED_TEMPORARILY</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_MULTIPLE_CHOICES" title="class or interface in javax.servlet.http" class="externalLink">SC_MULTIPLE_CHOICES</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_NO_CONTENT" title="class or interface in javax.servlet.http" class="externalLink">SC_NO_CONTENT</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_NON_AUTHORITATIVE_INFORMATION" title="class or interface in javax.servlet.http" class="externalLink">SC_NON_AUTHORITATIVE_INFORMATION</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_NOT_ACCEPTABLE" title="class or interface in javax.servlet.http" class="externalLink">SC_NOT_ACCEPTABLE</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_NOT_FOUND" title="class or interface in javax.servlet.http" class="externalLink">SC_NOT_FOUND</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_NOT_IMPLEMENTED" title="class or interface in javax.servlet.http" class="externalLink">SC_NOT_IMPLEMENTED</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_NOT_MODIFIED" title="class or interface in javax.servlet.http" class="externalLink">SC_NOT_MODIFIED</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_OK" title="class or interface in javax.servlet.http" class="externalLink">SC_OK</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_PARTIAL_CONTENT" title="class or interface in javax.servlet.http" class="externalLink">SC_PARTIAL_CONTENT</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_PAYMENT_REQUIRED" title="class or interface in javax.servlet.http" class="externalLink">SC_PAYMENT_REQUIRED</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_PRECONDITION_FAILED" title="class or interface in javax.servlet.http" class="externalLink">SC_PRECONDITION_FAILED</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_PROXY_AUTHENTICATION_REQUIRED" title="class or interface in javax.servlet.http" class="externalLink">SC_PROXY_AUTHENTICATION_REQUIRED</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_REQUEST_ENTITY_TOO_LARGE" title="class or interface in javax.servlet.http" class="externalLink">SC_REQUEST_ENTITY_TOO_LARGE</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_REQUEST_TIMEOUT" title="class or interface in javax.servlet.http" class="externalLink">SC_REQUEST_TIMEOUT</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_REQUEST_URI_TOO_LONG" title="class or interface in javax.servlet.http" class="externalLink">SC_REQUEST_URI_TOO_LONG</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_REQUESTED_RANGE_NOT_SATISFIABLE" title="class or interface in javax.servlet.http" class="externalLink">SC_REQUESTED_RANGE_NOT_SATISFIABLE</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_RESET_CONTENT" title="class or interface in javax.servlet.http" class="externalLink">SC_RESET_CONTENT</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_SEE_OTHER" title="class or interface in javax.servlet.http" class="externalLink">SC_SEE_OTHER</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_SERVICE_UNAVAILABLE" title="class or interface in javax.servlet.http" class="externalLink">SC_SERVICE_UNAVAILABLE</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_SWITCHING_PROTOCOLS" title="class or interface in javax.servlet.http" class="externalLink">SC_SWITCHING_PROTOCOLS</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_TEMPORARY_REDIRECT" title="class or interface in javax.servlet.http" class="externalLink">SC_TEMPORARY_REDIRECT</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_UNAUTHORIZED" title="class or interface in javax.servlet.http" class="externalLink">SC_UNAUTHORIZED</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_UNSUPPORTED_MEDIA_TYPE" title="class or interface in javax.servlet.http" class="externalLink">SC_UNSUPPORTED_MEDIA_TYPE</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#SC_USE_PROXY" title="class or interface in javax.servlet.http" class="externalLink">SC_USE_PROXY</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(javax.servlet.http.HttpServletResponse,javax.servlet.ServletContext,org.apache.shiro.web.servlet.ShiroHttpServletRequest)">ShiroHttpServletResponse</a></span>&#8203;(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletResponse</a>&nbsp;wrapped,
<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletContext.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletContext</a>&nbsp;context,
<a href="ShiroHttpServletRequest.html" title="class in org.apache.shiro.web.servlet">ShiroHttpServletRequest</a>&nbsp;request)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#encodeRedirectUrl(java.lang.String)">encodeRedirectUrl</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;s)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#encodeRedirectURL(java.lang.String)">encodeRedirectURL</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;url)</code></th>
<td class="colLast">
<div class="block">Encode the session identifier associated with this response
into the specified redirect URL, if necessary.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#encodeUrl(java.lang.String)">encodeUrl</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;s)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#encodeURL(java.lang.String)">encodeURL</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;url)</code></th>
<td class="colLast">
<div class="block">Encode the session identifier associated with this response
into the specified URL, if necessary.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletContext.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletContext</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContext()">getContext</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="ShiroHttpServletRequest.html" title="class in org.apache.shiro.web.servlet">ShiroHttpServletRequest</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequest()">getRequest</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEncodeable(java.lang.String)">isEncodeable</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;location)</code></th>
<td class="colLast">
<div class="block">Return <code>true</code> if the specified URL should be encoded with
a session identifier.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSchemeChar(char)">isSchemeChar</a></span>&#8203;(char&nbsp;c)</code></th>
<td class="colLast">
<div class="block">Determine if the character is allowed in the scheme of a URI.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setContext(javax.servlet.ServletContext)">setContext</a></span>&#8203;(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletContext.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletContext</a>&nbsp;context)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRequest(org.apache.shiro.web.servlet.ShiroHttpServletRequest)">setRequest</a></span>&#8203;(<a href="ShiroHttpServletRequest.html" title="class in org.apache.shiro.web.servlet">ShiroHttpServletRequest</a>&nbsp;request)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toEncoded(java.lang.String,java.lang.String)">toEncoded</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;url,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;sessionId)</code></th>
<td class="colLast">
<div class="block">Return the specified URL with the specified session identifier suitably encoded.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.javax.servlet.http.HttpServletResponseWrapper">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;javax.servlet.http.<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletResponseWrapper</a></h3>
<code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#addCookie(javax.servlet.http.Cookie)" title="class or interface in javax.servlet.http" class="externalLink">addCookie</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#addDateHeader(java.lang.String,long)" title="class or interface in javax.servlet.http" class="externalLink">addDateHeader</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#addHeader(java.lang.String,java.lang.String)" title="class or interface in javax.servlet.http" class="externalLink">addHeader</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#addIntHeader(java.lang.String,int)" title="class or interface in javax.servlet.http" class="externalLink">addIntHeader</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#containsHeader(java.lang.String)" title="class or interface in javax.servlet.http" class="externalLink">containsHeader</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#getHeader(java.lang.String)" title="class or interface in javax.servlet.http" class="externalLink">getHeader</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#getHeaderNames()" title="class or interface in javax.servlet.http" class="externalLink">getHeaderNames</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#getHeaders(java.lang.String)" title="class or interface in javax.servlet.http" class="externalLink">getHeaders</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#getStatus()" title="class or interface in javax.servlet.http" class="externalLink">getStatus</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#sendError(int)" title="class or interface in javax.servlet.http" class="externalLink">sendError</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#sendError(int,java.lang.String)" title="class or interface in javax.servlet.http" class="externalLink">sendError</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#sendRedirect(java.lang.String)" title="class or interface in javax.servlet.http" class="externalLink">sendRedirect</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#setDateHeader(java.lang.String,long)" title="class or interface in javax.servlet.http" class="externalLink">setDateHeader</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#setHeader(java.lang.String,java.lang.String)" title="class or interface in javax.servlet.http" class="externalLink">setHeader</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#setIntHeader(java.lang.String,int)" title="class or interface in javax.servlet.http" class="externalLink">setIntHeader</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#setStatus(int)" title="class or interface in javax.servlet.http" class="externalLink">setStatus</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#setStatus(int,java.lang.String)" title="class or interface in javax.servlet.http" class="externalLink">setStatus</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.javax.servlet.ServletResponseWrapper">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;javax.servlet.<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletResponseWrapper</a></h3>
<code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#flushBuffer()" title="class or interface in javax.servlet" class="externalLink">flushBuffer</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#getBufferSize()" title="class or interface in javax.servlet" class="externalLink">getBufferSize</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#getCharacterEncoding()" title="class or interface in javax.servlet" class="externalLink">getCharacterEncoding</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#getContentType()" title="class or interface in javax.servlet" class="externalLink">getContentType</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#getLocale()" title="class or interface in javax.servlet" class="externalLink">getLocale</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#getOutputStream()" title="class or interface in javax.servlet" class="externalLink">getOutputStream</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#getResponse()" title="class or interface in javax.servlet" class="externalLink">getResponse</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#getWriter()" title="class or interface in javax.servlet" class="externalLink">getWriter</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#isCommitted()" title="class or interface in javax.servlet" class="externalLink">isCommitted</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#isWrapperFor(java.lang.Class)" title="class or interface in javax.servlet" class="externalLink">isWrapperFor</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#isWrapperFor(javax.servlet.ServletResponse)" title="class or interface in javax.servlet" class="externalLink">isWrapperFor</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#reset()" title="class or interface in javax.servlet" class="externalLink">reset</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#resetBuffer()" title="class or interface in javax.servlet" class="externalLink">resetBuffer</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#setBufferSize(int)" title="class or interface in javax.servlet" class="externalLink">setBufferSize</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#setCharacterEncoding(java.lang.String)" title="class or interface in javax.servlet" class="externalLink">setCharacterEncoding</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#setContentLength(int)" title="class or interface in javax.servlet" class="externalLink">setContentLength</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#setContentLengthLong(long)" title="class or interface in javax.servlet" class="externalLink">setContentLengthLong</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#setContentType(java.lang.String)" title="class or interface in javax.servlet" class="externalLink">setContentType</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#setLocale(java.util.Locale)" title="class or interface in javax.servlet" class="externalLink">setLocale</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponseWrapper.html?is-external=true#setResponse(javax.servlet.ServletResponse)" title="class or interface in javax.servlet" class="externalLink">setResponse</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.javax.servlet.ServletResponse">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;javax.servlet.<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletResponse</a></h3>
<code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#flushBuffer()" title="class or interface in javax.servlet" class="externalLink">flushBuffer</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#getBufferSize()" title="class or interface in javax.servlet" class="externalLink">getBufferSize</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#getCharacterEncoding()" title="class or interface in javax.servlet" class="externalLink">getCharacterEncoding</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#getContentType()" title="class or interface in javax.servlet" class="externalLink">getContentType</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#getLocale()" title="class or interface in javax.servlet" class="externalLink">getLocale</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#getOutputStream()" title="class or interface in javax.servlet" class="externalLink">getOutputStream</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#getWriter()" title="class or interface in javax.servlet" class="externalLink">getWriter</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#isCommitted()" title="class or interface in javax.servlet" class="externalLink">isCommitted</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#reset()" title="class or interface in javax.servlet" class="externalLink">reset</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#resetBuffer()" title="class or interface in javax.servlet" class="externalLink">resetBuffer</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#setBufferSize(int)" title="class or interface in javax.servlet" class="externalLink">setBufferSize</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#setCharacterEncoding(java.lang.String)" title="class or interface in javax.servlet" class="externalLink">setCharacterEncoding</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#setContentLength(int)" title="class or interface in javax.servlet" class="externalLink">setContentLength</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#setContentLengthLong(long)" title="class or interface in javax.servlet" class="externalLink">setContentLengthLong</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#setContentType(java.lang.String)" title="class or interface in javax.servlet" class="externalLink">setContentType</a>, <a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletResponse.html?is-external=true#setLocale(java.util.Locale)" title="class or interface in javax.servlet" class="externalLink">setLocale</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(javax.servlet.http.HttpServletResponse,javax.servlet.ServletContext,org.apache.shiro.web.servlet.ShiroHttpServletRequest)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ShiroHttpServletResponse</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/servlet/ShiroHttpServletResponse.html#line.55">ShiroHttpServletResponse</a>&#8203;(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletResponse</a>&nbsp;wrapped,
<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletContext.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletContext</a>&nbsp;context,
<a href="ShiroHttpServletRequest.html" title="class in org.apache.shiro.web.servlet">ShiroHttpServletRequest</a>&nbsp;request)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContext</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletContext.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletContext</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/servlet/ShiroHttpServletResponse.html#line.61">getContext</a>()</pre>
</li>
</ul>
<a id="setContext(javax.servlet.ServletContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setContext</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/servlet/ShiroHttpServletResponse.html#line.66">setContext</a>&#8203;(<a href="https://docs.oracle.com/javaee/5/api/javax/servlet/ServletContext.html?is-external=true" title="class or interface in javax.servlet" class="externalLink">ServletContext</a>&nbsp;context)</pre>
</li>
</ul>
<a id="getRequest()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequest</h4>
<pre class="methodSignature">public&nbsp;<a href="ShiroHttpServletRequest.html" title="class in org.apache.shiro.web.servlet">ShiroHttpServletRequest</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/servlet/ShiroHttpServletResponse.html#line.71">getRequest</a>()</pre>
</li>
</ul>
<a id="setRequest(org.apache.shiro.web.servlet.ShiroHttpServletRequest)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRequest</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/servlet/ShiroHttpServletResponse.html#line.75">setRequest</a>&#8203;(<a href="ShiroHttpServletRequest.html" title="class in org.apache.shiro.web.servlet">ShiroHttpServletRequest</a>&nbsp;request)</pre>
</li>
</ul>
<a id="encodeRedirectURL(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeRedirectURL</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/servlet/ShiroHttpServletResponse.html#line.86">encodeRedirectURL</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;url)</pre>
<div class="block">Encode the session identifier associated with this response
into the specified redirect URL, if necessary.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#encodeRedirectURL(java.lang.String)" title="class or interface in javax.servlet.http" class="externalLink">encodeRedirectURL</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletResponse</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#encodeRedirectURL(java.lang.String)" title="class or interface in javax.servlet.http" class="externalLink">encodeRedirectURL</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletResponseWrapper</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - URL to be encoded</dd>
</dl>
</li>
</ul>
<a id="encodeRedirectUrl(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeRedirectUrl</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/servlet/ShiroHttpServletResponse.html#line.95">encodeRedirectUrl</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;s)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#encodeRedirectUrl(java.lang.String)" title="class or interface in javax.servlet.http" class="externalLink">encodeRedirectUrl</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletResponse</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#encodeRedirectUrl(java.lang.String)" title="class or interface in javax.servlet.http" class="externalLink">encodeRedirectUrl</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletResponseWrapper</a></code></dd>
</dl>
</li>
</ul>
<a id="encodeURL(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeURL</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/servlet/ShiroHttpServletResponse.html#line.106">encodeURL</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;url)</pre>
<div class="block">Encode the session identifier associated with this response
into the specified URL, if necessary.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#encodeURL(java.lang.String)" title="class or interface in javax.servlet.http" class="externalLink">encodeURL</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletResponse</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#encodeURL(java.lang.String)" title="class or interface in javax.servlet.http" class="externalLink">encodeURL</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletResponseWrapper</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - URL to be encoded</dd>
</dl>
</li>
</ul>
<a id="encodeUrl(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeUrl</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/servlet/ShiroHttpServletResponse.html#line.119">encodeUrl</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;s)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true#encodeUrl(java.lang.String)" title="class or interface in javax.servlet.http" class="externalLink">encodeUrl</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponse.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletResponse</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true#encodeUrl(java.lang.String)" title="class or interface in javax.servlet.http" class="externalLink">encodeUrl</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javaee/5/api/javax/servlet/http/HttpServletResponseWrapper.html?is-external=true" title="class or interface in javax.servlet.http" class="externalLink">HttpServletResponseWrapper</a></code></dd>
</dl>
</li>
</ul>
<a id="isEncodeable(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEncodeable</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/servlet/ShiroHttpServletResponse.html#line.137">isEncodeable</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;location)</pre>
<div class="block">Return <code>true</code> if the specified URL should be encoded with
a session identifier. This will be true if all of the following
conditions are met:
<ul>
<li>The request we are responding to asked for a valid session
<li>The requested session ID was not received via a cookie
<li>The specified URL points back to somewhere within the web
application that is responding to this request
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>location</code> - Absolute URL to be validated</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the specified URL should be encoded with a session identifier, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a id="isSchemeChar(char)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSchemeChar</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/servlet/ShiroHttpServletResponse.html#line.268">isSchemeChar</a>&#8203;(char&nbsp;c)</pre>
<div class="block">Determine if the character is allowed in the scheme of a URI.
See RFC 2396, Section 3.1</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>c</code> - the character to check</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the character is allowed in a URI scheme, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a id="toEncoded(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toEncoded</h4>
<pre class="methodSignature">protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;<a href="../../../../../src-html/org/apache/shiro/web/servlet/ShiroHttpServletResponse.html#line.300">toEncoded</a>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;url,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;sessionId)</pre>
<div class="block">Return the specified URL with the specified session identifier suitably encoded.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - URL to be encoded with the session id</dd>
<dd><code>sessionId</code> - Session id to be included in the encoded URL</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the url with the session identifer properly encoded.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ShiroHttpServletResponse.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>