| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Overview</title> |
| <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> |
| <script type="text/javascript" src="script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/microprofile-favicon.png"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Overview"; |
| } |
| } |
| 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 class="navBarCell1Rev">Overview</li> |
| <li>Package</li> |
| <li>Class</li> |
| <li><a href="overview-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>Prev</li> |
| <li>Next</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="index.html?overview-summary.html" target="_top">Frames</a></li> |
| <li><a href="overview-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="allclasses-noframe.html">All 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="contentContainer"> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Packages table, listing packages, and an explanation"> |
| <caption><span>Packages</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Package</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/auth/package-summary.html">org.eclipse.microprofile.auth</a></td> |
| <td class="colLast"> |
| <div class="block">Metadata for JWT RBAC for Microprofile</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/config/package-summary.html">org.eclipse.microprofile.config</a></td> |
| <td class="colLast"> |
| <div class="block">Configuration for Java MicroProfile</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/config/inject/package-summary.html">org.eclipse.microprofile.config.inject</a></td> |
| <td class="colLast"> |
| <div class="block">CDI Support for MicroProfile Config</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/config/spi/package-summary.html">org.eclipse.microprofile.config.spi</a></td> |
| <td class="colLast"> |
| <div class="block">This package contains classes which are used to implement the configuration API, and to extend the standard |
| configuration functionality in a portable way.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/faulttolerance/package-summary.html">org.eclipse.microprofile.faulttolerance</a></td> |
| <td class="colLast"> |
| <div class="block">CDI Support for Microprofile Fault Tolerance</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/faulttolerance/exceptions/package-summary.html">org.eclipse.microprofile.faulttolerance.exceptions</a></td> |
| <td class="colLast"> |
| <div class="block">Exceptions for Microprofile Fault Tolerance</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/health/package-summary.html">org.eclipse.microprofile.health</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Microprofile Health</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/health/spi/package-summary.html">org.eclipse.microprofile.health.spi</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Microprofile Service Health Checks</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/jwt/package-summary.html">org.eclipse.microprofile.jwt</a></td> |
| <td class="colLast"> |
| <div class="block">Interoperable JWT RBAC for Microprofile</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/jwt/config/package-summary.html">org.eclipse.microprofile.jwt.config</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/maven/pdf/package-summary.html">org.eclipse.microprofile.maven.pdf</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/metrics/package-summary.html">org.eclipse.microprofile.metrics</a></td> |
| <td class="colLast"> |
| <div class="block">MicroProfile Metrics</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/metrics/annotation/package-summary.html">org.eclipse.microprofile.metrics.annotation</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| This package contains the annotations used for MicroProfile Metrics.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/metrics/tck/package-summary.html">org.eclipse.microprofile.metrics.tck</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/metrics/tck/cdi/package-summary.html">org.eclipse.microprofile.metrics.tck.cdi</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/metrics/tck/cdi/stereotype/package-summary.html">org.eclipse.microprofile.metrics.tck.cdi.stereotype</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/metrics/tck/cdi/stereotype/stereotypes/package-summary.html">org.eclipse.microprofile.metrics.tck.cdi.stereotype.stereotypes</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/metrics/tck/inheritance/package-summary.html">org.eclipse.microprofile.metrics.tck.inheritance</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/metrics/tck/metrics/package-summary.html">org.eclipse.microprofile.metrics.tck.metrics</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/metrics/tck/tags/package-summary.html">org.eclipse.microprofile.metrics.tck.tags</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/metrics/tck/util/package-summary.html">org.eclipse.microprofile.metrics.tck.util</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/package-summary.html">org.eclipse.microprofile.openapi</a></td> |
| <td class="colLast"> |
| <div class="block">A set of Java interfaces, annotations and programming models |
| which allow Java developers to natively produce OpenAPI v3 documents |
| from their JAX-RS applications.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/annotations/package-summary.html">org.eclipse.microprofile.openapi.annotations</a></td> |
| <td class="colLast"> |
| <div class="block">A set of annotations, many derived from Swagger Core library.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/annotations/callbacks/package-summary.html">org.eclipse.microprofile.openapi.annotations.callbacks</a></td> |
| <td class="colLast"> |
| <div class="block">A set of annotations to represent callback URL |
| or an array of relevant callback URLs that can be invoked for a particular HTTP operation |
| as well as the HTTP operation that will be invoked with the callback.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/annotations/enums/package-summary.html">org.eclipse.microprofile.openapi.annotations.enums</a></td> |
| <td class="colLast"> |
| <div class="block">A set of parameters used by other annotations to represent their enumerable properties.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/annotations/extensions/package-summary.html">org.eclipse.microprofile.openapi.annotations.extensions</a></td> |
| <td class="colLast"> |
| <div class="block">Annotations to represent additional data to extend existing OpenAPI specifications.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/annotations/headers/package-summary.html">org.eclipse.microprofile.openapi.annotations.headers</a></td> |
| <td class="colLast"> |
| <div class="block">An annotation to describe a single header object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/annotations/info/package-summary.html">org.eclipse.microprofile.openapi.annotations.info</a></td> |
| <td class="colLast"> |
| <div class="block">A set of annotations to represent metadata about the API, including license information |
| and contact information of the exposed API.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/annotations/links/package-summary.html">org.eclipse.microprofile.openapi.annotations.links</a></td> |
| <td class="colLast"> |
| <div class="block">Annotations to represent a design-time link for a response and the corresponding |
| parameter to be passed to the linked operation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/annotations/media/package-summary.html">org.eclipse.microprofile.openapi.annotations.media</a></td> |
| <td class="colLast"> |
| <div class="block">A set of annotations to represent input and output data type, media type |
| and relevant examples.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/annotations/parameters/package-summary.html">org.eclipse.microprofile.openapi.annotations.parameters</a></td> |
| <td class="colLast"> |
| <div class="block">A set of annotations to describe and encapsulate operation |
| parameters and operation's request body.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/annotations/responses/package-summary.html">org.eclipse.microprofile.openapi.annotations.responses</a></td> |
| <td class="colLast"> |
| <div class="block">Contains annotation to describe a single response from an API operation, |
| and an annotation to encapsulate multiple responses from an API operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/annotations/security/package-summary.html">org.eclipse.microprofile.openapi.annotations.security</a></td> |
| <td class="colLast"> |
| <div class="block">A set of annotations to represent various security components of an OpenAPI app.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/annotations/servers/package-summary.html">org.eclipse.microprofile.openapi.annotations.servers</a></td> |
| <td class="colLast"> |
| <div class="block">Annotations to represent servers used for a single API operation |
| or for all operations in an OpenAPI document, as well as a way to represent |
| variables for server URL template substitution.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/annotations/tags/package-summary.html">org.eclipse.microprofile.openapi.annotations.tags</a></td> |
| <td class="colLast"> |
| <div class="block">A set of annotations to represent a tag for an API endpoint |
| and a container that encapsulates multiple such tags.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/models/package-summary.html">org.eclipse.microprofile.openapi.models</a></td> |
| <td class="colLast"> |
| <div class="block">A set of interfaces for programmable models and their helper classes, |
| many derived from Swagger Core library.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/models/callbacks/package-summary.html">org.eclipse.microprofile.openapi.models.callbacks</a></td> |
| <td class="colLast"> |
| <div class="block">An interface to represent callback URL.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/models/examples/package-summary.html">org.eclipse.microprofile.openapi.models.examples</a></td> |
| <td class="colLast"> |
| <div class="block">An interface to represent a programmable model of an example |
| of a data type or a media type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/models/headers/package-summary.html">org.eclipse.microprofile.openapi.models.headers</a></td> |
| <td class="colLast"> |
| <div class="block">An interface of a programmable model to represent a single |
| header object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/models/info/package-summary.html">org.eclipse.microprofile.openapi.models.info</a></td> |
| <td class="colLast"> |
| <div class="block">A set of interfaces of programmable models to represent metadata about the API, |
| including license information and contact information of the exposed API.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/models/links/package-summary.html">org.eclipse.microprofile.openapi.models.links</a></td> |
| <td class="colLast"> |
| <div class="block">An interface of a model to represent a design-time link for a response.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/models/media/package-summary.html">org.eclipse.microprofile.openapi.models.media</a></td> |
| <td class="colLast"> |
| <div class="block">A set of interfaces for programmable models to represent input and output data types |
| and media types.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/models/parameters/package-summary.html">org.eclipse.microprofile.openapi.models.parameters</a></td> |
| <td class="colLast"> |
| <div class="block">A set of model interfaces to describe operation |
| parameters and operation's request body.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/models/responses/package-summary.html">org.eclipse.microprofile.openapi.models.responses</a></td> |
| <td class="colLast"> |
| <div class="block">Model interfaces to describe a single response from an API operation, |
| and an annotation to encapsulate multiple responses from an API operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/models/security/package-summary.html">org.eclipse.microprofile.openapi.models.security</a></td> |
| <td class="colLast"> |
| <div class="block">A set of model interfaces to represent various security components of an OpenAPI app.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/models/servers/package-summary.html">org.eclipse.microprofile.openapi.models.servers</a></td> |
| <td class="colLast"> |
| <div class="block">Model interfaces to represent servers used for a single API operation |
| or for all operations in an OpenAPI document, as well as a way to represent |
| variables for server URL template substitution.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/models/tags/package-summary.html">org.eclipse.microprofile.openapi.models.tags</a></td> |
| <td class="colLast"> |
| <div class="block">Model interface to represent a tag of an API endpoint.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/openapi/spi/package-summary.html">org.eclipse.microprofile.openapi.spi</a></td> |
| <td class="colLast"> |
| <div class="block">Service provider interface which allows vendors to set their implementations |
| of OASFactoryResolver.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/opentracing/package-summary.html">org.eclipse.microprofile.opentracing</a></td> |
| <td class="colLast"> |
| <div class="block">CDI Support for Microprofile OpenTracing.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/rest/client/package-summary.html">org.eclipse.microprofile.rest.client</a></td> |
| <td class="colLast"> |
| <div class="block">APIs for building a type-safe RESTful client leveraging existing JAX-RS |
| APIs, for example:</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/rest/client/annotation/package-summary.html">org.eclipse.microprofile.rest.client.annotation</a></td> |
| <td class="colLast"> |
| <div class="block">APIs for annotating MP Rest Client interfaces.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/rest/client/ext/package-summary.html">org.eclipse.microprofile.rest.client.ext</a></td> |
| <td class="colLast"> |
| <div class="block">APIs for extending MP Rest Client functionality - such as new providers.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/rest/client/inject/package-summary.html">org.eclipse.microprofile.rest.client.inject</a></td> |
| <td class="colLast"> |
| <div class="block">APIs to aid in CDI-based injection of MP Rest Client implementations.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="org/eclipse/microprofile/rest/client/spi/package-summary.html">org.eclipse.microprofile.rest.client.spi</a></td> |
| <td class="colLast"> |
| <div class="block">SPIs for MP Rest Client implementations or system-level components that |
| provide additional functionality for MP Rest Clients.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </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 class="navBarCell1Rev">Overview</li> |
| <li>Package</li> |
| <li>Class</li> |
| <li><a href="overview-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>Prev</li> |
| <li>Next</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="index.html?overview-summary.html" target="_top">Frames</a></li> |
| <li><a href="overview-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="allclasses-noframe.html">All 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> |
