blob: 3cb9e0a56d8dde5196b33995c5e7e305ed255e88 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>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="Configuration";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="../../../../javax/ws/rs/core/Configurable.html" title="interface in javax.ws.rs.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../javax/ws/rs/core/Context.html" title="annotation in javax.ws.rs.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/ws/rs/core/Configuration.html" target="_top">Frames</a></li>
<li><a href="Configuration.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">javax.ws.rs.core</div>
<h2 title="Interface Configuration" class="title">Interface Configuration</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Configuration</span></pre>
<div class="block">A configuration state associated with a <a href="../../../../javax/ws/rs/core/Configurable.html" title="interface in javax.ws.rs.core"><code>configurable</code></a> context.
Defines the components as well as additional meta-data for the configured context.
<p>
A configuration state may be used to retrieve configuration information about
of the associated context (e.g. application, resource method, etc.) or component
(e.g. <a href="../../../../javax/ws/rs/client/Client.html" title="interface in javax.ws.rs.client"><code>Client</code></a>, <a href="../../../../javax/ws/rs/client/WebTarget.html" title="interface in javax.ws.rs.client"><code>WebTarget</code></a>, etc.).
Configuration information consists of properties, registered component classes
and/or instances.
</p>
<p>
This interface can be injected using the <a href="../../../../javax/ws/rs/core/Context.html" title="annotation in javax.ws.rs.core"><code>Context</code></a> annotation.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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>java.util.Set&lt;java.lang.Class&lt;?&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Configuration.html#getClasses--">getClasses</a></span>()</code>
<div class="block">Get the immutable set of registered component (such as provider or
<a href="../../../../javax/ws/rs/core/Feature.html" title="interface in javax.ws.rs.core"><code>feature</code></a>) classes to be instantiated, injected and utilized in the scope
of the configurable instance.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.Class&lt;?&gt;,java.lang.Integer&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Configuration.html#getContracts-java.lang.Class-">getContracts</a></span>(java.lang.Class&lt;?&gt;&nbsp;componentClass)</code>
<div class="block">Get the extension contract registration information for a component of a given class.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Configuration.html#getInstances--">getInstances</a></span>()</code>
<div class="block">Get the immutable set of registered component (such as provider or
<a href="../../../../javax/ws/rs/core/Feature.html" title="interface in javax.ws.rs.core"><code>feature</code></a>) instances to be utilized by the configurable instance.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Configuration.html#getProperties--">getProperties</a></span>()</code>
<div class="block">Get the immutable bag of configuration properties.</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="../../../../javax/ws/rs/core/Configuration.html#getProperty-java.lang.String-">getProperty</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Get the value for the property with a given name.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Collection&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Configuration.html#getPropertyNames--">getPropertyNames</a></span>()</code>
<div class="block">Returns an immutable <code>collection</code> containing the
property names available within the context of the current configuration instance.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/RuntimeType.html" title="enum in javax.ws.rs">RuntimeType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Configuration.html#getRuntimeType--">getRuntimeType</a></span>()</code>
<div class="block">Get the runtime type of this configuration context.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Configuration.html#isEnabled-java.lang.Class-">isEnabled</a></span>(java.lang.Class&lt;? extends <a href="../../../../javax/ws/rs/core/Feature.html" title="interface in javax.ws.rs.core">Feature</a>&gt;&nbsp;featureClass)</code>
<div class="block">Check if a <a href="../../../../javax/ws/rs/core/Feature.html" title="interface in javax.ws.rs.core"><code>feature</code></a> instance of <code>featureClass</code> class has been
previously enabled in the runtime configuration context.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Configuration.html#isEnabled-javax.ws.rs.core.Feature-">isEnabled</a></span>(<a href="../../../../javax/ws/rs/core/Feature.html" title="interface in javax.ws.rs.core">Feature</a>&nbsp;feature)</code>
<div class="block">Check if a particular <a href="../../../../javax/ws/rs/core/Feature.html" title="interface in javax.ws.rs.core"><code>feature</code></a> instance has been previously
enabled in the runtime configuration context.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Configuration.html#isRegistered-java.lang.Class-">isRegistered</a></span>(java.lang.Class&lt;?&gt;&nbsp;componentClass)</code>
<div class="block">Check if a component of the supplied <code>componentClass</code> class has been previously
registered in the runtime configuration context.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/core/Configuration.html#isRegistered-java.lang.Object-">isRegistered</a></span>(java.lang.Object&nbsp;component)</code>
<div class="block">Check if a particular API <code>component</code> instance (such as providers or
<a href="../../../../javax/ws/rs/core/Feature.html" title="interface in javax.ws.rs.core"><code>features</code></a>) has been previously registered in the runtime configuration context.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getRuntimeType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRuntimeType</h4>
<pre><a href="../../../../javax/ws/rs/RuntimeType.html" title="enum in javax.ws.rs">RuntimeType</a>&nbsp;getRuntimeType()</pre>
<div class="block">Get the runtime type of this configuration context.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>configuration context runtime type.</dd>
</dl>
</li>
</ul>
<a name="getProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperties</h4>
<pre>java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;getProperties()</pre>
<div class="block">Get the immutable bag of configuration properties.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the immutable view of configuration properties.</dd>
</dl>
</li>
</ul>
<a name="getProperty-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperty</h4>
<pre>java.lang.Object&nbsp;getProperty(java.lang.String&nbsp;name)</pre>
<div class="block">Get the value for the property with a given name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - property name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the property value for the specified property name or <code>null</code>
if the property with such name is not configured.</dd>
</dl>
</li>
</ul>
<a name="getPropertyNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPropertyNames</h4>
<pre>java.util.Collection&lt;java.lang.String&gt;&nbsp;getPropertyNames()</pre>
<div class="block">Returns an immutable <code>collection</code> containing the
property names available within the context of the current configuration instance.
<p>
Use the <a href="../../../../javax/ws/rs/core/Configuration.html#getProperty-java.lang.String-"><code>getProperty(java.lang.String)</code></a> method with a property name to get the value of
a property.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an immutable <code>collection</code> of property names.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/ws/rs/core/Configuration.html#getProperty-java.lang.String-"><code>getProperty(java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
<a name="isEnabled-javax.ws.rs.core.Feature-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnabled</h4>
<pre>boolean&nbsp;isEnabled(<a href="../../../../javax/ws/rs/core/Feature.html" title="interface in javax.ws.rs.core">Feature</a>&nbsp;feature)</pre>
<div class="block">Check if a particular <a href="../../../../javax/ws/rs/core/Feature.html" title="interface in javax.ws.rs.core"><code>feature</code></a> instance has been previously
enabled in the runtime configuration context.
<p>
Method returns <code>true</code> only in case an instance equal to the <code>feature</code>
instance is already present among the features previously successfully enabled in
the configuration context.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>feature</code> - a feature instance to test for.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the feature instance has been previously enabled in this
configuration context, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a name="isEnabled-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnabled</h4>
<pre>boolean&nbsp;isEnabled(java.lang.Class&lt;? extends <a href="../../../../javax/ws/rs/core/Feature.html" title="interface in javax.ws.rs.core">Feature</a>&gt;&nbsp;featureClass)</pre>
<div class="block">Check if a <a href="../../../../javax/ws/rs/core/Feature.html" title="interface in javax.ws.rs.core"><code>feature</code></a> instance of <code>featureClass</code> class has been
previously enabled in the runtime configuration context.
<p>
Method returns <code>true</code> in case any instance of the <code>featureClass</code> class is
already present among the features previously successfully enabled in the configuration
context.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>featureClass</code> - a feature class to test for.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if a feature of a given class has been previously enabled in this
configuration context, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a name="isRegistered-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRegistered</h4>
<pre>boolean&nbsp;isRegistered(java.lang.Object&nbsp;component)</pre>
<div class="block">Check if a particular API <code>component</code> instance (such as providers or
<a href="../../../../javax/ws/rs/core/Feature.html" title="interface in javax.ws.rs.core"><code>features</code></a>) has been previously registered in the runtime configuration context.
<p>
Method returns <code>true</code> only in case an instance equal to the <code>component</code>
instance is already present among the components previously registered in the configuration
context.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>component</code> - a component instance to test for.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the component instance has been previously registered in this
configuration context, <code>false</code> otherwise.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/ws/rs/core/Configuration.html#isEnabled-javax.ws.rs.core.Feature-"><code>isEnabled(Feature)</code></a></dd>
</dl>
</li>
</ul>
<a name="isRegistered-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRegistered</h4>
<pre>boolean&nbsp;isRegistered(java.lang.Class&lt;?&gt;&nbsp;componentClass)</pre>
<div class="block">Check if a component of the supplied <code>componentClass</code> class has been previously
registered in the runtime configuration context.
<p>
Method returns <code>true</code> in case a component of the supplied <code>componentClass</code> class
is already present among the previously registered component classes or instances
in the configuration context.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>componentClass</code> - a component class to test for.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if a component of a given class has been previously registered in this
configuration context, <code>false</code> otherwise.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/ws/rs/core/Configuration.html#isEnabled-java.lang.Class-"><code>isEnabled(Class)</code></a></dd>
</dl>
</li>
</ul>
<a name="getContracts-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContracts</h4>
<pre>java.util.Map&lt;java.lang.Class&lt;?&gt;,java.lang.Integer&gt;&nbsp;getContracts(java.lang.Class&lt;?&gt;&nbsp;componentClass)</pre>
<div class="block">Get the extension contract registration information for a component of a given class.
For component classes that are not configured in this configuration context the method returns
an empty <code>Map</code>. Method does not return <code>null</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>map of extension contracts and their priorities for which the component class
is registered.
May return an empty map in case the component has not been registered for any
extension contract supported by the implementation.</dd>
</dl>
</li>
</ul>
<a name="getClasses--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClasses</h4>
<pre>java.util.Set&lt;java.lang.Class&lt;?&gt;&gt;&nbsp;getClasses()</pre>
<div class="block">Get the immutable set of registered component (such as provider or
<a href="../../../../javax/ws/rs/core/Feature.html" title="interface in javax.ws.rs.core"><code>feature</code></a>) classes to be instantiated, injected and utilized in the scope
of the configurable instance.
<p>
For each component type, there can be only a single class-based or instance-based registration
present in the configuration context at any given time.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the immutable set of registered component classes. The returned
value may be empty but will never be <code>null</code>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/ws/rs/core/Configuration.html#getInstances--"><code>getInstances()</code></a></dd>
</dl>
</li>
</ul>
<a name="getInstances--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getInstances</h4>
<pre>java.util.Set&lt;java.lang.Object&gt;&nbsp;getInstances()</pre>
<div class="block">Get the immutable set of registered component (such as provider or
<a href="../../../../javax/ws/rs/core/Feature.html" title="interface in javax.ws.rs.core"><code>feature</code></a>) instances to be utilized by the configurable instance.
Fields and properties of returned instances are injected with their declared dependencies
(see <a href="../../../../javax/ws/rs/core/Context.html" title="annotation in javax.ws.rs.core"><code>Context</code></a>) by the runtime prior to use.
<p>
For each component type, there can be only a single class-based or instance-based registration
present in the configuration context at any given time.
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the immutable set of registered component instances. The returned
value may be empty but will never be <code>null</code>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/ws/rs/core/Configuration.html#getClasses--"><code>getClasses()</code></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><a href="../../../../javax/ws/rs/core/Configurable.html" title="interface in javax.ws.rs.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../javax/ws/rs/core/Context.html" title="annotation in javax.ws.rs.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/ws/rs/core/Configuration.html" target="_top">Frames</a></li>
<li><a href="Configuration.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>