| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>SeBootstrap.Configuration</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="SeBootstrap.Configuration"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":17,"i1":18,"i2":18,"i3":18,"i4":6,"i5":18,"i6":18,"i7":18,"i8":18}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </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><a href="../../../jakarta/ws/rs/SeBootstrap.html" title="interface in jakarta.ws.rs"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.Builder.html" title="interface in jakarta.ws.rs"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/ws/rs/SeBootstrap.Configuration.html" target="_top">Frames</a></li> |
| <li><a href="SeBootstrap.Configuration.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.ws.rs</div> |
| <h2 title="Interface SeBootstrap.Configuration" class="title">Interface SeBootstrap.Configuration</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="../../../jakarta/ws/rs/SeBootstrap.html" title="interface in jakarta.ws.rs">SeBootstrap</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static interface <span class="typeNameLabel">SeBootstrap.Configuration</span></pre> |
| <div class="block">Provides information needed by the JAX-RS implementation for bootstrapping an application. |
| <p> |
| The configuration essentially consists of a set of parameters. While the set of actually effective keys is product |
| specific, the key constants defined by the <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html" title="interface in jakarta.ws.rs"><code>SeBootstrap.Configuration</code></a> interface MUST be effective on all compliant |
| products. Any unknown key MUST be silently ignored. |
| </p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.Builder.html" title="interface in jakarta.ws.rs">SeBootstrap.Configuration.Builder</a></span></code> |
| <div class="block">Builder for bootstrap <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html" title="interface in jakarta.ws.rs"><code>SeBootstrap.Configuration</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.SSLClientAuthentication.html" title="enum in jakarta.ws.rs">SeBootstrap.Configuration.SSLClientAuthentication</a></span></code> |
| <div class="block">Secure socket client authentication policy</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== 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 int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#DEFAULT_PORT">DEFAULT_PORT</a></span></code> |
| <div class="block">Special value for <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#PORT"><code>PORT</code></a> property indicating that the implementation MUST use its default port.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#FREE_PORT">FREE_PORT</a></span></code> |
| <div class="block">Special value for <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#PORT"><code>PORT</code></a> property indicating that the implementation MUST scan for a free port.</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="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#HOST">HOST</a></span></code> |
| <div class="block">Configuration key for the hostname or IP address an application is bound to.</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="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#PORT">PORT</a></span></code> |
| <div class="block">Configuration key for the TCP port an application is bound to.</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="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#PROTOCOL">PROTOCOL</a></span></code> |
| <div class="block">Configuration key for the protocol an application is bound to.</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="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#ROOT_PATH">ROOT_PATH</a></span></code> |
| <div class="block">Configuration key for the root path an application is bound to.</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="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#SSL_CLIENT_AUTHENTICATION">SSL_CLIENT_AUTHENTICATION</a></span></code> |
| <div class="block">Configuration key for the secure socket client authentication policy.</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="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#SSL_CONTEXT">SSL_CONTEXT</a></span></code> |
| <div class="block">Configuration key for the secure socket configuration to be used.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.Builder.html" title="interface in jakarta.ws.rs">SeBootstrap.Configuration.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#builder--">builder</a></span>()</code> |
| <div class="block">Creates a new bootstrap configuration builder instance.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#hasProperty-java.lang.String-">hasProperty</a></span>(java.lang.String name)</code> |
| <div class="block">Returns whether the property with the given name is configured, either explicitly or by default.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>default java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#host--">host</a></span>()</code> |
| <div class="block">Convenience method to get the <code>host</code> to be used.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#port--">port</a></span>()</code> |
| <div class="block">Convenience method to get the actually used <code>port</code>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#property-java.lang.String-">property</a></span>(java.lang.String name)</code> |
| <div class="block">Returns the value of the property with the given name, or <code>null</code> if there is no property of that name.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>default java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#protocol--">protocol</a></span>()</code> |
| <div class="block">Convenience method to get the <code>protocol</code> to be used.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>default java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#rootPath--">rootPath</a></span>()</code> |
| <div class="block">Convenience method to get the <code>rootPath</code> to be used.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.SSLClientAuthentication.html" title="enum in jakarta.ws.rs">SeBootstrap.Configuration.SSLClientAuthentication</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#sslClientAuthentication--">sslClientAuthentication</a></span>()</code> |
| <div class="block">Convenience method to get the secure socket client authentication policy.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>default javax.net.ssl.SSLContext</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#sslContext--">sslContext</a></span>()</code> |
| <div class="block">Convenience method to get the <code>sslContext</code> to be used.</div> |
| </td> |
| </tr> |
| </table> |
| </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="PROTOCOL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PROTOCOL</h4> |
| <pre>static final java.lang.String PROTOCOL</pre> |
| <div class="block">Configuration key for the protocol an application is bound to. |
| <p> |
| A compliant implementation at least MUST accept the strings <code>"HTTP"</code> and <code>"HTTPS"</code> if these protocols are |
| supported. |
| </p> |
| <p> |
| The default value is <code>"HTTP"</code>. |
| </p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#jakarta.ws.rs.SeBootstrap.Configuration.PROTOCOL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="HOST"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HOST</h4> |
| <pre>static final java.lang.String HOST</pre> |
| <div class="block">Configuration key for the hostname or IP address an application is bound to. |
| <p> |
| A compliant implementation at least MUST accept string values bearing hostnames, IP4 address text representations, |
| and IP6 address text representations. If a hostname string, the special IP4 address string <code>"0.0.0.0"</code> or |
| <code>"::"</code> for IP6 is provided, the application MUST be bound to <em>all</em> IP addresses assigned to that |
| hostname. If the hostname string is <code>"localhost"</code> the application MUST be bound to the local host's loopback |
| adapter <em>only</em>. |
| </p> |
| <p> |
| The default value is <code>"localhost"</code>. |
| </p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#jakarta.ws.rs.SeBootstrap.Configuration.HOST">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="PORT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PORT</h4> |
| <pre>static final java.lang.String PORT</pre> |
| <div class="block">Configuration key for the TCP port an application is bound to. |
| |
| <p> |
| A compliant implementation MUST accept <code>java.lang.Integer</code> values. |
| </p> |
| <p> |
| There is no default <em>port</em> mandated by this specification, but the default <em>value</em> of this property is |
| <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#DEFAULT_PORT"><code>DEFAULT_PORT</code></a> (i. e. <code>-1</code>). A compliant implementation MUST use its own default <em>port</em> when |
| the <em>value</em> <code>-1</code> is provided, and MAY apply (but is not obligated to) auto-selection and |
| range-scanning algorithms. |
| </p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#jakarta.ws.rs.SeBootstrap.Configuration.PORT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ROOT_PATH"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ROOT_PATH</h4> |
| <pre>static final java.lang.String ROOT_PATH</pre> |
| <div class="block">Configuration key for the root path an application is bound to. |
| <p> |
| The default value is <code>"/"</code>. |
| </p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#jakarta.ws.rs.SeBootstrap.Configuration.ROOT_PATH">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SSL_CONTEXT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SSL_CONTEXT</h4> |
| <pre>static final java.lang.String SSL_CONTEXT</pre> |
| <div class="block">Configuration key for the secure socket configuration to be used. |
| <p> |
| The default value is <code>SSLContext.getDefault()</code>. |
| </p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#jakarta.ws.rs.SeBootstrap.Configuration.SSL_CONTEXT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SSL_CLIENT_AUTHENTICATION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SSL_CLIENT_AUTHENTICATION</h4> |
| <pre>static final java.lang.String SSL_CLIENT_AUTHENTICATION</pre> |
| <div class="block">Configuration key for the secure socket client authentication policy. |
| |
| <p> |
| A compliant implementation MUST accept <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.SSLClientAuthentication.html" title="enum in jakarta.ws.rs"><code>SeBootstrap.Configuration.SSLClientAuthentication</code></a> enums. |
| </p> |
| <p> |
| The default value is <code>SSLClientAuthentication#NONE</code>. |
| </p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#jakarta.ws.rs.SeBootstrap.Configuration.SSL_CLIENT_AUTHENTICATION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FREE_PORT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FREE_PORT</h4> |
| <pre>static final int FREE_PORT</pre> |
| <div class="block">Special value for <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#PORT"><code>PORT</code></a> property indicating that the implementation MUST scan for a free port.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#jakarta.ws.rs.SeBootstrap.Configuration.FREE_PORT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_PORT"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_PORT</h4> |
| <pre>static final int DEFAULT_PORT</pre> |
| <div class="block">Special value for <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#PORT"><code>PORT</code></a> property indicating that the implementation MUST use its default port.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#jakarta.ws.rs.SeBootstrap.Configuration.DEFAULT_PORT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="property-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>property</h4> |
| <pre>java.lang.Object property(java.lang.String name)</pre> |
| <div class="block">Returns the value of the property with the given name, or <code>null</code> if there is no property of that name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a <code>String</code> specifying the name of the property.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <code>Object</code> containing the value of the property, or <code>null</code> if no property exists matching the |
| given name.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasProperty-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasProperty</h4> |
| <pre>default boolean hasProperty(java.lang.String name)</pre> |
| <div class="block">Returns whether the property with the given name is configured, either explicitly or by default.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a <code>String</code> specifying the name of the property.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>false</code> if no property exists matching the given name, <code>true</code> otherwise.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="protocol--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>protocol</h4> |
| <pre>default java.lang.String protocol()</pre> |
| <div class="block">Convenience method to get the <code>protocol</code> to be used. |
| <p> |
| Same as if calling <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#property-java.lang.String-"><code>(String) property(PROTOCOL)</code></a>. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>protocol to be used (e. g. <code>"HTTP")</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.ClassCastException</code> - if protocol is not a <code>String</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#PROTOCOL"><code>PROTOCOL</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="host--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>host</h4> |
| <pre>default java.lang.String host()</pre> |
| <div class="block">Convenience method to get the <code>host</code> to be used. |
| <p> |
| Same as if calling <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#property-java.lang.String-"><code>(String) property(HOST)</code></a>. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>host name or IP address to be used (e. g. <code>"localhost"</code> or <code>"0.0.0.0"</code>).</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.ClassCastException</code> - if host is not a <code>String</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#HOST"><code>HOST</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="port--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>port</h4> |
| <pre>default int port()</pre> |
| <div class="block">Convenience method to get the actually used <code>port</code>. |
| <p> |
| Same as if calling <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#property-java.lang.String-"><code>(int) property(PORT)</code></a>. |
| </p> |
| <p> |
| If the port was <em>not explicitly</em> given, this will return the port chosen implicitly by the JAX-RS |
| implementation. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>port number <em>actually</em> used (e. g. <code>8080</code>).</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.ClassCastException</code> - if port is not an <code>Integer</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#PORT"><code>PORT</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="rootPath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rootPath</h4> |
| <pre>default java.lang.String rootPath()</pre> |
| <div class="block">Convenience method to get the <code>rootPath</code> to be used. |
| <p> |
| Same as if calling <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#property-java.lang.String-"><code>(String) property(ROOT_PATH)</code></a>. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>root path to be used, e. g. <code>"/"</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.ClassCastException</code> - if root path is not a <code>String</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#ROOT_PATH"><code>ROOT_PATH</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sslContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sslContext</h4> |
| <pre>default javax.net.ssl.SSLContext sslContext()</pre> |
| <div class="block">Convenience method to get the <code>sslContext</code> to be used. |
| <p> |
| Same as if calling <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#property-java.lang.String-"><code>(SSLContext) property(SSL_CONTEXT)</code></a>. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>root path to be used, e. g. <code>"/"</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.ClassCastException</code> - if sslContext is not a <code>SSLContext</code>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#SSL_CONTEXT"><code>SSL_CONTEXT</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sslClientAuthentication--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sslClientAuthentication</h4> |
| <pre>default <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.SSLClientAuthentication.html" title="enum in jakarta.ws.rs">SeBootstrap.Configuration.SSLClientAuthentication</a> sslClientAuthentication()</pre> |
| <div class="block">Convenience method to get the secure socket client authentication policy. |
| <p> |
| Same as if calling <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#property-java.lang.String-"><code>(SSLClientAuthentication) property(SSL_CLIENT_AUTHENTICATION)</code></a>. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>client authentication mode, e. g. <code>NONE</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.ClassCastException</code> - if sslClientAuthentication is not a <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.SSLClientAuthentication.html" title="enum in jakarta.ws.rs"><code>SeBootstrap.Configuration.SSLClientAuthentication</code></a>.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.html#SSL_CLIENT_AUTHENTICATION"><code>SSL_CLIENT_AUTHENTICATION</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="builder--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>builder</h4> |
| <pre>static <a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.Builder.html" title="interface in jakarta.ws.rs">SeBootstrap.Configuration.Builder</a> builder()</pre> |
| <div class="block">Creates a new bootstrap configuration builder instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.Builder.html" title="interface in jakarta.ws.rs"><code>SeBootstrap.Configuration.Builder</code></a> for bootstrap configuration.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.1</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><a href="../../../jakarta/ws/rs/SeBootstrap.html" title="interface in jakarta.ws.rs"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/ws/rs/SeBootstrap.Configuration.Builder.html" title="interface in jakarta.ws.rs"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/ws/rs/SeBootstrap.Configuration.html" target="_top">Frames</a></li> |
| <li><a href="SeBootstrap.Configuration.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
