| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>OASConfig</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="OASConfig"; |
| } |
| } |
| 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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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>Prev Class</li> |
| <li><a href="../../../../org/eclipse/microprofile/openapi/OASFactory.html" title="class in org.eclipse.microprofile.openapi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/microprofile/openapi/OASConfig.html" target="_top">Frames</a></li> |
| <li><a href="OASConfig.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#methods.inherited.from.class.java.lang.Object">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li>Method</li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.microprofile.openapi</div> |
| <h2 title="Class OASConfig" class="title">Class OASConfig</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.microprofile.openapi.OASConfig</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public final class <span class="typeNameLabel">OASConfig</span> |
| extends java.lang.Object</pre> |
| <div class="block">Configurable properties in MicroProfile OpenAPI</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASConfig.html#EXTENSIONS_PREFIX">EXTENSIONS_PREFIX</a></span></code> |
| <div class="block">Recommended prefix for vendor specific configuration properties.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASConfig.html#FILTER">FILTER</a></span></code> |
| <div class="block">Configuration property to specify the fully qualified name of the OASFilter implementation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASConfig.html#MODEL_READER">MODEL_READER</a></span></code> |
| <div class="block">Configuration property to specify the fully qualified name of the OASModelReader implementation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASConfig.html#SCAN_CLASSES">SCAN_CLASSES</a></span></code> |
| <div class="block">Configuration property to specify the list of classes to scan.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASConfig.html#SCAN_DISABLE">SCAN_DISABLE</a></span></code> |
| <div class="block">Configuration property to disable annotation scanning.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASConfig.html#SCAN_EXCLUDE_CLASSES">SCAN_EXCLUDE_CLASSES</a></span></code> |
| <div class="block">Configuration property to specify the list of classes to exclude from scans.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASConfig.html#SCAN_EXCLUDE_PACKAGES">SCAN_EXCLUDE_PACKAGES</a></span></code> |
| <div class="block">Configuration property to specify the list of packages to exclude from scans.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASConfig.html#SCAN_PACKAGES">SCAN_PACKAGES</a></span></code> |
| <div class="block">Configuration property to specify the list of packages to scan.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASConfig.html#SERVERS">SERVERS</a></span></code> |
| <div class="block">Configuration property to specify the list of global servers that provide connectivity information.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASConfig.html#SERVERS_OPERATION_PREFIX">SERVERS_OPERATION_PREFIX</a></span></code> |
| <div class="block">Prefix of the configuration property to specify an alternative list of servers to service an operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/microprofile/openapi/OASConfig.html#SERVERS_PATH_PREFIX">SERVERS_PATH_PREFIX</a></span></code> |
| <div class="block">Prefix of the configuration property to specify an alternative list of servers to service all operations in a path.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="MODEL_READER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MODEL_READER</h4> |
| <pre>public static final java.lang.String MODEL_READER</pre> |
| <div class="block">Configuration property to specify the fully qualified name of the OASModelReader implementation.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/microprofile/openapi/OASModelReader.html" title="interface in org.eclipse.microprofile.openapi"><code>OASModelReader</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.microprofile.openapi.OASConfig.MODEL_READER">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FILTER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FILTER</h4> |
| <pre>public static final java.lang.String FILTER</pre> |
| <div class="block">Configuration property to specify the fully qualified name of the OASFilter implementation.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/eclipse/microprofile/openapi/OASFilter.html" title="interface in org.eclipse.microprofile.openapi"><code>OASFilter</code></a>, |
| <a href="../../../../constant-values.html#org.eclipse.microprofile.openapi.OASConfig.FILTER">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SCAN_DISABLE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SCAN_DISABLE</h4> |
| <pre>public static final java.lang.String SCAN_DISABLE</pre> |
| <div class="block">Configuration property to disable annotation scanning.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.microprofile.openapi.OASConfig.SCAN_DISABLE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SCAN_PACKAGES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SCAN_PACKAGES</h4> |
| <pre>public static final java.lang.String SCAN_PACKAGES</pre> |
| <div class="block">Configuration property to specify the list of packages to scan.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.microprofile.openapi.OASConfig.SCAN_PACKAGES">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SCAN_CLASSES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SCAN_CLASSES</h4> |
| <pre>public static final java.lang.String SCAN_CLASSES</pre> |
| <div class="block">Configuration property to specify the list of classes to scan.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.microprofile.openapi.OASConfig.SCAN_CLASSES">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SCAN_EXCLUDE_PACKAGES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SCAN_EXCLUDE_PACKAGES</h4> |
| <pre>public static final java.lang.String SCAN_EXCLUDE_PACKAGES</pre> |
| <div class="block">Configuration property to specify the list of packages to exclude from scans.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.microprofile.openapi.OASConfig.SCAN_EXCLUDE_PACKAGES">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SCAN_EXCLUDE_CLASSES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SCAN_EXCLUDE_CLASSES</h4> |
| <pre>public static final java.lang.String SCAN_EXCLUDE_CLASSES</pre> |
| <div class="block">Configuration property to specify the list of classes to exclude from scans.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.microprofile.openapi.OASConfig.SCAN_EXCLUDE_CLASSES">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SERVERS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SERVERS</h4> |
| <pre>public static final java.lang.String SERVERS</pre> |
| <div class="block">Configuration property to specify the list of global servers that provide connectivity information.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.microprofile.openapi.OASConfig.SERVERS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SERVERS_PATH_PREFIX"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SERVERS_PATH_PREFIX</h4> |
| <pre>public static final java.lang.String SERVERS_PATH_PREFIX</pre> |
| <div class="block">Prefix of the configuration property to specify an alternative list of servers to service all operations in a path.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.microprofile.openapi.OASConfig.SERVERS_PATH_PREFIX">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SERVERS_OPERATION_PREFIX"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SERVERS_OPERATION_PREFIX</h4> |
| <pre>public static final java.lang.String SERVERS_OPERATION_PREFIX</pre> |
| <div class="block">Prefix of the configuration property to specify an alternative list of servers to service an operation.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.microprofile.openapi.OASConfig.SERVERS_OPERATION_PREFIX">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="EXTENSIONS_PREFIX"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>EXTENSIONS_PREFIX</h4> |
| <pre>public static final java.lang.String EXTENSIONS_PREFIX</pre> |
| <div class="block">Recommended prefix for vendor specific configuration properties.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.microprofile.openapi.OASConfig.EXTENSIONS_PREFIX">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= 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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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>Prev Class</li> |
| <li><a href="../../../../org/eclipse/microprofile/openapi/OASFactory.html" title="class in org.eclipse.microprofile.openapi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/microprofile/openapi/OASConfig.html" target="_top">Frames</a></li> |
| <li><a href="OASConfig.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#methods.inherited.from.class.java.lang.Object">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li>Method</li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |