| <!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_75) on Tue Dec 01 13:56:20 CET 2015 --> |
| <title>Component</title> |
| <meta name="date" content="2015-12-01"> |
| <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="Component"; |
| } |
| //--> |
| </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="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="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html" title="interface in org.apache.felix.dm"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/dm/Component.html" target="_top">Frames</a></li> |
| <li><a href="Component.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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">org.apache.felix.dm</div> |
| <h2 title="Interface Component" class="title">Interface Component</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/apache/felix/dm/context/ComponentContext.html" title="interface in org.apache.felix.dm.context">ComponentContext</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">Component</span></pre> |
| <div class="block">Component interface. Components are the main building blocks for OSGi applications. |
| They can publish themselves as a service, and they can have dependencies. These |
| dependencies will influence their life cycle as component will only be activated |
| when all required dependencies are available.</div> |
| </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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </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="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#add(org.apache.felix.dm.ComponentStateListener)">add</a></strong>(<a href="../../../../org/apache/felix/dm/ComponentStateListener.html" title="interface in org.apache.felix.dm">ComponentStateListener</a> listener)</code> |
| <div class="block">Adds a component state listener to this component.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#add(org.apache.felix.dm.Dependency...)">add</a></strong>(<a href="../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a>... dependencies)</code> |
| <div class="block">Adds dependency(ies) to this component, atomically.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html" title="interface in org.apache.felix.dm">ComponentDeclaration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#getComponentDeclaration()">getComponentDeclaration</a></strong>()</code> |
| <div class="block">Returns the component description (dependencies, service provided, etc ...).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/DependencyManager.html" title="class in org.apache.felix.dm">DependencyManager</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#getDependencyManager()">getDependencyManager</a></strong>()</code> |
| <div class="block">Returns the dependency manager associated with this component.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#getInstance()">getInstance</a></strong>()</code> |
| <div class="block">Returns the instance that make up this component.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#getInstances()">getInstances</a></strong>()</code> |
| <div class="block">Returns the composition instances that make up this component, or just the |
| component instance if it does not have a composition, or an empty array if |
| the component has not even been instantiated.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><K,V> java.util.Dictionary<K,V></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#getServiceProperties()">getServiceProperties</a></strong>()</code> |
| <div class="block">Returns the service properties associated with the component.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>ServiceRegistration</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#getServiceRegistration()">getServiceRegistration</a></strong>()</code> |
| <div class="block">Returns the service registration for this component.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#remove(org.apache.felix.dm.ComponentStateListener)">remove</a></strong>(<a href="../../../../org/apache/felix/dm/ComponentStateListener.html" title="interface in org.apache.felix.dm">ComponentStateListener</a> listener)</code> |
| <div class="block">Removes a component state listener from this component.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#remove(org.apache.felix.dm.Dependency)">remove</a></strong>(<a href="../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a> d)</code> |
| <div class="block">Removes a dependency from the component.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#setAutoConfig(java.lang.Class,%20boolean)">setAutoConfig</a></strong>(java.lang.Class<?> clazz, |
| boolean autoConfig)</code> |
| <div class="block">Configures auto configuration of injected classes in the component instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#setAutoConfig(java.lang.Class,%20java.lang.String)">setAutoConfig</a></strong>(java.lang.Class<?> clazz, |
| java.lang.String instanceName)</code> |
| <div class="block">Configures auto configuration of injected classes in the component instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#setCallbacks(java.lang.Object,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)">setCallbacks</a></strong>(java.lang.Object instance, |
| java.lang.String init, |
| java.lang.String start, |
| java.lang.String stop, |
| java.lang.String destroy)</code> |
| <div class="block">Sets the names of the methods used as callbacks.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#setCallbacks(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)">setCallbacks</a></strong>(java.lang.String init, |
| java.lang.String start, |
| java.lang.String stop, |
| java.lang.String destroy)</code> |
| <div class="block">Sets the names of the methods used as callbacks.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#setComposition(java.lang.Object,%20java.lang.String)">setComposition</a></strong>(java.lang.Object instance, |
| java.lang.String getMethod)</code> |
| <div class="block">Sets the instance and method to invoke to get back all instances that |
| are part of a composition and need dependencies injected.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#setComposition(java.lang.String)">setComposition</a></strong>(java.lang.String getMethod)</code> |
| <div class="block">Sets the method to invoke on the service implementation to get back all |
| instances that are part of a composition and need dependencies injected.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#setDebug(java.lang.String)">setDebug</a></strong>(java.lang.String label)</code> |
| <div class="block">Activate debug for this component.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#setFactory(java.lang.Object,%20java.lang.String)">setFactory</a></strong>(java.lang.Object factory, |
| java.lang.String createMethod)</code> |
| <div class="block">Sets the factory to use to create the implementation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#setFactory(java.lang.String)">setFactory</a></strong>(java.lang.String createMethod)</code> |
| <div class="block">Sets the factory to use to create the implementation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#setImplementation(java.lang.Object)">setImplementation</a></strong>(java.lang.Object implementation)</code> |
| <div class="block">Sets the implementation for this component.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#setInterface(java.lang.String[],%20java.util.Dictionary)">setInterface</a></strong>(java.lang.String[] serviceNames, |
| java.util.Dictionary<?,?> properties)</code> |
| <div class="block">Sets the public interfaces under which this component should be registered |
| in the OSGi service registry.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#setInterface(java.lang.String,%20java.util.Dictionary)">setInterface</a></strong>(java.lang.String serviceName, |
| java.util.Dictionary<?,?> properties)</code> |
| <div class="block">Sets the public interface under which this component should be registered |
| in the OSGi service registry.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/dm/Component.html#setServiceProperties(java.util.Dictionary)">setServiceProperties</a></strong>(java.util.Dictionary<?,?> serviceProperties)</code> |
| <div class="block">Sets the service properties associated with the component.</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="setImplementation(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setImplementation</h4> |
| <pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setImplementation(java.lang.Object implementation)</pre> |
| <div class="block">Sets the implementation for this component. You can actually specify |
| an instance you have instantiated manually, or a <code>Class</code> |
| that will be instantiated using its default constructor when the |
| required dependencies are resolved, effectively giving you a lazy |
| instantiation mechanism. |
| |
| There are four special methods that are called when found through |
| reflection to give you life cycle management options: |
| <ol> |
| <li><code>init()</code> is invoked after the instance has been |
| created and dependencies have been resolved, and can be used to |
| initialize the internal state of the instance or even to add more |
| dependencies based on runtime state</li> |
| <li><code>start()</code> is invoked right before the service is |
| registered</li> |
| <li><code>stop()</code> is invoked right after the service is |
| unregistered</li> |
| <li><code>destroy()</code> is invoked after all dependencies are |
| removed</li> |
| </ol> |
| In short, this allows you to initialize your instance before it is |
| registered, perform some post-initialization and pre-destruction code |
| as well as final cleanup. If a method is not defined, it simply is not |
| called, so you can decide which one(s) you need. If you need even more |
| fine-grained control, you can register as a service state listener too.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>implementation</code> - the implementation</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>this component</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/felix/dm/ComponentStateListener.html" title="interface in org.apache.felix.dm"><code>ComponentStateListener</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="add(org.apache.felix.dm.Dependency...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> add(<a href="../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a>... dependencies)</pre> |
| <div class="block">Adds dependency(ies) to this component, atomically. If the component is already active or if you add |
| dependencies from the init method, then you should add all the dependencies in one single add method call |
| (using the varargs argument), because this method may trigger component activation (like |
| the ServiceTracker.open() method does).</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>dependencies</code> - the dependencies to add.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>this component</dd></dl> |
| </li> |
| </ul> |
| <a name="remove(org.apache.felix.dm.Dependency)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> remove(<a href="../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a> d)</pre> |
| <div class="block">Removes a dependency from the component.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>d</code> - the dependency to remove</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>this component</dd></dl> |
| </li> |
| </ul> |
| <a name="add(org.apache.felix.dm.ComponentStateListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> add(<a href="../../../../org/apache/felix/dm/ComponentStateListener.html" title="interface in org.apache.felix.dm">ComponentStateListener</a> listener)</pre> |
| <div class="block">Adds a component state listener to this component.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the state listener</dd></dl> |
| </li> |
| </ul> |
| <a name="remove(org.apache.felix.dm.ComponentStateListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remove</h4> |
| <pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> remove(<a href="../../../../org/apache/felix/dm/ComponentStateListener.html" title="interface in org.apache.felix.dm">ComponentStateListener</a> listener)</pre> |
| <div class="block">Removes a component state listener from this component.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the state listener</dd></dl> |
| </li> |
| </ul> |
| <a name="setInterface(java.lang.String, java.util.Dictionary)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInterface</h4> |
| <pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setInterface(java.lang.String serviceName, |
| java.util.Dictionary<?,?> properties)</pre> |
| <div class="block">Sets the public interface under which this component should be registered |
| in the OSGi service registry.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>serviceName</code> - the name of the service interface</dd><dd><code>properties</code> - the properties for this service</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>this component</dd></dl> |
| </li> |
| </ul> |
| <a name="setInterface(java.lang.String[], java.util.Dictionary)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInterface</h4> |
| <pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setInterface(java.lang.String[] serviceNames, |
| java.util.Dictionary<?,?> properties)</pre> |
| <div class="block">Sets the public interfaces under which this component should be registered |
| in the OSGi service registry.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>serviceNames</code> - the names of the service interface</dd><dd><code>properties</code> - the properties for these services</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>this component</dd></dl> |
| </li> |
| </ul> |
| <a name="setAutoConfig(java.lang.Class, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAutoConfig</h4> |
| <pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setAutoConfig(java.lang.Class<?> clazz, |
| boolean autoConfig)</pre> |
| <div class="block">Configures auto configuration of injected classes in the component instance. |
| The following injections are currently performed, unless you explicitly |
| turn them off: |
| <dl> |
| <dt>BundleContext</dt><dd>the bundle context of the bundle</dd> |
| <dt>ServiceRegistration</dt><dd>the service registration used to register your service</dd> |
| <dt>DependencyManager</dt><dd>the dependency manager instance</dd> |
| <dt>Component</dt><dd>the component instance of the dependency manager</dd> |
| </dl></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clazz</code> - the class (from the list above)</dd><dd><code>autoConfig</code> - <code>false</code> to turn off auto configuration</dd></dl> |
| </li> |
| </ul> |
| <a name="setAutoConfig(java.lang.Class, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAutoConfig</h4> |
| <pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setAutoConfig(java.lang.Class<?> clazz, |
| java.lang.String instanceName)</pre> |
| <div class="block">Configures auto configuration of injected classes in the component instance.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>clazz</code> - the class (from the list above)</dd><dd><code>instanceName</code> - the name of the instance to inject the class into</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/felix/dm/Component.html#setAutoConfig(java.lang.Class,%20boolean)"><code>setAutoConfig(Class, boolean)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getServiceRegistration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServiceRegistration</h4> |
| <pre>ServiceRegistration getServiceRegistration()</pre> |
| <div class="block">Returns the service registration for this component. The method |
| will return <code>null</code> if no service registration is |
| available, for example if this component is not registered as a |
| service at all.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the service registration</dd></dl> |
| </li> |
| </ul> |
| <a name="getInstance()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstance</h4> |
| <pre><T> T getInstance()</pre> |
| <div class="block">Returns the instance that make up this component. If the component has a composition of instances, |
| then the first instance of the composition is returned. Null is returned if the component has not |
| even been instantiated.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the component instances</dd></dl> |
| </li> |
| </ul> |
| <a name="getInstances()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstances</h4> |
| <pre>java.lang.Object[] getInstances()</pre> |
| <div class="block">Returns the composition instances that make up this component, or just the |
| component instance if it does not have a composition, or an empty array if |
| the component has not even been instantiated.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the component instances</dd></dl> |
| </li> |
| </ul> |
| <a name="getServiceProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServiceProperties</h4> |
| <pre><K,V> java.util.Dictionary<K,V> getServiceProperties()</pre> |
| <div class="block">Returns the service properties associated with the component.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the properties or <code>null</code> if there are none</dd></dl> |
| </li> |
| </ul> |
| <a name="setServiceProperties(java.util.Dictionary)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setServiceProperties</h4> |
| <pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setServiceProperties(java.util.Dictionary<?,?> serviceProperties)</pre> |
| <div class="block">Sets the service properties associated with the component. If the service |
| was already registered, it will be updated.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>serviceProperties</code> - the properties</dd></dl> |
| </li> |
| </ul> |
| <a name="setCallbacks(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCallbacks</h4> |
| <pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setCallbacks(java.lang.String init, |
| java.lang.String start, |
| java.lang.String stop, |
| java.lang.String destroy)</pre> |
| <div class="block">Sets the names of the methods used as callbacks. These methods, when found, are |
| invoked as part of the life cycle management of the component implementation. The |
| dependency manager will look for a method of this name with the following signatures, |
| in this order: |
| <ol> |
| <li>method(Component component)</li> |
| <li>method()</li> |
| </ol></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>init</code> - the name of the init method</dd><dd><code>start</code> - the name of the start method</dd><dd><code>stop</code> - the name of the stop method</dd><dd><code>destroy</code> - the name of the destroy method</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the component</dd></dl> |
| </li> |
| </ul> |
| <a name="setCallbacks(java.lang.Object, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCallbacks</h4> |
| <pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setCallbacks(java.lang.Object instance, |
| java.lang.String init, |
| java.lang.String start, |
| java.lang.String stop, |
| java.lang.String destroy)</pre> |
| <div class="block">Sets the names of the methods used as callbacks. These methods, when found, are |
| invoked on the specified instance as part of the life cycle management of the component |
| implementation. |
| <p> |
| See setCallbacks(String init, String start, String stop, String destroy) for more |
| information on the signatures. Specifying an instance means you can create a manager |
| that will be invoked whenever the life cycle of a component changes and this manager |
| can then decide how to expose this life cycle to the actual component, offering an |
| important indirection when developing your own component models.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>this component</dd></dl> |
| </li> |
| </ul> |
| <a name="setFactory(java.lang.Object, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFactory</h4> |
| <pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setFactory(java.lang.Object factory, |
| java.lang.String createMethod)</pre> |
| <div class="block">Sets the factory to use to create the implementation. You can specify |
| both the factory class and method to invoke. The method should return |
| the implementation, and can use any method to create it. Actually, this |
| can be used together with <code>setComposition</code> to create a |
| composition of instances that work together to implement a component. The |
| factory itself can also be instantiated lazily by not specifying an |
| instance, but a <code>Class</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - the factory instance or class</dd><dd><code>createMethod</code> - the name of the create method</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>this component</dd></dl> |
| </li> |
| </ul> |
| <a name="setFactory(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFactory</h4> |
| <pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setFactory(java.lang.String createMethod)</pre> |
| <div class="block">Sets the factory to use to create the implementation. You specify the |
| method to invoke. The method should return the implementation, and can |
| use any method to create it. Actually, this can be used together with |
| <code>setComposition</code> to create a composition of instances that |
| work together to implement a component. |
| <p> |
| Note that currently, there is no default for the factory, so please use |
| <code>setFactory(factory, createMethod)</code> instead.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>createMethod</code> - the name of the create method</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>this component</dd></dl> |
| </li> |
| </ul> |
| <a name="setComposition(java.lang.Object, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setComposition</h4> |
| <pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setComposition(java.lang.Object instance, |
| java.lang.String getMethod)</pre> |
| <div class="block">Sets the instance and method to invoke to get back all instances that |
| are part of a composition and need dependencies injected. All of them |
| will be searched for any of the dependencies. The method that is |
| invoked must return an <code>Object[]</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>instance</code> - the instance that has the method</dd><dd><code>getMethod</code> - the method to invoke</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>this component</dd></dl> |
| </li> |
| </ul> |
| <a name="setComposition(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setComposition</h4> |
| <pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setComposition(java.lang.String getMethod)</pre> |
| <div class="block">Sets the method to invoke on the service implementation to get back all |
| instances that are part of a composition and need dependencies injected. |
| All of them will be searched for any of the dependencies. The method that |
| is invoked must return an <code>Object[]</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>getMethod</code> - the method to invoke</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>this component</dd></dl> |
| </li> |
| </ul> |
| <a name="getDependencyManager()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDependencyManager</h4> |
| <pre><a href="../../../../org/apache/felix/dm/DependencyManager.html" title="class in org.apache.felix.dm">DependencyManager</a> getDependencyManager()</pre> |
| <div class="block">Returns the dependency manager associated with this component.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the dependency manager associated with this component.</dd></dl> |
| </li> |
| </ul> |
| <a name="getComponentDeclaration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentDeclaration</h4> |
| <pre><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html" title="interface in org.apache.felix.dm">ComponentDeclaration</a> getComponentDeclaration()</pre> |
| <div class="block">Returns the component description (dependencies, service provided, etc ...).</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the component description (dependencies, service provided, etc ...).</dd></dl> |
| </li> |
| </ul> |
| <a name="setDebug(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setDebug</h4> |
| <pre><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a> setDebug(java.lang.String label)</pre> |
| <div class="block">Activate debug for this component. Informations related to dependency processing will be displayed |
| using osgi log service, our to standard output if no log service is currently available.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>label</code> - </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="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="../../../../org/apache/felix/dm/BundleDependency.html" title="interface in org.apache.felix.dm"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/dm/ComponentDeclaration.html" title="interface in org.apache.felix.dm"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/dm/Component.html" target="_top">Frames</a></li> |
| <li><a href="Component.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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> |