blob: 41cbc43547c4d7e28bd4cbe55b962e0cf7631e04 [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>jakarta.ws.rs.ext</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="jakarta.ws.rs.ext";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>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="../../../../jakarta/ws/rs/core/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../jakarta/ws/rs/sse/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jakarta/ws/rs/ext/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;jakarta.ws.rs.ext</h1>
<div class="docSummary">
<div class="block">APIs that provide extensions to the types supported by the JAX-RS API.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/ext/ContextResolver.html" title="interface in jakarta.ws.rs.ext">ContextResolver</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Contract for a provider that supplies context information to resource classes and other providers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/ext/ExceptionMapper.html" title="interface in jakarta.ws.rs.ext">ExceptionMapper</a>&lt;E extends java.lang.Throwable&gt;</td>
<td class="colLast">
<div class="block">Contract for a provider that maps Java exceptions to <a href="../../../../jakarta/ws/rs/core/Response.html" title="class in jakarta.ws.rs.core"><code>Response</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/ext/InterceptorContext.html" title="interface in jakarta.ws.rs.ext">InterceptorContext</a></td>
<td class="colLast">
<div class="block">Context shared by message body interceptors that can be used to wrap calls to
<a href="../../../../jakarta/ws/rs/ext/MessageBodyReader.html#readFrom-java.lang.Class-java.lang.reflect.Type-java.lang.annotation.Annotation:A-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> and <a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html#writeTo-T-java.lang.Class-java.lang.reflect.Type-java.lang.annotation.Annotation:A-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>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/ext/MessageBodyReader.html" title="interface in jakarta.ws.rs.ext">MessageBodyReader</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Contract for a provider that supports the conversion of a stream to a Java type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html" title="interface in jakarta.ws.rs.ext">MessageBodyWriter</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Contract for a provider that supports the conversion of a Java type to a stream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/ext/ParamConverter.html" title="interface in jakarta.ws.rs.ext">ParamConverter</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Defines a contract for a delegate responsible for converting between a <code>String</code> form of a message parameter
value and the corresponding custom Java type <code>T</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/ext/ParamConverterProvider.html" title="interface in jakarta.ws.rs.ext">ParamConverterProvider</a></td>
<td class="colLast">
<div class="block">Contract for a provider of <a href="../../../../jakarta/ws/rs/ext/ParamConverter.html" title="interface in jakarta.ws.rs.ext"><code>ParamConverter</code></a> instances.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/ext/Providers.html" title="interface in jakarta.ws.rs.ext">Providers</a></td>
<td class="colLast">
<div class="block">An injectable interface providing runtime lookup of provider instances.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/ext/ReaderInterceptor.html" title="interface in jakarta.ws.rs.ext">ReaderInterceptor</a></td>
<td class="colLast">
<div class="block">Interface for message body reader interceptors that wrap around calls to
<a href="../../../../jakarta/ws/rs/ext/MessageBodyReader.html#readFrom-java.lang.Class-java.lang.reflect.Type-java.lang.annotation.Annotation:A-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>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/ext/ReaderInterceptorContext.html" title="interface in jakarta.ws.rs.ext">ReaderInterceptorContext</a></td>
<td class="colLast">
<div class="block">Context class used by <a href="../../../../jakarta/ws/rs/ext/ReaderInterceptor.html" title="interface in jakarta.ws.rs.ext"><code>ReaderInterceptor</code></a> to intercept calls to (@link
jakarta.ws.rs.ext.MessageBodyReader#readFrom}.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/ext/RuntimeDelegate.HeaderDelegate.html" title="interface in jakarta.ws.rs.ext">RuntimeDelegate.HeaderDelegate</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Defines the contract for a delegate that is responsible for converting between the String form of a HTTP header and
the corresponding JAX-RS type <code>T</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/ext/WriterInterceptor.html" title="interface in jakarta.ws.rs.ext">WriterInterceptor</a></td>
<td class="colLast">
<div class="block">Interface for message body writer interceptors that wrap around calls to
<a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html#writeTo-T-java.lang.Class-java.lang.reflect.Type-java.lang.annotation.Annotation:A-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>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/ext/WriterInterceptorContext.html" title="interface in jakarta.ws.rs.ext">WriterInterceptorContext</a></td>
<td class="colLast">
<div class="block">Context class used by <a href="../../../../jakarta/ws/rs/ext/WriterInterceptor.html" title="interface in jakarta.ws.rs.ext"><code>WriterInterceptor</code></a> to intercept calls to
<a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html#writeTo-T-java.lang.Class-java.lang.reflect.Type-java.lang.annotation.Annotation:A-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>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/ext/RuntimeDelegate.html" title="class in jakarta.ws.rs.ext">RuntimeDelegate</a></td>
<td class="colLast">
<div class="block">Implementations of JAX-RS provide a concrete subclass of RuntimeDelegate and various JAX-RS API methods defer to
methods of RuntimeDelegate for their functionality.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation">
<caption><span>Annotation Types Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Annotation Type</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/ext/ParamConverter.Lazy.html" title="annotation in jakarta.ws.rs.ext">ParamConverter.Lazy</a></td>
<td class="colLast">
<div class="block">Mandates that a conversion of any <a href="../../../../jakarta/ws/rs/DefaultValue.html" title="annotation in jakarta.ws.rs"><code>default value</code></a> delegated to a <a href="../../../../jakarta/ws/rs/ext/ParamConverter.html" title="interface in jakarta.ws.rs.ext"><code>parameter
converter</code></a> annotated with <code>@Lazy</code> annotation SHOULD occur only once the value is actually required (e.g.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/ext/Provider.html" title="annotation in jakarta.ws.rs.ext">Provider</a></td>
<td class="colLast">
<div class="block">Marks an implementation of an extension interface that should be discoverable by JAX-RS runtime during a provider
scanning phase.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package jakarta.ws.rs.ext Description">Package jakarta.ws.rs.ext Description</h2>
<div class="block">APIs that provide extensions to the types supported by the JAX-RS API.</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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="../../../../jakarta/ws/rs/core/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../jakarta/ws/rs/sse/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jakarta/ws/rs/ext/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>