Added: websites/staging/felix/trunk/content/apidocs/dependencymanager/r15/org/apache/felix/dm/ResourceComponent.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager/r15/org/apache/felix/dm/ResourceComponent.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager/r15/org/apache/felix/dm/ResourceComponent.html Sun Dec 23 13:41:37 2018 @@ -0,0 +1,1002 @@ +<!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>ResourceComponent</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="ResourceComponent"; + } + } + 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}; +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/PropertyMetaData.html" title="interface in org.apache.felix.dm"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/felix/dm/ResourceDependency.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/ResourceComponent.html" target="_top">Frames</a></li> +<li><a href="ResourceComponent.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 ResourceComponent" class="title">Interface ResourceComponent</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">ResourceComponent</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 resource adapter component. + + The resource adapter will be applied to any resource that + matches the specified filter condition. For each matching resource + an adapter will be created based on the adapter implementation class. + The adapter will be registered with the specified interface and existing properties + from the original resource plus any extra properties you supply here. + It will also inherit all dependencies, and if you declare the original + service as a member it will be injected. + + <h3>Usage Examples</h3> + + Here is a sample showing a VideoPlayer adapter component which plays a video found from + a bundle having a Video-Path manifest header. + + <blockquote><pre> + <code> + public class Activator extends DependencyActivatorBase { + &Override + public void init(BundleContext context, DependencyManager dm) throws Exception { + ResourceComponent resourceComponent = dm.createResourceComponent() + .setResourceFilter("(path=/videos/*.mkv)") + .setInterface(VideoPlayer.class, null) + .setImplementation(VideoPlayerImpl.class); + dm.add(resourceComponent); + } + } + + public interface VideoPlayer { + void play(); + } + + public class VideoPlayerImpl implements VideoPlayer { + volatile URL resource; // injected + + void play() { + ... + } + } + </code> </pre></blockquote> + + <p> When you use callbacks to get injected with the resource, the "add", "change" callbacks + support the following method signatures: + + <p> + <pre><code> + (Component, URL, Dictionary) + (Component, URL) + (Component) + (URL, Dictionary) + (URL) + (Object) + </code></pre></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/felix/dm/DependencyManager.html#createBundleComponent--"><code>DependencyManager.createBundleComponent()</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.html#setBundleCallbackInstance-java.lang.Object-">setBundleCallbackInstance</a></span>(java.lang.Object callbackInstance)</code> +<div class="block">Sets the instance to invoke the callbacks on (null by default, meaning the callbacks have to be invoked on the resource adapter itself)</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.html#setBundleCallbacks-java.lang.String-java.lang.String-">setBundleCallbacks</a></span>(java.lang.String add, + java.lang.String change)</code> +<div class="block">Sets the callbacks to invoke when injecting the resource into the adapter component.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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="i11" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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="i14" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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="i15" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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="i16" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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="i17" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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="i18" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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="i19" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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="i20" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.html#setPropagate-boolean-">setPropagate</a></span>(boolean propagate)</code> +<div class="block">Sets if properties from the resource should be propagated to the resource adapter service.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.html#setPropagate-java.lang.Object-java.lang.String-">setPropagate</a></span>(java.lang.Object propagateCbInstance, + java.lang.String propagateCbMethod)</code> +<div class="block">Sets the propagate callback to invoke in order to propagate the resource properties to the adapter service.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.html#setResourceFilter-java.lang.String-">setResourceFilter</a></span>(java.lang.String filter)</code> +<div class="block">Sets the resource filter used to match a given resource URL.</div> +</td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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="i24" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceComponent.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> +</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</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="setResourceFilter-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setResourceFilter</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a> setResourceFilter(java.lang.String filter)</pre> +<div class="block">Sets the resource filter used to match a given resource URL.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>filter</code> - the filter condition to use with the resource</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this ResourceComponent</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/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a> setPropagate(boolean propagate)</pre> +<div class="block">Sets if properties from the resource should be propagated to the resource adapter service. true by default.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>propagate</code> - true if if properties from the resource should be propagated to the resource adapter service. + true by default. + The provided resource adapter service properties take precedence over the propagated resource service properties.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this ResourceComponent</dd> +</dl> +</li> +</ul> +<a name="setPropagate-java.lang.Object-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPropagate</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a> setPropagate(java.lang.Object propagateCbInstance, + java.lang.String propagateCbMethod)</pre> +<div class="block">Sets the propagate callback to invoke in order to propagate the resource properties to the adapter service. + The provided resource adapter service properties take precedence over the propagated resource service properties.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>propagateCbInstance</code> - the object to invoke the propagate callback method on</dd> +<dd><code>propagateCbMethod</code> - the method name to invoke in order to propagate the resource properties to the adapter service.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this ResourceComponent</dd> +</dl> +</li> +</ul> +<a name="setBundleCallbacks-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBundleCallbacks</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a> setBundleCallbacks(java.lang.String add, + java.lang.String change)</pre> +<div class="block">Sets the callbacks to invoke when injecting the resource into the adapter component.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>add</code> - the method to invoke when injected the resource into the adapter component</dd> +<dd><code>change</code> - the method to invoke when the resource properties have changed</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this ResourceComponent</dd> +</dl> +</li> +</ul> +<a name="setBundleCallbackInstance-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setBundleCallbackInstance</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm">ResourceComponent</a> setBundleCallbackInstance(java.lang.Object callbackInstance)</pre> +<div class="block">Sets the instance to invoke the callbacks on (null by default, meaning the callbacks have to be invoked on the resource adapter itself)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>callbackInstance</code> - the instance to invoke the callbacks on (null by default, meaning the callbacks have to be invoked on the resource adapter itself)</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this ResourceComponent</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/PropertyMetaData.html" title="interface in org.apache.felix.dm"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/felix/dm/ResourceDependency.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/ResourceComponent.html" target="_top">Frames</a></li> +<li><a href="ResourceComponent.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>
Added: websites/staging/felix/trunk/content/apidocs/dependencymanager/r15/org/apache/felix/dm/ResourceDependency.html ============================================================================== --- websites/staging/felix/trunk/content/apidocs/dependencymanager/r15/org/apache/felix/dm/ResourceDependency.html (added) +++ websites/staging/felix/trunk/content/apidocs/dependencymanager/r15/org/apache/felix/dm/ResourceDependency.html Sun Dec 23 13:41:37 2018 @@ -0,0 +1,549 @@ +<!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>ResourceDependency</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="ResourceDependency"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/felix/dm/ResourceComponent.html" title="interface in org.apache.felix.dm"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/felix/dm/ResourceHandler.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/ResourceDependency.html" target="_top">Frames</a></li> +<li><a href="ResourceDependency.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 ResourceDependency" class="title">Interface ResourceDependency</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/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm">ComponentDependencyDeclaration</a>, <a href="../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html" title="interface in org.apache.felix.dm">ResourceHandler</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ResourceDependency</span> +extends <a href="../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm">ComponentDependencyDeclaration</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html" title="interface in org.apache.felix.dm">ResourceHandler</a></pre> +<div class="block">A resource dependency is a dependency on a resource. A resource in this context is an object that is + identified by a URL. Resources should somehow be provided by an external component, the resource + provider. These dependencies then react on them becoming available or not. Use cases for such dependencies + are resources that are embedded in bundles, in a workspace or some remote or local repository, etc. + + When a resource is injected using callbacks, the following method signatures are supported: + <p> + <pre><code> + (Component, URL, Dictionary) + (Component, URL) + (Component) + (URL, Dictionary) + (URL) + (Object) + </code></pre></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.felix.dm.ComponentDependencyDeclaration"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.felix.dm.<a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm">ComponentDependencyDeclaration</a></h3> +<code><a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_AVAILABLE_OPTIONAL">STATE_AVAILABLE_OPTIONAL</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_AVAILABLE_REQUIRED">STATE_AVAILABLE_REQUIRED</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_NAMES">STATE_NAMES</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_OPTIONAL">STATE_OPTIONAL</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_REQUIRED">STATE_REQUIRED</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_UNAVAILABLE_OPTIONAL">STATE_UNAVAILABLE_OPTIONAL</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#STATE_UNAVAILABLE_REQUIRED">STATE_UNAVAILABLE_REQUIRED</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.felix.dm.ResourceHandler"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.felix.dm.<a href="../../../../org/apache/felix/dm/ResourceHandler.html" title="interface in org.apache.felix.dm">ResourceHandler</a></h3> +<code><a href="../../../../org/apache/felix/dm/ResourceHandler.html#FILTER">FILTER</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#HOST">HOST</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#PATH">PATH</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#PORT">PORT</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#PROTOCOL">PROTOCOL</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#URL">URL</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/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setAutoConfig-boolean-">setAutoConfig</a></span>(boolean autoConfig)</code> +<div class="block">Sets auto configuration for this service.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setAutoConfig-java.lang.String-">setAutoConfig</a></span>(java.lang.String instanceName)</code> +<div class="block">Sets auto configuration for this service.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setCallbacks-java.lang.Object-java.lang.String-java.lang.String-">setCallbacks</a></span>(java.lang.Object instance, + java.lang.String added, + java.lang.String removed)</code> +<div class="block">Sets the callbacks for this service.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setCallbacks-java.lang.Object-java.lang.String-java.lang.String-java.lang.String-">setCallbacks</a></span>(java.lang.Object instance, + java.lang.String added, + java.lang.String changed, + java.lang.String removed)</code> +<div class="block">Sets the callbacks for this service.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setCallbacks-java.lang.String-java.lang.String-">setCallbacks</a></span>(java.lang.String added, + java.lang.String removed)</code> +<div class="block">Sets the callbacks for this service.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setCallbacks-java.lang.String-java.lang.String-java.lang.String-">setCallbacks</a></span>(java.lang.String added, + java.lang.String changed, + java.lang.String removed)</code> +<div class="block">Sets the callbacks for this service.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setFilter-java.lang.String-">setFilter</a></span>(java.lang.String resourceFilter)</code> +<div class="block">Sets the filter condition for this resource dependency.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setPropagate-boolean-">setPropagate</a></span>(boolean propagate)</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setPropagate-java.lang.Object-java.lang.String-">setPropagate</a></span>(java.lang.Object instance, + java.lang.String method)</code> +<div class="block">Sets an Object instance and a callback method used to propagate some properties to the provided service properties.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setRequired-boolean-">setRequired</a></span>(boolean required)</code> +<div class="block">Determines if this is a required dependency or not.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setResource-java.net.URL-">setResource</a></span>(java.net.URL resource)</code> +<div class="block">Sets the resource for this dependency.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.felix.dm.Dependency"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.felix.dm.<a href="../../../../org/apache/felix/dm/Dependency.html" title="interface in org.apache.felix.dm">Dependency</a></h3> +<code><a href="../../../../org/apache/felix/dm/Dependency.html#getAutoConfigName--">getAutoConfigName</a>, <a href="../../../../org/apache/felix/dm/Dependency.html#getProperties--">getProperties</a>, <a href="../../../../org/apache/felix/dm/Dependency.html#isAutoConfig--">isAutoConfig</a>, <a href="../../../../org/apache/felix/dm/Dependency.html#isAvailable--">isAvailable</a>, <a href="../../../../org/apache/felix/dm/Dependency.html#isPropagated--">isPropagated</a>, <a href="../../../../org/apache/felix/dm/Dependency.html#isRequired--">isRequired</a>, <a href="../../../../org/apache/felix/dm/Dependency.html#overrideServiceProperties--">overrideServiceProperties</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.felix.dm.ComponentDependencyDeclaration"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.felix.dm.<a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html" title="interface in org.apache.felix.dm">ComponentDependencyDeclaration</a></h3> +<code><a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#getFilter--">getFilter</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#getName--">getName</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#getSimpleName--">getSimpleName</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#getState--">getState</a>, <a href="../../../../org/apache/felix/dm/ComponentDependencyDeclaration.html#getType--">getType</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.felix.dm.ResourceHandler"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.felix.dm.<a href="../../../../org/apache/felix/dm/ResourceHandler.html" title="interface in org.apache.felix.dm">ResourceHandler</a></h3> +<code><a href="../../../../org/apache/felix/dm/ResourceHandler.html#added-java.net.URL-">added</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#added-java.net.URL-java.util.Dictionary-">added</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#changed-java.net.URL-">changed</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#changed-java.net.URL-java.util.Dictionary-">changed</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#removed-java.net.URL-">removed</a>, <a href="../../../../org/apache/felix/dm/ResourceHandler.html#removed-java.net.URL-java.util.Dictionary-">removed</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="setCallbacks-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCallbacks</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setCallbacks(java.lang.String added, + java.lang.String removed)</pre> +<div class="block">Sets the callbacks for this service. These callbacks can be used as hooks whenever a + dependency is added or removed. When you specify callbacks, the auto configuration + feature is automatically turned off, because we're assuming you don't need it in this + case.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>added</code> - the method to call when a service was added</dd> +<dd><code>removed</code> - the method to call when a service was removed</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this service dependency</dd> +</dl> +</li> +</ul> +<a name="setCallbacks-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/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setCallbacks(java.lang.String added, + java.lang.String changed, + java.lang.String removed)</pre> +<div class="block">Sets the callbacks for this service. These callbacks can be used as hooks whenever a + dependency is added, changed or removed. When you specify callbacks, the auto + configuration feature is automatically turned off, because we're assuming you don't + need it in this case.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>added</code> - the method to call when a service was added</dd> +<dd><code>changed</code> - the method to call when a service was changed</dd> +<dd><code>removed</code> - the method to call when a service was removed</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this service dependency</dd> +</dl> +</li> +</ul> +<a name="setCallbacks-java.lang.Object-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCallbacks</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setCallbacks(java.lang.Object instance, + java.lang.String added, + java.lang.String removed)</pre> +<div class="block">Sets the callbacks for this service. These callbacks can be used as hooks whenever a + dependency is added or removed. They are called on the instance you provide. When you + specify callbacks, the auto configuration feature is automatically turned off, because + we're assuming you don't need it in this case.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>instance</code> - the instance to call the callbacks on</dd> +<dd><code>added</code> - the method to call when a service was added</dd> +<dd><code>removed</code> - the method to call when a service was removed</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this service dependency</dd> +</dl> +</li> +</ul> +<a name="setCallbacks-java.lang.Object-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/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setCallbacks(java.lang.Object instance, + java.lang.String added, + java.lang.String changed, + java.lang.String removed)</pre> +<div class="block">Sets the callbacks for this service. These callbacks can be used as hooks whenever a + dependency is added, changed or removed. They are called on the instance you provide. When you + specify callbacks, the auto configuration feature is automatically turned off, because + we're assuming you don't need it in this case.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>instance</code> - the instance to call the callbacks on</dd> +<dd><code>added</code> - the method to call when a service was added</dd> +<dd><code>changed</code> - the method to call when a service was changed</dd> +<dd><code>removed</code> - the method to call when a service was removed</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this service dependency</dd> +</dl> +</li> +</ul> +<a name="setAutoConfig-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAutoConfig</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setAutoConfig(boolean autoConfig)</pre> +<div class="block">Sets auto configuration for this service. Auto configuration allows the + dependency to fill in any attributes in the service implementation that + are of the same type as this dependency. Default is on.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>autoConfig</code> - the value of auto config</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this service dependency</dd> +</dl> +</li> +</ul> +<a name="setAutoConfig-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAutoConfig</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setAutoConfig(java.lang.String instanceName)</pre> +<div class="block">Sets auto configuration for this service. Auto configuration allows the + dependency to fill in the attribute in the service implementation that + has the same type and instance name.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>instanceName</code> - the name of attribute to auto config</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this service dependency</dd> +</dl> +</li> +</ul> +<a name="setResource-java.net.URL-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setResource</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setResource(java.net.URL resource)</pre> +<div class="block">Sets the resource for this dependency.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>resource</code> - the URL of the resource</dd> +</dl> +</li> +</ul> +<a name="setRequired-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRequired</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setRequired(boolean required)</pre> +<div class="block">Determines if this is a required dependency or not.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>required</code> - <code>true</code> if the dependency is required</dd> +</dl> +</li> +</ul> +<a name="setFilter-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFilter</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setFilter(java.lang.String resourceFilter)</pre> +<div class="block">Sets the filter condition for this resource dependency.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>resourceFilter</code> - the filter condition</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/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setPropagate(boolean propagate)</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/felix/dm/ResourceDependency.html#setPropagate-java.lang.Object-java.lang.String-"><code>setPropagate(Object, String)</code></a></dd> +</dl> +</li> +</ul> +<a name="setPropagate-java.lang.Object-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setPropagate</h4> +<pre><a href="../../../../org/apache/felix/dm/ResourceDependency.html" title="interface in org.apache.felix.dm">ResourceDependency</a> setPropagate(java.lang.Object instance, + java.lang.String method)</pre> +<div class="block">Sets an Object instance and a callback method used to propagate some properties to the provided service properties. + The method will be invoked on the specified object instance and must have one of the following signatures:<p> + <ul><li>Dictionary callback(ServiceReference, Object service) + <li>Dictionary callback(ServiceReference) + </ul> + The provided service properties take precedence over the propagated service dependency properties. It means a resource dependency + property won't override a component service property having the same name.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>instance</code> - the Object instance which is used to retrieve propagated service properties</dd> +<dd><code>method</code> - the method to invoke for retrieving the properties to be propagated to the service properties.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this service dependency.</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/ResourceComponent.html" title="interface in org.apache.felix.dm"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/felix/dm/ResourceHandler.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/ResourceDependency.html" target="_top">Frames</a></li> +<li><a href="ResourceDependency.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>
