blob: 09fb5b5c49f97167ad815e39b3c0dc19b035358f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>RedirectionException</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RedirectionException";
}
}
catch(err) {
}
//-->
var methods = {"i0":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<li><a href="../../../javax/ws/rs/QueryParam.html" title="annotation in javax.ws.rs"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/ws/rs/RuntimeType.html" title="enum in javax.ws.rs"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/ws/rs/RedirectionException.html" target="_top">Frames</a></li>
<li><a href="RedirectionException.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">javax.ws.rs</div>
<h2 title="Class RedirectionException" class="title">Class RedirectionException</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li>
<ul class="inheritance">
<li>java.lang.RuntimeException</li>
<li>
<ul class="inheritance">
<li><a href="../../../javax/ws/rs/WebApplicationException.html" title="class in javax.ws.rs">javax.ws.rs.WebApplicationException</a></li>
<li>
<ul class="inheritance">
<li>javax.ws.rs.RedirectionException</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">RedirectionException</span>
extends <a href="../../../javax/ws/rs/WebApplicationException.html" title="class in javax.ws.rs">WebApplicationException</a></pre>
<div class="block">A runtime application exception indicating a request redirection
(HTTP <code>3xx</code> status codes).</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../serialized-form.html#javax.ws.rs.RedirectionException">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../javax/ws/rs/RedirectionException.html#RedirectionException-int-java.net.URI-">RedirectionException</a></span>(int&nbsp;status,
java.net.URI&nbsp;location)</code>
<div class="block">Construct a new redirection exception.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../javax/ws/rs/RedirectionException.html#RedirectionException-javax.ws.rs.core.Response.Status-java.net.URI-">RedirectionException</a></span>(<a href="../../../javax/ws/rs/core/Response.Status.html" title="enum in javax.ws.rs.core">Response.Status</a>&nbsp;status,
java.net.URI&nbsp;location)</code>
<div class="block">Construct a new redirection exception.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../javax/ws/rs/RedirectionException.html#RedirectionException-javax.ws.rs.core.Response-">RedirectionException</a></span>(<a href="../../../javax/ws/rs/core/Response.html" title="class in javax.ws.rs.core">Response</a>&nbsp;response)</code>
<div class="block">Construct a new redirection exception.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../javax/ws/rs/RedirectionException.html#RedirectionException-java.lang.String-int-java.net.URI-">RedirectionException</a></span>(java.lang.String&nbsp;message,
int&nbsp;status,
java.net.URI&nbsp;location)</code>
<div class="block">Construct a new redirection exception.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../javax/ws/rs/RedirectionException.html#RedirectionException-java.lang.String-javax.ws.rs.core.Response.Status-java.net.URI-">RedirectionException</a></span>(java.lang.String&nbsp;message,
<a href="../../../javax/ws/rs/core/Response.Status.html" title="enum in javax.ws.rs.core">Response.Status</a>&nbsp;status,
java.net.URI&nbsp;location)</code>
<div class="block">Construct a new redirection exception.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../javax/ws/rs/RedirectionException.html#RedirectionException-java.lang.String-javax.ws.rs.core.Response-">RedirectionException</a></span>(java.lang.String&nbsp;message,
<a href="../../../javax/ws/rs/core/Response.html" title="class in javax.ws.rs.core">Response</a>&nbsp;response)</code>
<div class="block">Construct a new redirection exception.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.net.URI</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/ws/rs/RedirectionException.html#getLocation--">getLocation</a></span>()</code>
<div class="block">Get the redirection response location.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.ws.rs.WebApplicationException">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;javax.ws.rs.<a href="../../../javax/ws/rs/WebApplicationException.html" title="class in javax.ws.rs">WebApplicationException</a></h3>
<code><a href="../../../javax/ws/rs/WebApplicationException.html#getResponse--">getResponse</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="RedirectionException-javax.ws.rs.core.Response.Status-java.net.URI-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RedirectionException</h4>
<pre>public&nbsp;RedirectionException(<a href="../../../javax/ws/rs/core/Response.Status.html" title="enum in javax.ws.rs.core">Response.Status</a>&nbsp;status,
java.net.URI&nbsp;location)</pre>
<div class="block">Construct a new redirection exception.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>status</code> - redirection status. Must be a <code>3xx</code> redirection code.</dd>
<dd><code>location</code> - redirection URI placed into the response <code>Location</code> header.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - in case the status code is <code>null</code> or is not from
<a href="../../../javax/ws/rs/core/Response.Status.Family.html#REDIRECTION"><code>Response.Status.Family.REDIRECTION</code></a> status code
family.</dd>
</dl>
</li>
</ul>
<a name="RedirectionException-java.lang.String-javax.ws.rs.core.Response.Status-java.net.URI-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RedirectionException</h4>
<pre>public&nbsp;RedirectionException(java.lang.String&nbsp;message,
<a href="../../../javax/ws/rs/core/Response.Status.html" title="enum in javax.ws.rs.core">Response.Status</a>&nbsp;status,
java.net.URI&nbsp;location)</pre>
<div class="block">Construct a new redirection exception.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - the detail message (which is saved for later retrieval
by the <code>Throwable.getMessage()</code> method).</dd>
<dd><code>status</code> - redirection status. Must be a <code>3xx</code> redirection code.</dd>
<dd><code>location</code> - redirection URI placed into the response <code>Location</code> header.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - in case the status code is <code>null</code> or is not from
<a href="../../../javax/ws/rs/core/Response.Status.Family.html#REDIRECTION"><code>Response.Status.Family.REDIRECTION</code></a> status code
family.</dd>
</dl>
</li>
</ul>
<a name="RedirectionException-int-java.net.URI-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RedirectionException</h4>
<pre>public&nbsp;RedirectionException(int&nbsp;status,
java.net.URI&nbsp;location)</pre>
<div class="block">Construct a new redirection exception.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>status</code> - redirection status. Must be a <code>3xx</code> redirection code.</dd>
<dd><code>location</code> - redirection URI placed into the response <code>Location</code> header.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - in case the status code is not a valid HTTP status code or
if it is not from the <a href="../../../javax/ws/rs/core/Response.Status.Family.html#REDIRECTION"><code>Response.Status.Family.REDIRECTION</code></a>
status code family.</dd>
</dl>
</li>
</ul>
<a name="RedirectionException-java.lang.String-int-java.net.URI-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RedirectionException</h4>
<pre>public&nbsp;RedirectionException(java.lang.String&nbsp;message,
int&nbsp;status,
java.net.URI&nbsp;location)</pre>
<div class="block">Construct a new redirection exception.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - the detail message (which is saved for later retrieval
by the <code>Throwable.getMessage()</code> method).</dd>
<dd><code>status</code> - redirection status. Must be a <code>3xx</code> redirection code.</dd>
<dd><code>location</code> - redirection URI placed into the response <code>Location</code> header.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - in case the status code is not a valid HTTP status code or
if it is not from the <a href="../../../javax/ws/rs/core/Response.Status.Family.html#REDIRECTION"><code>Response.Status.Family.REDIRECTION</code></a>
status code family.</dd>
</dl>
</li>
</ul>
<a name="RedirectionException-javax.ws.rs.core.Response-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RedirectionException</h4>
<pre>public&nbsp;RedirectionException(<a href="../../../javax/ws/rs/core/Response.html" title="class in javax.ws.rs.core">Response</a>&nbsp;response)</pre>
<div class="block">Construct a new redirection exception.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>response</code> - redirection response. Must have a status code set to a <code>3xx</code>
redirection code.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - in case the response status code is not from the
<a href="../../../javax/ws/rs/core/Response.Status.Family.html#REDIRECTION"><code>Response.Status.Family.REDIRECTION</code></a> status code family.</dd>
</dl>
</li>
</ul>
<a name="RedirectionException-java.lang.String-javax.ws.rs.core.Response-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RedirectionException</h4>
<pre>public&nbsp;RedirectionException(java.lang.String&nbsp;message,
<a href="../../../javax/ws/rs/core/Response.html" title="class in javax.ws.rs.core">Response</a>&nbsp;response)</pre>
<div class="block">Construct a new redirection exception.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - the detail message (which is saved for later retrieval
by the <code>Throwable.getMessage()</code> method).</dd>
<dd><code>response</code> - redirection response. Must have a status code set to a <code>3xx</code>
redirection code.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - in case the response status code is not from the
<a href="../../../javax/ws/rs/core/Response.Status.Family.html#REDIRECTION"><code>Response.Status.Family.REDIRECTION</code></a> status code family.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getLocation--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLocation</h4>
<pre>public&nbsp;java.net.URI&nbsp;getLocation()</pre>
<div class="block">Get the redirection response location.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>redirection response location.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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">
<li><a href="../../../javax/ws/rs/QueryParam.html" title="annotation in javax.ws.rs"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/ws/rs/RuntimeType.html" title="enum in javax.ws.rs"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/ws/rs/RedirectionException.html" target="_top">Frames</a></li>
<li><a href="RedirectionException.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>