blob: 97895fc1c96d0310d6bfc8a7b732f73244ce75b5 [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>
<!-- Generated by javadoc (version 1.7.0_25) on Sat Jun 29 08:36:29 CEST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>HandlerFactory (Apache Felix iPOJO ~ JavaDoc 1.10.1 API)</title>
<meta name="date" content="2013-06-29">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="HandlerFactory (Apache Felix iPOJO ~ JavaDoc 1.10.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/HandlerFactory.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>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/felix/ipojo/Handler.html" title="class in org.apache.felix.ipojo"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/felix/ipojo/HandlerManager.html" title="class in org.apache.felix.ipojo"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/felix/ipojo/HandlerFactory.html" target="_top">Frames</a></li>
<li><a href="HandlerFactory.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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">org.apache.felix.ipojo</div>
<h2 title="Interface HandlerFactory" class="title">Interface HandlerFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../org/apache/felix/ipojo/Factory.html" title="interface in org.apache.felix.ipojo">Factory</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/felix/ipojo/HandlerManagerFactory.html" title="class in org.apache.felix.ipojo">HandlerManagerFactory</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../src-html/org/apache/felix/ipojo/HandlerFactory.html#line.29">HandlerFactory</a>
extends <a href="../../../../org/apache/felix/ipojo/Factory.html" title="interface in org.apache.felix.ipojo">Factory</a></pre>
<div class="block">Service interface published by handler factory.
This interface allows interacting the the handler factory to create
<a href="../../../../org/apache/felix/ipojo/Handler.html" title="class in org.apache.felix.ipojo"><code>Handler</code></a> objects.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd><a href="mailto:dev@felix.apache.org">Felix Project Team</a></dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/felix/ipojo/Factory.html" title="interface in org.apache.felix.ipojo"><code>Factory</code></a></dd></dl>
</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</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 <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/HandlerFactory.html#IPOJO_NAMESPACE">IPOJO_NAMESPACE</a></strong></code>
<div class="block">The iPOJO Default Namespace.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.felix.ipojo.Factory">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.felix.ipojo.<a href="../../../../org/apache/felix/ipojo/Factory.html" title="interface in org.apache.felix.ipojo">Factory</a></h3>
<code><a href="../../../../org/apache/felix/ipojo/Factory.html#FACTORY_VERSION_PROPERTY">FACTORY_VERSION_PROPERTY</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#INSTANCE_NAME_PROPERTY">INSTANCE_NAME_PROPERTY</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#INVALID">INVALID</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#VALID">VALID</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/HandlerFactory.html#getHandlerName()">getHandlerName</a></strong>()</code>
<div class="block">Gets the name associated with this handler factory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/HandlerFactory.html#getNamespace()">getNamespace</a></strong>()</code>
<div class="block">Gets the namespace associated with this handler factory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/HandlerFactory.html#getStartLevel()">getStartLevel</a></strong>()</code>
<div class="block">Gets the start level of the handler objects created by this factory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/HandlerFactory.html#getType()">getType</a></strong>()</code>
<div class="block">Gets the type of the handler factory.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.felix.ipojo.Factory">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.felix.ipojo.<a href="../../../../org/apache/felix/ipojo/Factory.html" title="interface in org.apache.felix.ipojo">Factory</a></h3>
<code><a href="../../../../org/apache/felix/ipojo/Factory.html#addFactoryStateListener(org.apache.felix.ipojo.FactoryStateListener)">addFactoryStateListener</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#createComponentInstance(java.util.Dictionary)">createComponentInstance</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#createComponentInstance(java.util.Dictionary, org.apache.felix.ipojo.ServiceContext)">createComponentInstance</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#getBundleContext()">getBundleContext</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#getClassName()">getClassName</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#getComponentDescription()">getComponentDescription</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#getComponentMetadata()">getComponentMetadata</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#getDescription()">getDescription</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#getMissingHandlers()">getMissingHandlers</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#getName()">getName</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#getRequiredHandlers()">getRequiredHandlers</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#getState()">getState</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#getVersion()">getVersion</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#isAcceptable(java.util.Dictionary)">isAcceptable</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#reconfigure(java.util.Dictionary)">reconfigure</a>, <a href="../../../../org/apache/felix/ipojo/Factory.html#removeFactoryStateListener(org.apache.felix.ipojo.FactoryStateListener)">removeFactoryStateListener</a></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="IPOJO_NAMESPACE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IPOJO_NAMESPACE</h4>
<pre>static final&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/felix/ipojo/HandlerFactory.html#line.34">IPOJO_NAMESPACE</a></pre>
<div class="block">The iPOJO Default Namespace.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.ipojo.HandlerFactory.IPOJO_NAMESPACE">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="getNamespace()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespace</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/HandlerFactory.html#line.40">getNamespace</a>()</pre>
<div class="block">Gets the namespace associated with this handler factory.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the namespace used by this handler</dd></dl>
</li>
</ul>
<a name="getHandlerName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHandlerName</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/HandlerFactory.html#line.46">getHandlerName</a>()</pre>
<div class="block">Gets the name associated with this handler factory.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the name used by this handler</dd></dl>
</li>
</ul>
<a name="getType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/HandlerFactory.html#line.54">getType</a>()</pre>
<div class="block">Gets the type of the handler factory.
The handler can only be plugged on instance container with the same type.
Basically, types are <code>primitive</code> and <code>composite</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the type of the handler</dd></dl>
</li>
</ul>
<a name="getStartLevel()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getStartLevel</h4>
<pre>int&nbsp;<a href="../../../../src-html/org/apache/felix/ipojo/HandlerFactory.html#line.63">getStartLevel</a>()</pre>
<div class="block">Gets the start level of the handler objects created by this factory.
Handlers with a low start level are configured and started before
handlers with an higher start level. Moreover, these handlers are
stopped and disposed after.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the handler's start level</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/HandlerFactory.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>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/felix/ipojo/Handler.html" title="class in org.apache.felix.ipojo"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/felix/ipojo/HandlerManager.html" title="class in org.apache.felix.ipojo"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/felix/ipojo/HandlerFactory.html" target="_top">Frames</a></li>
<li><a href="HandlerFactory.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2013. All rights reserved.</small></p>
</body>
</html>