| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (12) on Mon Aug 12 13:20:58 GMT 2019 --> |
| <title>javax.ws.rs (jakarta.ws.rs-api 2.1.6 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2019-08-12"> |
| <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="javax.ws.rs (jakarta.ws.rs-api 2.1.6 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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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="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> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package javax.ws.rs</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block">High-level interfaces and annotations used to create RESTful service |
| resources. For example: |
| <pre> |
| @Path("widgets/{widgetid}") |
| @Consumes("application/widgets+xml") |
| @Produces("application/widgets+xml") |
| public class WidgetResource { |
| |
| @GET |
| public String getWidget(@PathParam("widgetid") String id) { |
| return getWidgetAsXml(id); |
| } |
| |
| @PUT |
| public void updateWidget(@PathParam("widgetid") String id, |
| Source update) { |
| updateWidgetFromXml(id, update); |
| } |
| |
| ... |
| } |
| </pre></div> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <div class="typeSummary"> |
| <table> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Priorities.html" title="class in javax.ws.rs">Priorities</a></th> |
| <td class="colLast"> |
| <div class="block">A collection of built-in priority constants for the components that are supposed to be |
| ordered based on their <code>javax.annotation.Priority</code> class-level annotation value when used |
| or applied by the runtime.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </li> |
| <li class="blockList"> |
| <div class="typeSummary"> |
| <table> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RuntimeType.html" title="enum in javax.ws.rs">RuntimeType</a></th> |
| <td class="colLast"> |
| <div class="block">Enumeration of runtime types.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </li> |
| <li class="blockList"> |
| <div class="typeSummary"> |
| <table> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="BadRequestException.html" title="class in javax.ws.rs">BadRequestException</a></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"> |
| <th class="colFirst" scope="row"><a href="ClientErrorException.html" title="class in javax.ws.rs">ClientErrorException</a></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"> |
| <th class="colFirst" scope="row"><a href="ForbiddenException.html" title="class in javax.ws.rs">ForbiddenException</a></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"> |
| <th class="colFirst" scope="row"><a href="InternalServerErrorException.html" title="class in javax.ws.rs">InternalServerErrorException</a></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"> |
| <th class="colFirst" scope="row"><a href="NotAcceptableException.html" title="class in javax.ws.rs">NotAcceptableException</a></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"> |
| <th class="colFirst" scope="row"><a href="NotAllowedException.html" title="class in javax.ws.rs">NotAllowedException</a></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"> |
| <th class="colFirst" scope="row"><a href="NotAuthorizedException.html" title="class in javax.ws.rs">NotAuthorizedException</a></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"> |
| <th class="colFirst" scope="row"><a href="NotFoundException.html" title="class in javax.ws.rs">NotFoundException</a></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"> |
| <th class="colFirst" scope="row"><a href="NotSupportedException.html" title="class in javax.ws.rs">NotSupportedException</a></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"> |
| <th class="colFirst" scope="row"><a href="ProcessingException.html" title="class in javax.ws.rs">ProcessingException</a></th> |
| <td class="colLast"> |
| <div class="block">A base runtime processing exception.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="RedirectionException.html" title="class in javax.ws.rs">RedirectionException</a></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="rowColor"> |
| <th class="colFirst" scope="row"><a href="ServerErrorException.html" title="class in javax.ws.rs">ServerErrorException</a></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="altColor"> |
| <th class="colFirst" scope="row"><a href="ServiceUnavailableException.html" title="class in javax.ws.rs">ServiceUnavailableException</a></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> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="WebApplicationException.html" title="class in javax.ws.rs">WebApplicationException</a></th> |
| <td class="colLast"> |
| <div class="block">Runtime exception for applications.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </li> |
| <li class="blockList"> |
| <div class="typeSummary"> |
| <table> |
| <caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Annotation Type</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ApplicationPath.html" title="annotation in javax.ws.rs">ApplicationPath</a></th> |
| <td class="colLast"> |
| <div class="block">Identifies the application path that serves as the base URI |
| for all resource URIs provided by <a href="Path.html" title="annotation in javax.ws.rs"><code>Path</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="BeanParam.html" title="annotation in javax.ws.rs">BeanParam</a></th> |
| <td class="colLast"> |
| <div class="block">The annotation that may be used to inject a custom "parameter aggregator" value object |
| into a resource class field, property or resource method parameter.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ConstrainedTo.html" title="annotation in javax.ws.rs">ConstrainedTo</a></th> |
| <td class="colLast"> |
| <div class="block">Indicates the run-time context in which an annotated provider |
| is applicable.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Consumes.html" title="annotation in javax.ws.rs">Consumes</a></th> |
| <td class="colLast"> |
| <div class="block">Defines the media types that the methods of a resource class or |
| <a href="ext/MessageBodyReader.html" title="interface in javax.ws.rs.ext"><code>MessageBodyReader</code></a> can accept.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="CookieParam.html" title="annotation in javax.ws.rs">CookieParam</a></th> |
| <td class="colLast"> |
| <div class="block">Binds the value of a HTTP cookie to a resource method parameter, |
| resource class field, or resource class bean property.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DefaultValue.html" title="annotation in javax.ws.rs">DefaultValue</a></th> |
| <td class="colLast"> |
| <div class="block">Defines the default value of request meta-data that is bound using one of the |
| following annotations: |
| <a href="PathParam.html" title="annotation in javax.ws.rs"><code>PathParam</code></a>, |
| <a href="QueryParam.html" title="annotation in javax.ws.rs"><code>QueryParam</code></a>, |
| <a href="MatrixParam.html" title="annotation in javax.ws.rs"><code>MatrixParam</code></a>, |
| <a href="CookieParam.html" title="annotation in javax.ws.rs"><code>CookieParam</code></a>, |
| <a href="FormParam.html" title="annotation in javax.ws.rs"><code>FormParam</code></a>, |
| or <a href="HeaderParam.html" title="annotation in javax.ws.rs"><code>HeaderParam</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DELETE.html" title="annotation in javax.ws.rs">DELETE</a></th> |
| <td class="colLast"> |
| <div class="block">Indicates that the annotated method responds to HTTP DELETE requests.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Encoded.html" title="annotation in javax.ws.rs">Encoded</a></th> |
| <td class="colLast"> |
| <div class="block">Disables automatic decoding of parameter values bound using <a href="QueryParam.html" title="annotation in javax.ws.rs"><code>QueryParam</code></a>, |
| <a href="PathParam.html" title="annotation in javax.ws.rs"><code>PathParam</code></a>, <a href="FormParam.html" title="annotation in javax.ws.rs"><code>FormParam</code></a> or <a href="MatrixParam.html" title="annotation in javax.ws.rs"><code>MatrixParam</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="FormParam.html" title="annotation in javax.ws.rs">FormParam</a></th> |
| <td class="colLast"> |
| <div class="block">Binds the value(s) of a form parameter contained within a request entity body |
| to a resource method parameter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="GET.html" title="annotation in javax.ws.rs">GET</a></th> |
| <td class="colLast"> |
| <div class="block">Indicates that the annotated method responds to HTTP GET requests.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="HEAD.html" title="annotation in javax.ws.rs">HEAD</a></th> |
| <td class="colLast"> |
| <div class="block">Indicates that the annotated method responds to HTTP HEAD requests.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="HeaderParam.html" title="annotation in javax.ws.rs">HeaderParam</a></th> |
| <td class="colLast"> |
| <div class="block">Binds the value(s) of a HTTP header to a resource method parameter, |
| resource class field, or resource class bean property.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="HttpMethod.html" title="annotation in javax.ws.rs">HttpMethod</a></th> |
| <td class="colLast"> |
| <div class="block">Associates the name of a HTTP method with an annotation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="MatrixParam.html" title="annotation in javax.ws.rs">MatrixParam</a></th> |
| <td class="colLast"> |
| <div class="block">Binds the value(s) of a URI matrix parameter to a resource method parameter, |
| resource class field, or resource class bean property.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="NameBinding.html" title="annotation in javax.ws.rs">NameBinding</a></th> |
| <td class="colLast"> |
| <div class="block">Meta-annotation used to create name binding annotations for filters |
| and interceptors.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="OPTIONS.html" title="annotation in javax.ws.rs">OPTIONS</a></th> |
| <td class="colLast"> |
| <div class="block">Indicates that the annotated method responds to HTTP OPTIONS requests.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="PATCH.html" title="annotation in javax.ws.rs">PATCH</a></th> |
| <td class="colLast"> |
| <div class="block">Indicates that the annotated method responds to HTTP PATCH requests.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Path.html" title="annotation in javax.ws.rs">Path</a></th> |
| <td class="colLast"> |
| <div class="block">Identifies the URI path that a resource class or class method will serve |
| requests for.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="PathParam.html" title="annotation in javax.ws.rs">PathParam</a></th> |
| <td class="colLast"> |
| <div class="block">Binds the value of a URI template parameter or a path segment |
| containing the template parameter to a resource method parameter, resource |
| class field, or resource class |
| bean property.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="POST.html" title="annotation in javax.ws.rs">POST</a></th> |
| <td class="colLast"> |
| <div class="block">Indicates that the annotated method responds to HTTP POST requests.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Produces.html" title="annotation in javax.ws.rs">Produces</a></th> |
| <td class="colLast"> |
| <div class="block">Defines the media type(s) that the methods of a resource class or |
| <a href="ext/MessageBodyWriter.html" title="interface in javax.ws.rs.ext"><code>MessageBodyWriter</code></a> can produce.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="PUT.html" title="annotation in javax.ws.rs">PUT</a></th> |
| <td class="colLast"> |
| <div class="block">Indicates that the annotated method responds to HTTP PUT requests.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="QueryParam.html" title="annotation in javax.ws.rs">QueryParam</a></th> |
| <td class="colLast"> |
| <div class="block">Binds the value(s) of a HTTP query parameter to a resource method parameter, |
| resource class field, or resource class bean property.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright (c) 2019 Eclipse Foundation. Licensed under <a href="resources/EFSL.html">Eclipse Foundation Specification License</a>.</small></p> |
| </footer> |
| </body> |
| </html> |
