Google Git
Sign in
apache / tomee-site-pub / 43cf80e624a0cecf0f38bef5ef2614bfb2410f57 / . / jakartaee-9.0 / javadoc / jakarta / ws / rs / core / package-summary.html
blob: eed8e48afe3a5724d4df069e45149b643a811e4a [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.core</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.core";
}
}
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/container/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../jakarta/ws/rs/ext/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jakarta/ws/rs/core/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.core</h1>
<div class="docSummary">
<div class="block">Low-level interfaces and annotations used to create RESTful service resources.</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/core/Configurable.html" title="interface in jakarta.ws.rs.core">Configurable</a>&lt;C extends <a href="../../../../jakarta/ws/rs/core/Configurable.html" title="interface in jakarta.ws.rs.core">Configurable</a>&gt;</td>
<td class="colLast">
<div class="block">Represents a client or server-side configurable context in JAX-RS.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/Configuration.html" title="interface in jakarta.ws.rs.core">Configuration</a></td>
<td class="colLast">
<div class="block">A configuration state associated with a <a href="../../../../jakarta/ws/rs/core/Configurable.html" title="interface in jakarta.ws.rs.core"><code>configurable</code></a> JAX-RS context.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/Feature.html" title="interface in jakarta.ws.rs.core">Feature</a></td>
<td class="colLast">
<div class="block">A feature extension contract.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/FeatureContext.html" title="interface in jakarta.ws.rs.core">FeatureContext</a></td>
<td class="colLast">
<div class="block">A configurable context passed to <a href="../../../../jakarta/ws/rs/core/Feature.html" title="interface in jakarta.ws.rs.core"><code>Feature</code></a> and <a href="../../../../jakarta/ws/rs/container/DynamicFeature.html" title="interface in jakarta.ws.rs.container"><code>DynamicFeature</code></a> instances by JAX-RS
runtime during the phase of their configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/HttpHeaders.html" title="interface in jakarta.ws.rs.core">HttpHeaders</a></td>
<td class="colLast">
<div class="block">An injectable interface that provides access to HTTP header information.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/Link.Builder.html" title="interface in jakarta.ws.rs.core">Link.Builder</a></td>
<td class="colLast">
<div class="block">Builder class for hypermedia links.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/MultivaluedMap.html" title="interface in jakarta.ws.rs.core">MultivaluedMap</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">A map of key-values pairs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/PathSegment.html" title="interface in jakarta.ws.rs.core">PathSegment</a></td>
<td class="colLast">
<div class="block">Represents a URI path segment and any associated matrix parameters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/Request.html" title="interface in jakarta.ws.rs.core">Request</a></td>
<td class="colLast">
<div class="block">An injectable helper for request processing, all methods throw an <code>IllegalStateException</code> if called outside the
scope of a request (e.g.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/Response.StatusType.html" title="interface in jakarta.ws.rs.core">Response.StatusType</a></td>
<td class="colLast">
<div class="block">Base interface for statuses used in responses.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/SecurityContext.html" title="interface in jakarta.ws.rs.core">SecurityContext</a></td>
<td class="colLast">
<div class="block">An injectable interface that provides access to security related information.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/StreamingOutput.html" title="interface in jakarta.ws.rs.core">StreamingOutput</a></td>
<td class="colLast">
<div class="block">A type that may be used as a resource method return value or as the entity in a <a href="../../../../jakarta/ws/rs/core/Response.html" title="class in jakarta.ws.rs.core"><code>Response</code></a> when the application
wishes to stream the output.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/UriInfo.html" title="interface in jakarta.ws.rs.core">UriInfo</a></td>
<td class="colLast">
<div class="block">An injectable interface that provides access to application and request URI information.</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/core/AbstractMultivaluedMap.html" title="class in jakarta.ws.rs.core">AbstractMultivaluedMap</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">Abstract skeleton implementation of a <a href="../../../../jakarta/ws/rs/core/MultivaluedMap.html" title="interface in jakarta.ws.rs.core"><code>MultivaluedMap</code></a> that is backed by a [key, multi-value] store represented
as a <code>Map&lt;K, List&lt;V&gt;&gt;</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/Application.html" title="class in jakarta.ws.rs.core">Application</a></td>
<td class="colLast">
<div class="block">Defines the components of a JAX-RS application and supplies additional meta-data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/CacheControl.html" title="class in jakarta.ws.rs.core">CacheControl</a></td>
<td class="colLast">
<div class="block">An abstraction for the value of a HTTP Cache-Control response header.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/Cookie.html" title="class in jakarta.ws.rs.core">Cookie</a></td>
<td class="colLast">
<div class="block">Represents the value of a HTTP cookie, transferred in a request.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/EntityTag.html" title="class in jakarta.ws.rs.core">EntityTag</a></td>
<td class="colLast">
<div class="block">An abstraction for the value of a HTTP Entity Tag, used as the value of an ETag response header.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/Form.html" title="class in jakarta.ws.rs.core">Form</a></td>
<td class="colLast">
<div class="block">Represents the the HTML form data request entity encoded using the <code>"application/x-www-form-urlencoded"</code>
content type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/GenericEntity.html" title="class in jakarta.ws.rs.core">GenericEntity</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Represents a message entity of a generic type <code>T</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/GenericType.html" title="class in jakarta.ws.rs.core">GenericType</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Represents a generic message entity type <code>T</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/Link.html" title="class in jakarta.ws.rs.core">Link</a></td>
<td class="colLast">
<div class="block">
Class representing hypermedia links.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/Link.JaxbAdapter.html" title="class in jakarta.ws.rs.core">Link.JaxbAdapter</a></td>
<td class="colLast">
<div class="block">An implementation of JAXB <a href="../../../../jakarta/xml/bind/annotation/adapters/XmlAdapter.html" title="class in jakarta.xml.bind.annotation.adapters"><code>XmlAdapter</code></a> that maps the JAX-RS
<a href="../../../../jakarta/ws/rs/core/Link.html" title="class in jakarta.ws.rs.core"><code>Link</code></a> type to a value that can be marshalled and unmarshalled by JAXB.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/Link.JaxbLink.html" title="class in jakarta.ws.rs.core">Link.JaxbLink</a></td>
<td class="colLast">
<div class="block">Value type for <a href="../../../../jakarta/ws/rs/core/Link.html" title="class in jakarta.ws.rs.core"><code>Link</code></a> that can be marshalled and
unmarshalled by JAXB.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a></td>
<td class="colLast">
<div class="block">An abstraction for a media type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/MultivaluedHashMap.html" title="class in jakarta.ws.rs.core">MultivaluedHashMap</a>&lt;K,V&gt;</td>
<td class="colLast">
<div class="block">A hash table based implementation of <a href="../../../../jakarta/ws/rs/core/MultivaluedMap.html" title="interface in jakarta.ws.rs.core"><code>MultivaluedMap</code></a> interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/NewCookie.html" title="class in jakarta.ws.rs.core">NewCookie</a></td>
<td class="colLast">
<div class="block">Used to create a new HTTP cookie, transferred in a response.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/Response.html" title="class in jakarta.ws.rs.core">Response</a></td>
<td class="colLast">
<div class="block">Defines the contract between a returned instance and the runtime when an application needs to provide meta-data to
the runtime.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/Response.ResponseBuilder.html" title="class in jakarta.ws.rs.core">Response.ResponseBuilder</a></td>
<td class="colLast">
<div class="block">A class used to build Response instances that contain metadata instead of or in addition to an entity.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/UriBuilder.html" title="class in jakarta.ws.rs.core">UriBuilder</a></td>
<td class="colLast">
<div class="block">URI template-aware utility class for building URIs from their components.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/Variant.html" title="class in jakarta.ws.rs.core">Variant</a></td>
<td class="colLast">
<div class="block">Abstraction for a resource representation variant.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/Variant.VariantListBuilder.html" title="class in jakarta.ws.rs.core">Variant.VariantListBuilder</a></td>
<td class="colLast">
<div class="block">A builder for a list of representation variants.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/Response.Status.html" title="enum in jakarta.ws.rs.core">Response.Status</a></td>
<td class="colLast">
<div class="block">Commonly used status codes defined by HTTP, see
<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10">HTTP/1.1 documentation</a> for the complete
list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/Response.Status.Family.html" title="enum in jakarta.ws.rs.core">Response.Status.Family</a></td>
<td class="colLast">
<div class="block">An enumeration representing the class of status code.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/NoContentException.html" title="class in jakarta.ws.rs.core">NoContentException</a></td>
<td class="colLast">
<div class="block">An I/O exception thrown by <a href="../../../../jakarta/ws/rs/ext/MessageBodyReader.html" title="interface in jakarta.ws.rs.ext"><code>MessageBodyReader</code></a> implementations when reading a zero-length
message content to indicate that the message body reader is not able to produce an instance representing an
zero-length message content.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../jakarta/ws/rs/core/UriBuilderException.html" title="class in jakarta.ws.rs.core">UriBuilderException</a></td>
<td class="colLast">
<div class="block">A runtime exception thrown by <a href="../../../../jakarta/ws/rs/core/UriBuilder.html#build-java.lang.Object...-"><code>UriBuilder.build(Object...)</code></a> methods when a <code>URI</code> cannot be
constructed based on the current state of the builder.</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/core/Context.html" title="annotation in jakarta.ws.rs.core">Context</a></td>
<td class="colLast">
<div class="block">This annotation is used to inject information into a class field, bean property or method parameter.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package jakarta.ws.rs.core Description">Package jakarta.ws.rs.core Description</h2>
<div class="block">Low-level interfaces and annotations used to create RESTful service resources.</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/container/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../jakarta/ws/rs/ext/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jakarta/ws/rs/core/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>