blob: 3090cc2b5c866bf0db431061ae4a2721ddf6dcc6 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.6) on Fri Apr 10 16:48:14 EDT 2020 -->
<title>OSGiServerConstants (Jetty :: Project 9.4.28.v20200408 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-04-10">
<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="OSGiServerConstants (Jetty :: Project 9.4.28.v20200408 API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../../";
var useModuleDirectories = false;
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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/OSGiServerConstants.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="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<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>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.jetty.osgi.boot</a></div>
<h2 title="Class OSGiServerConstants" class="title">Class OSGiServerConstants</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.osgi.boot.OSGiServerConstants</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">OSGiServerConstants</span>
extends java.lang.Object</pre>
<div class="block">OSGiServerConstants
Name of the properties that configure a jetty Server OSGi service.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JETTY_BASE">JETTY_BASE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JETTY_HOME">JETTY_HOME</a></span></code></th>
<td class="colLast">
<div class="block">Usual system property used as the hostname for a typical jetty
configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JETTY_HOME_BUNDLE">JETTY_HOME_BUNDLE</a></span></code></th>
<td class="colLast">
<div class="block">System property to point to a bundle that embeds a jetty configuration
and that jetty configuration should be the default jetty server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JETTY_HOST">JETTY_HOST</a></span></code></th>
<td class="colLast">
<div class="block">Usual system property used as the hostname for a typical jetty
configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JETTY_PORT">JETTY_PORT</a></span></code></th>
<td class="colLast">
<div class="block">Usual system property used as the port for http for a typical jetty
configuration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JETTY_PORT_SSL">JETTY_PORT_SSL</a></span></code></th>
<td class="colLast">
<div class="block">Usual system property used as the port for https for a typical jetty
configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MANAGED_JETTY_SERVER_DEFAULT_NAME">MANAGED_JETTY_SERVER_DEFAULT_NAME</a></span></code></th>
<td class="colLast">
<div class="block">Name of the 'default' jetty server instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MANAGED_JETTY_SERVER_FACTORY_PID">MANAGED_JETTY_SERVER_FACTORY_PID</a></span></code></th>
<td class="colLast">
<div class="block">PID of the jetty servers's ManagedFactory</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MANAGED_JETTY_SERVER_NAME">MANAGED_JETTY_SERVER_NAME</a></span></code></th>
<td class="colLast">
<div class="block">The associated value of that configuration parameter is the name under which this
instance of the jetty server is tracked.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MANAGED_JETTY_SHARED_LIB_FOLDER_URLS">MANAGED_JETTY_SHARED_LIB_FOLDER_URLS</a></span></code></th>
<td class="colLast">
<div class="block">List of URLs to the folders where the legacy J2EE shared libraries are stored aka lib/ext, lib/jsp etc.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MANAGED_JETTY_XML_CONFIG_URLS">MANAGED_JETTY_XML_CONFIG_URLS</a></span></code></th>
<td class="colLast">
<div class="block">List of URLs to the jetty.xml files that configure th server.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">OSGiServerConstants</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="JETTY_HOME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JETTY_HOME</h4>
<pre>public static final&nbsp;java.lang.String JETTY_HOME</pre>
<div class="block">Usual system property used as the hostname for a typical jetty
configuration.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.osgi.boot.OSGiServerConstants.JETTY_HOME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="JETTY_BASE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JETTY_BASE</h4>
<pre>public static final&nbsp;java.lang.String JETTY_BASE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.osgi.boot.OSGiServerConstants.JETTY_BASE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="JETTY_HOME_BUNDLE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JETTY_HOME_BUNDLE</h4>
<pre>public static final&nbsp;java.lang.String JETTY_HOME_BUNDLE</pre>
<div class="block">System property to point to a bundle that embeds a jetty configuration
and that jetty configuration should be the default jetty server. First we
look for jetty.home. If we don't find it then we look for this property.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.osgi.boot.OSGiServerConstants.JETTY_HOME_BUNDLE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="JETTY_HOST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JETTY_HOST</h4>
<pre>public static final&nbsp;java.lang.String JETTY_HOST</pre>
<div class="block">Usual system property used as the hostname for a typical jetty
configuration.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.osgi.boot.OSGiServerConstants.JETTY_HOST">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="JETTY_PORT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JETTY_PORT</h4>
<pre>public static final&nbsp;java.lang.String JETTY_PORT</pre>
<div class="block">Usual system property used as the port for http for a typical jetty
configuration.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.osgi.boot.OSGiServerConstants.JETTY_PORT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="JETTY_PORT_SSL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JETTY_PORT_SSL</h4>
<pre>public static final&nbsp;java.lang.String JETTY_PORT_SSL</pre>
<div class="block">Usual system property used as the port for https for a typical jetty
configuration.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.osgi.boot.OSGiServerConstants.JETTY_PORT_SSL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="MANAGED_JETTY_SERVER_FACTORY_PID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MANAGED_JETTY_SERVER_FACTORY_PID</h4>
<pre>public static final&nbsp;java.lang.String MANAGED_JETTY_SERVER_FACTORY_PID</pre>
<div class="block">PID of the jetty servers's ManagedFactory</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.osgi.boot.OSGiServerConstants.MANAGED_JETTY_SERVER_FACTORY_PID">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="MANAGED_JETTY_SERVER_NAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MANAGED_JETTY_SERVER_NAME</h4>
<pre>public static final&nbsp;java.lang.String MANAGED_JETTY_SERVER_NAME</pre>
<div class="block">The associated value of that configuration parameter is the name under which this
instance of the jetty server is tracked.
When a ContextHandler is deployed and it specifies the managedServerName property, it is deployed
on the corresponding jetty managed server or it throws an exception: jetty server not available.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.osgi.boot.OSGiServerConstants.MANAGED_JETTY_SERVER_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="MANAGED_JETTY_SERVER_DEFAULT_NAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MANAGED_JETTY_SERVER_DEFAULT_NAME</h4>
<pre>public static final&nbsp;java.lang.String MANAGED_JETTY_SERVER_DEFAULT_NAME</pre>
<div class="block">Name of the 'default' jetty server instance.
Usually the first one to be created.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.osgi.boot.OSGiServerConstants.MANAGED_JETTY_SERVER_DEFAULT_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="MANAGED_JETTY_XML_CONFIG_URLS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MANAGED_JETTY_XML_CONFIG_URLS</h4>
<pre>public static final&nbsp;java.lang.String MANAGED_JETTY_XML_CONFIG_URLS</pre>
<div class="block">List of URLs to the jetty.xml files that configure th server.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.osgi.boot.OSGiServerConstants.MANAGED_JETTY_XML_CONFIG_URLS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="MANAGED_JETTY_SHARED_LIB_FOLDER_URLS">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MANAGED_JETTY_SHARED_LIB_FOLDER_URLS</h4>
<pre>public static final&nbsp;java.lang.String MANAGED_JETTY_SHARED_LIB_FOLDER_URLS</pre>
<div class="block">List of URLs to the folders where the legacy J2EE shared libraries are stored aka lib/ext, lib/jsp etc.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.osgi.boot.OSGiServerConstants.MANAGED_JETTY_SHARED_LIB_FOLDER_URLS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OSGiServerConstants</h4>
<pre>public&nbsp;OSGiServerConstants()</pre>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/OSGiServerConstants.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="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>