blob: 98e726c3a898faf68a69be861096c7f3b2b847a4 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.2) on Wed Sep 23 17:36:24 GMT 2020 -->
<title>Uses of Class jakarta.ws.rs.WebApplicationException (jakarta.ws.rs-api 3.0.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-09-23">
<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.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.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="Uses of Class jakarta.ws.rs.WebApplicationException (jakarta.ws.rs-api 3.0.0 API)";
}
}
catch(err) {
}
//-->
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">
<!-- ========= 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><a href="../WebApplicationException.html" title="class in jakarta.ws.rs">Class</a></li>
<li class="navBarCell1Rev">Use</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>
<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>
<main role="main">
<div class="header">
<h2 title="Uses of Class jakarta.ws.rs.WebApplicationException" class="title">Uses of Class<br>jakarta.ws.rs.WebApplicationException</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary">
<caption><span>Packages that use <a href="../WebApplicationException.html" title="class in jakarta.ws.rs">WebApplicationException</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#jakarta.ws.rs">jakarta.ws.rs</a></th>
<td class="colLast">
<div class="block">High-level interfaces and annotations used to create RESTful service resources.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#jakarta.ws.rs.core">jakarta.ws.rs.core</a></th>
<td class="colLast">
<div class="block">Low-level interfaces and annotations used to create RESTful service resources.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#jakarta.ws.rs.ext">jakarta.ws.rs.ext</a></th>
<td class="colLast">
<div class="block">APIs that provide extensions to the types supported by the JAX-RS API.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList">
<section role="region"><a id="jakarta.ws.rs">
<!-- -->
</a>
<h3>Uses of <a href="../WebApplicationException.html" title="class in jakarta.ws.rs">WebApplicationException</a> in <a href="../package-summary.html">jakarta.ws.rs</a></h3>
<table class="useSummary">
<caption><span>Subclasses of <a href="../WebApplicationException.html" title="class in jakarta.ws.rs">WebApplicationException</a> in <a href="../package-summary.html">jakarta.ws.rs</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../BadRequestException.html" title="class in jakarta.ws.rs">BadRequestException</a></span></code></th>
<td class="colLast">
<div class="block">A runtime exception indicating a <a href="../core/Response.Status.html#BAD_REQUEST"><code>bad client request</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../ClientErrorException.html" title="class in jakarta.ws.rs">ClientErrorException</a></span></code></th>
<td class="colLast">
<div class="block">A base runtime application exception indicating a client request error (HTTP <code>4xx</code> status codes).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../ForbiddenException.html" title="class in jakarta.ws.rs">ForbiddenException</a></span></code></th>
<td class="colLast">
<div class="block">A runtime exception indicating that an access to a resource requested by a client has been
<a href="../core/Response.Status.html#FORBIDDEN"><code>forbidden</code></a> by the server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../InternalServerErrorException.html" title="class in jakarta.ws.rs">InternalServerErrorException</a></span></code></th>
<td class="colLast">
<div class="block">A runtime exception indicating an <a href="../core/Response.Status.html#INTERNAL_SERVER_ERROR"><code>internal server
error</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../NotAcceptableException.html" title="class in jakarta.ws.rs">NotAcceptableException</a></span></code></th>
<td class="colLast">
<div class="block">A runtime exception indicating that a client request is <a href="../core/Response.Status.html#NOT_ACCEPTABLE"><code>not
acceptable</code></a> by the server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../NotAllowedException.html" title="class in jakarta.ws.rs">NotAllowedException</a></span></code></th>
<td class="colLast">
<div class="block">A runtime exception indicating a client requesting a resource method that is
<a href="../core/Response.Status.html#METHOD_NOT_ALLOWED"><code>not allowed</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../NotAuthorizedException.html" title="class in jakarta.ws.rs">NotAuthorizedException</a></span></code></th>
<td class="colLast">
<div class="block">A runtime exception indicating request authorization failure caused by one of the following scenarios:
a client did not send the required authorization credentials to access the requested resource, i.e.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../NotFoundException.html" title="class in jakarta.ws.rs">NotFoundException</a></span></code></th>
<td class="colLast">
<div class="block">A runtime exception indicating a resource requested by a client was <a href="../core/Response.Status.html#NOT_FOUND"><code>not found</code></a> on the server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../NotSupportedException.html" title="class in jakarta.ws.rs">NotSupportedException</a></span></code></th>
<td class="colLast">
<div class="block">A runtime exception indicating that the client request entity media type is
<a href="../core/Response.Status.html#UNSUPPORTED_MEDIA_TYPE"><code>not supported</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../RedirectionException.html" title="class in jakarta.ws.rs">RedirectionException</a></span></code></th>
<td class="colLast">
<div class="block">A runtime application exception indicating a request redirection (HTTP <code>3xx</code> status codes).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../ServerErrorException.html" title="class in jakarta.ws.rs">ServerErrorException</a></span></code></th>
<td class="colLast">
<div class="block">A base runtime application exception indicating a server error (HTTP <code>5xx</code> status codes).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../ServiceUnavailableException.html" title="class in jakarta.ws.rs">ServiceUnavailableException</a></span></code></th>
<td class="colLast">
<div class="block">A runtime exception indicating that the requested resource
<a href="../core/Response.Status.html#SERVICE_UNAVAILABLE"><code>cannot be served</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section role="region"><a id="jakarta.ws.rs.core">
<!-- -->
</a>
<h3>Uses of <a href="../WebApplicationException.html" title="class in jakarta.ws.rs">WebApplicationException</a> in <a href="../core/package-summary.html">jakarta.ws.rs.core</a></h3>
<table class="useSummary">
<caption><span>Methods in <a href="../core/package-summary.html">jakarta.ws.rs.core</a> that throw <a href="../WebApplicationException.html" title="class in jakarta.ws.rs">WebApplicationException</a></span><span class="tabEnd">&nbsp;</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>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">StreamingOutput.</span><code><span class="memberNameLink"><a href="../core/StreamingOutput.html#write(java.io.OutputStream)">write</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a>&nbsp;output)</code></th>
<td class="colLast">
<div class="block">Called to write the message body.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section role="region"><a id="jakarta.ws.rs.ext">
<!-- -->
</a>
<h3>Uses of <a href="../WebApplicationException.html" title="class in jakarta.ws.rs">WebApplicationException</a> in <a href="../ext/package-summary.html">jakarta.ws.rs.ext</a></h3>
<table class="useSummary">
<caption><span>Methods in <a href="../ext/package-summary.html">jakarta.ws.rs.ext</a> that throw <a href="../WebApplicationException.html" title="class in jakarta.ws.rs">WebApplicationException</a></span><span class="tabEnd">&nbsp;</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>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ReaderInterceptor.</span><code><span class="memberNameLink"><a href="../ext/ReaderInterceptor.html#aroundReadFrom(jakarta.ws.rs.ext.ReaderInterceptorContext)">aroundReadFrom</a></span>&#8203;(<a href="../ext/ReaderInterceptorContext.html" title="interface in jakarta.ws.rs.ext">ReaderInterceptorContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Interceptor method wrapping calls to <a href="../ext/MessageBodyReader.html#readFrom(java.lang.Class,java.lang.reflect.Type,java.lang.annotation.Annotation%5B%5D,jakarta.ws.rs.core.MediaType,jakarta.ws.rs.core.MultivaluedMap,java.io.InputStream)"><code>MessageBodyReader.readFrom(java.lang.Class&lt;T&gt;, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap&lt;java.lang.String, java.lang.String&gt;, java.io.InputStream)</code></a> method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">WriterInterceptor.</span><code><span class="memberNameLink"><a href="../ext/WriterInterceptor.html#aroundWriteTo(jakarta.ws.rs.ext.WriterInterceptorContext)">aroundWriteTo</a></span>&#8203;(<a href="../ext/WriterInterceptorContext.html" title="interface in jakarta.ws.rs.ext">WriterInterceptorContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Interceptor method wrapping calls to <a href="../ext/MessageBodyWriter.html#writeTo(T,java.lang.Class,java.lang.reflect.Type,java.lang.annotation.Annotation%5B%5D,jakarta.ws.rs.core.MediaType,jakarta.ws.rs.core.MultivaluedMap,java.io.OutputStream)"><code>MessageBodyWriter.writeTo(T, java.lang.Class&lt;?&gt;, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap&lt;java.lang.String, java.lang.Object&gt;, java.io.OutputStream)</code></a> method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ReaderInterceptorContext.</span><code><span class="memberNameLink"><a href="../ext/ReaderInterceptorContext.html#proceed()">proceed</a></span>()</code></th>
<td class="colLast">
<div class="block">Proceed to the next interceptor in the chain.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">WriterInterceptorContext.</span><code><span class="memberNameLink"><a href="../ext/WriterInterceptorContext.html#proceed()">proceed</a></span>()</code></th>
<td class="colLast">
<div class="block">Proceed to the next interceptor in the chain.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../ext/MessageBodyReader.html" title="type parameter in MessageBodyReader">T</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">MessageBodyReader.</span><code><span class="memberNameLink"><a href="../ext/MessageBodyReader.html#readFrom(java.lang.Class,java.lang.reflect.Type,java.lang.annotation.Annotation%5B%5D,jakarta.ws.rs.core.MediaType,jakarta.ws.rs.core.MultivaluedMap,java.io.InputStream)">readFrom</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;<a href="../ext/MessageBodyReader.html" title="type parameter in MessageBodyReader">T</a>&gt;&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect" class="externalLink">Type</a>&nbsp;genericType,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation" class="externalLink">Annotation</a>[]&nbsp;annotations,
<a href="../core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&nbsp;mediaType,
<a href="../core/MultivaluedMap.html" title="interface in jakarta.ws.rs.core">MultivaluedMap</a>&lt;<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>,&#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>&gt;&nbsp;httpHeaders,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">InputStream</a>&nbsp;entityStream)</code></th>
<td class="colLast">
<div class="block">Read a type from the <a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io" class="externalLink"><code>InputStream</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">MessageBodyWriter.</span><code><span class="memberNameLink"><a href="../ext/MessageBodyWriter.html#writeTo(T,java.lang.Class,java.lang.reflect.Type,java.lang.annotation.Annotation%5B%5D,jakarta.ws.rs.core.MediaType,jakarta.ws.rs.core.MultivaluedMap,java.io.OutputStream)">writeTo</a></span>&#8203;(<a href="../ext/MessageBodyWriter.html" title="type parameter in MessageBodyWriter">T</a>&nbsp;t,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;&nbsp;type,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect" class="externalLink">Type</a>&nbsp;genericType,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation" class="externalLink">Annotation</a>[]&nbsp;annotations,
<a href="../core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&nbsp;mediaType,
<a href="../core/MultivaluedMap.html" title="interface in jakarta.ws.rs.core">MultivaluedMap</a>&lt;<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>,&#8203;<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>&gt;&nbsp;httpHeaders,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io" class="externalLink">OutputStream</a>&nbsp;entityStream)</code></th>
<td class="colLast">
<div class="block">Write a type to an HTTP message.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
</ul>
</li>
</ul>
</div>
</main>
<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><a href="../WebApplicationException.html" title="class in jakarta.ws.rs">Class</a></li>
<li class="navBarCell1Rev">Use</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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small><p align="left">Copyright &#169; 2018, 2020 Eclipse Foundation.<br>Use is subject to <a href="../../../../resources/EFSL.html" target="_top">license terms</a>.</small></p>
</footer>
</body>
</html>