| <!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 (1.8.0_191) on Sun Dec 23 12:06:06 CET 2018 --> |
| <title>FactoryComponent</title> |
| <meta name="date" content="2018-12-23"> |
| <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="FactoryComponent"; |
| } |
| } |
| 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,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":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="../../../../org/apache/felix/dm/DependencyManager.html" title="class in org.apache.felix.dm"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/dm/FilterIndex.html" title="interface in org.apache.felix.dm"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/dm/FactoryComponent.html" target="_top">Frames</a></li> |
| <li><a href="FactoryComponent.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 FactoryComponent" class="title">Interface FactoryComponent</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/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">FactoryComponent</span> |
| extends <a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></pre> |
| <div class="block">Interface used to configure the various parameters needed when defining |
| a Dependency Manager factory component. |
| A factory component is a component which can be instantiated multiple times using standard |
| OSGi Factory Configurations.<p> |
| |
| When a factory configuration is created, an instance of the component is created and the configuration |
| is injected by default in the "updated" callback, which supports the following signatures: |
| |
| <ul> |
| <li>callback(Dictionary) |
| <li>callback(Component, Dictionary) |
| <li>callback(Component, Configuration ... configTypes) // type safe configuration interface(s) |
| <li>callback(Configuration ... configTypes) // type safe configuration interface(s) |
| <li>callback(Dictionary, Configuration ... configTypes) // type safe configuration interfaces(s) |
| <li>callback(Component, Dictionary, Configuration ... configTypes) // type safe configuration interfaces(s) |
| </ul> |
| |
| <h3>Usage Examples</h3> |
| |
| Here is a sample showing a Hello component, which can be instantiated multiple times using a factory configuration: |
| |
| <blockquote><pre> |
| <code> |
| public class Activator extends DependencyActivatorBase { |
| &Override |
| public void init(BundleContext context, DependencyManager dm) throws Exception { |
| FactoryComponent factoryComponent = createFactoryComponent() |
| .setFactoryPid("my.factory.pid") |
| .setInterface(MySevice.class.getName(), null) |
| .setImplementation(MyComponent.class) |
| .setConfigType(MyConfig.class); |
| dm.add(factoryComponent); |
| } |
| } |
| |
| public interface MyConfig { |
| int getPort(); |
| String getAddress(); |
| } |
| |
| public class MyComponent implements MyService { |
| void updated(MyConfig cnf) { |
| int port = cnf.getPort(); |
| String addr = cnf.getAddress(); |
| ... |
| } |
| } |
| </code> </pre></blockquote></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/felix/dm/DependencyManager.html#createFactoryComponent--"><code>DependencyManager.createFactoryComponent()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.felix.dm.Component"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.felix.dm.<a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></h3> |
| <code><a href="../../../../org/apache/felix/dm/Component.ServiceScope.html" title="enum in org.apache.felix.dm">Component.ServiceScope</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></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><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#add-org.apache.felix.dm.ComponentStateListener-">add</a></span>(<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 id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#add-org.apache.felix.dm.Dependency...-">add</a></span>(<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 id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#add-org.apache.felix.dm.PropertyMetaData...-">add</a></span>(<a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a>... metaData)</code> |
| <div class="block">Sets metatype MetaData regarding configuration properties.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#remove-org.apache.felix.dm.ComponentStateListener-">remove</a></span>(<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 id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#remove-org.apache.felix.dm.Dependency-">remove</a></span>(<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 id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setAutoConfig-java.lang.Class-boolean-">setAutoConfig</a></span>(java.lang.Class<?> clazz, |
| boolean autoConfig)</code> |
| <div class="block">Configures auto configuration of injected classes in the component instance.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setAutoConfig-java.lang.Class-java.lang.String-">setAutoConfig</a></span>(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 id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setCallbacks-java.lang.Object-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">setCallbacks</a></span>(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 id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setCallbacks-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">setCallbacks</a></span>(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 id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setComposition-java.lang.Object-java.lang.String-">setComposition</a></span>(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 id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setComposition-java.lang.String-">setComposition</a></span>(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 id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setConfigType-java.lang.Class...-">setConfigType</a></span>(java.lang.Class<?>... configTypes)</code> |
| <div class="block">Sets the configuration type to use instead of a dictionary.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setDebug-java.lang.String-">setDebug</a></span>(java.lang.String label)</code> |
| <div class="block">Activate debug for this component.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setDesc-java.lang.String-">setDesc</a></span>(java.lang.String desc)</code> |
| <div class="block">A metatype human readable description of the factory PID this configuration is associated with.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setFactory-java.lang.Object-java.lang.String-">setFactory</a></span>(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 id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setFactory-java.lang.String-">setFactory</a></span>(java.lang.String createMethod)</code> |
| <div class="block">Sets the factory to use to create the implementation.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setFactoryPid-java.lang.Class-">setFactoryPid</a></span>(java.lang.Class<?> clazz)</code> |
| <div class="block">Sets the pid matching the factory configuration using the specified class.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setFactoryPid-java.lang.String-">setFactoryPid</a></span>(java.lang.String factoryPid)</code> |
| <div class="block">Sets the pid matching the factory configuration</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setHeading-java.lang.String-">setHeading</a></span>(java.lang.String heading)</code> |
| <div class="block">Sets the metatype label used to display the tab name (or section) where the properties are displayed.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setImplementation-java.lang.Object-">setImplementation</a></span>(java.lang.Object implementation)</code> |
| <div class="block">Sets the implementation for this component.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setInterface-java.lang.Class:A-java.util.Dictionary-">setInterface</a></span>(java.lang.Class<?>[] 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 id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setInterface-java.lang.Class-java.util.Dictionary-">setInterface</a></span>(java.lang.Class<?> 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 id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setInterface-java.lang.String:A-java.util.Dictionary-">setInterface</a></span>(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 id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setInterface-java.lang.String-java.util.Dictionary-">setInterface</a></span>(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 id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setLocalization-java.lang.String-">setLocalization</a></span>(java.lang.String localization)</code> |
| <div class="block">Points to the metatype basename of the Properties file that can localize the Meta Type informations.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setPropagate-boolean-">setPropagate</a></span>(boolean propagate)</code> |
| <div class="block">Sets the propagate flag (true means all public configuration properties are propagated to service properties).</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setScope-org.apache.felix.dm.Component.ServiceScope-">setScope</a></span>(<a href="../../../../org/apache/felix/dm/Component.ServiceScope.html" title="enum in org.apache.felix.dm">Component.ServiceScope</a> scope)</code> |
| <div class="block">Sets the component scope.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setServiceProperties-java.util.Dictionary-">setServiceProperties</a></span>(java.util.Dictionary<?,?> serviceProperties)</code> |
| <div class="block">Sets the service properties associated with the component.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setUpdated-java.lang.String-">setUpdated</a></span>(java.lang.String update)</code> |
| <div class="block">Sets the method name that will be notified when the factory configuration is created/updated.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setUpdateInstance-java.lang.Object-">setUpdateInstance</a></span>(java.lang.Object updatedCallbackInstance)</code> |
| <div class="block">Sets the object on which the updated callback will be invoked.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.felix.dm.Component"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.felix.dm.<a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></h3> |
| <code><a href="../../../../org/apache/felix/dm/Component.html#getComponentDeclaration--">getComponentDeclaration</a>, <a href="../../../../org/apache/felix/dm/Component.html#getDependencyManager--">getDependencyManager</a>, <a href="../../../../org/apache/felix/dm/Component.html#getInstance--">getInstance</a>, <a href="../../../../org/apache/felix/dm/Component.html#getInstances--">getInstances</a>, <a href="../../../../org/apache/felix/dm/Component.html#getServiceProperties--">getServiceProperties</a>, <a href="../../../../org/apache/felix/dm/Component.html#getServiceRegistration--">getServiceRegistration</a></code></li> |
| </ul> |
| </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="setScope-org.apache.felix.dm.Component.ServiceScope-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setScope</h4> |
| <pre><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a> setScope(<a href="../../../../org/apache/felix/dm/Component.ServiceScope.html" title="enum in org.apache.felix.dm">Component.ServiceScope</a> scope)</pre> |
| <div class="block">Sets the component scope.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#setScope-org.apache.felix.dm.Component.ServiceScope-">setScope</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scope</code> - the component scope (default=SINGLETON)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this component</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setImplementation-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setImplementation</h4> |
| <pre><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#setImplementation-java.lang.Object-">setImplementation</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>implementation</code> - the implementation</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this component</dd> |
| <dt><span class="seeLabel">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/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#add-org.apache.felix.dm.Dependency...-">add</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dependencies</code> - the dependencies to add.</dd> |
| <dt><span class="returnLabel">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/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#remove-org.apache.felix.dm.Dependency-">remove</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>d</code> - the dependency to remove</dd> |
| <dt><span class="returnLabel">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/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#add-org.apache.felix.dm.ComponentStateListener-">add</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">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/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#remove-org.apache.felix.dm.ComponentStateListener-">remove</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">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/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#setInterface-java.lang.String-java.util.Dictionary-">setInterface</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>this component</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInterface-java.lang.String:A-java.util.Dictionary-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInterface</h4> |
| <pre><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#setInterface-java.lang.String:A-java.util.Dictionary-">setInterface</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>this component</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInterface-java.lang.Class-java.util.Dictionary-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInterface</h4> |
| <pre><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a> setInterface(java.lang.Class<?> 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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#setInterface-java.lang.Class-java.util.Dictionary-">setInterface</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>this component</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInterface-java.lang.Class:A-java.util.Dictionary-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInterface</h4> |
| <pre><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a> setInterface(java.lang.Class<?>[] 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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#setInterface-java.lang.Class:A-java.util.Dictionary-">setInterface</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">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="returnLabel">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/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#setAutoConfig-java.lang.Class-boolean-">setAutoConfig</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">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/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#setAutoConfig-java.lang.Class-java.lang.String-">setAutoConfig</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">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="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/felix/dm/FactoryComponent.html#setAutoConfig-java.lang.Class-boolean-"><code>setAutoConfig(Class, boolean)</code></a></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/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#setServiceProperties-java.util.Dictionary-">setServiceProperties</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">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/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#setCallbacks-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">setCallbacks</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">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="returnLabel">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/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#setCallbacks-java.lang.Object-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">setCallbacks</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="returnLabel">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/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#setFactory-java.lang.Object-java.lang.String-">setFactory</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">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="returnLabel">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/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#setFactory-java.lang.String-">setFactory</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>createMethod</code> - the name of the create method</dd> |
| <dt><span class="returnLabel">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/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#setComposition-java.lang.Object-java.lang.String-">setComposition</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">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="returnLabel">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/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#setComposition-java.lang.String-">setComposition</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>getMethod</code> - the method to invoke</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this component</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDebug-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDebug</h4> |
| <pre><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/dm/Component.html#setDebug-java.lang.String-">setDebug</a></code> in interface <code><a href="../../../../org/apache/felix/dm/Component.html" title="interface in org.apache.felix.dm">Component</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>label</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFactoryPid-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFactoryPid</h4> |
| <pre><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a> setFactoryPid(java.lang.String factoryPid)</pre> |
| <div class="block">Sets the pid matching the factory configuration</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>factoryPid</code> - the pid matching the factory configuration</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFactoryPid-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFactoryPid</h4> |
| <pre><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a> setFactoryPid(java.lang.Class<?> clazz)</pre> |
| <div class="block">Sets the pid matching the factory configuration using the specified class. |
| The FQDN of the specified class will be used as the factory pid.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>clazz</code> - the class whose FQDN name will be used for the factory pid</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setUpdated-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUpdated</h4> |
| <pre><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a> setUpdated(java.lang.String update)</pre> |
| <div class="block">Sets the method name that will be notified when the factory configuration is created/updated. |
| By default, the callback name used is <code>updated</code> |
| TODO describe supported signatures</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>update</code> - the method name that will be notified when the factory configuration is created/updated.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setUpdateInstance-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUpdateInstance</h4> |
| <pre><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a> setUpdateInstance(java.lang.Object updatedCallbackInstance)</pre> |
| <div class="block">Sets the object on which the updated callback will be invoked. |
| By default, the callback is invoked on the component instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>updatedCallbackInstance</code> - the object on which the updated callback will be invoked.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPropagate-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPropagate</h4> |
| <pre><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a> setPropagate(boolean propagate)</pre> |
| <div class="block">Sets the propagate flag (true means all public configuration properties are propagated to service properties). |
| By default, public configurations are not propagated.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>propagate</code> - the propagate flag (false, by default; true means all public configuration properties are propagated to service properties).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setConfigType-java.lang.Class...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConfigType</h4> |
| <pre><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a> setConfigType(java.lang.Class<?>... configTypes)</pre> |
| <div class="block">Sets the configuration type to use instead of a dictionary. The updated callback is assumed to take |
| as arguments the specified configuration types in the same order they are provided in this method. |
| Optionally, the callback may define a Dictionary as the first argument, in order to also get the raw configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configTypes</code> - the configuration type to use instead of a dictionary</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/felix/dm/ConfigurationDependency.html" title="interface in org.apache.felix.dm"><code>ConfigurationDependency</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setHeading-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHeading</h4> |
| <pre><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a> setHeading(java.lang.String heading)</pre> |
| <div class="block">Sets the metatype label used to display the tab name (or section) where the properties are displayed. |
| Example: "Printer Service"</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>heading</code> - the label used to display the tab name (or section) where the properties are displayed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDesc-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDesc</h4> |
| <pre><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a> setDesc(java.lang.String desc)</pre> |
| <div class="block">A metatype human readable description of the factory PID this configuration is associated with.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>desc</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLocalization-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLocalization</h4> |
| <pre><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a> setLocalization(java.lang.String localization)</pre> |
| <div class="block">Points to the metatype basename of the Properties file that can localize the Meta Type informations. |
| The default localization base name for the properties is OSGI-INF/l10n/bundle, but can |
| be overridden by the manifest Bundle-Localization header (see core specification, in section Localization |
| on page 68). You can specify a specific localization basename file using this parameter |
| (e.g. <code>"person"</code> will match person_du_NL.properties in the root bundle directory).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>localization</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="add-org.apache.felix.dm.PropertyMetaData...-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre><a href="../../../../org/apache/felix/dm/FactoryComponent.html" title="interface in org.apache.felix.dm">FactoryComponent</a> add(<a href="../../../../org/apache/felix/dm/PropertyMetaData.html" title="interface in org.apache.felix.dm">PropertyMetaData</a>... metaData)</pre> |
| <div class="block">Sets metatype MetaData regarding configuration properties.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>metaData</code> - the metadata regarding configuration properties</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="../../../../org/apache/felix/dm/DependencyManager.html" title="class in org.apache.felix.dm"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/dm/FilterIndex.html" title="interface in org.apache.felix.dm"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/dm/FactoryComponent.html" target="_top">Frames</a></li> |
| <li><a href="FactoryComponent.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> |