| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_25) on Mon Jul 01 15:12:59 CEST 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>Index (Apache Felix Declarative Services 1.0.0 API)</title> |
| <meta name="date" content="2013-07-01"> |
| <link rel="stylesheet" type="text/css" href="./stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Index (Apache Felix Declarative Services 1.0.0 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="./org/apache/felix/scr/package-summary.html">Package</a></li> |
| <li>Class</li> |
| <li>Use</li> |
| <li><a href="./org/apache/felix/scr/package-tree.html">Tree</a></li> |
| <li><a href="./deprecated-list.html">Deprecated</a></li> |
| <li class="navBarCell1Rev">Index</li> |
| <li><a href="./help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev</li> |
| <li>Next</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="./index.html?index-all.html" target="_top">Frames</a></li> |
| <li><a href="index-all.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> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="contentContainer"><a href="#_C_">C</a> <a href="#_D_">D</a> <a href="#_E_">E</a> <a href="#_G_">G</a> <a href="#_I_">I</a> <a href="#_O_">O</a> <a href="#_R_">R</a> <a href="#_S_">S</a> <a name="_C_"> |
| <!-- --> |
| </a> |
| <h2 class="title">C</h2> |
| <dl> |
| <dt><a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr"><span class="strong">Component</span></a> - Interface in <a href="./org/apache/felix/scr/package-summary.html">org.apache.felix.scr</a></dt> |
| <dd> |
| <div class="block">The <code>Component</code> interface represents a single component managed |
| by the Service Component Runtime.</div> |
| </dd> |
| </dl> |
| <a name="_D_"> |
| <!-- --> |
| </a> |
| <h2 class="title">D</h2> |
| <dl> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#disable()">disable()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">Disables this Component if it is enabled.</div> |
| </dd> |
| </dl> |
| <a name="_E_"> |
| <!-- --> |
| </a> |
| <h2 class="title">E</h2> |
| <dl> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#enable()">enable()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">Enables this Component if it is disabled.</div> |
| </dd> |
| </dl> |
| <a name="_G_"> |
| <!-- --> |
| </a> |
| <h2 class="title">G</h2> |
| <dl> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Reference.html#getBindMethodName()">getBindMethodName()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Reference.html" title="interface in org.apache.felix.scr">Reference</a></dt> |
| <dd> |
| <div class="block">Returns the name of the method called if a service is being bound to |
| the Component or <code>null</code> if no such method is configued.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#getBundle()">getBundle()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">Returns the <code>Bundle</code> declaring this component.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#getClassName()">getClassName()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">Returns the class name of the Component implementation.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/ScrService.html#getComponent(long)">getComponent(long)</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/ScrService.html" title="interface in org.apache.felix.scr">ScrService</a></dt> |
| <dd> |
| <div class="block">Returns the component whose component.id matches the given |
| <code>componentId</code> or <code>null</code> if no component with the |
| given id is currently managed.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/ScrService.html#getComponents()">getComponents()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/ScrService.html" title="interface in org.apache.felix.scr">ScrService</a></dt> |
| <dd> |
| <div class="block">Returns an array of all components managed by this SCR instance.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/ScrService.html#getComponents(org.osgi.framework.Bundle)">getComponents(Bundle)</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/ScrService.html" title="interface in org.apache.felix.scr">ScrService</a></dt> |
| <dd> |
| <div class="block">Reuturns an array of all components managed by this SCR instance on |
| behalf of the given bundle.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#getFactory()">getFactory()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">Returns the component factory name or <code>null</code> if this component |
| is not defined as a component factory.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#getId()">getId()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">Returns the component ID of this component.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#getName()">getName()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">Returns the name of the component, which is also used as the service PID.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Reference.html#getName()">getName()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Reference.html" title="interface in org.apache.felix.scr">Reference</a></dt> |
| <dd> |
| <div class="block">Returns the name of this Reference.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#getProperties()">getProperties()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">Returns the properties of the Component.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#getReferences()">getReferences()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">Returns an array of <a href="./org/apache/felix/scr/Reference.html" title="interface in org.apache.felix.scr"><code>Reference</code></a> instances representing the service |
| references (or dependencies) of this Component.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Reference.html#getServiceName()">getServiceName()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Reference.html" title="interface in org.apache.felix.scr">Reference</a></dt> |
| <dd> |
| <div class="block">Returns the name of the service used by this Reference.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Reference.html#getServiceReferences()">getServiceReferences()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Reference.html" title="interface in org.apache.felix.scr">Reference</a></dt> |
| <dd> |
| <div class="block">Returns an array of references to the services bound to this Reference |
| or <code>null</code> if no services are currently bound.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#getServices()">getServices()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">Returns an array of service names provided by this Component or |
| <code>null</code> if the Component is not registered as a service.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#getState()">getState()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">Returns the current state of the Component, which is one of the |
| <code>STATE_*</code> constants defined in this interface.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Reference.html#getTarget()">getTarget()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Reference.html" title="interface in org.apache.felix.scr">Reference</a></dt> |
| <dd> |
| <div class="block">Returns the value of the target property of this reference.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Reference.html#getUnbindMethodName()">getUnbindMethodName()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Reference.html" title="interface in org.apache.felix.scr">Reference</a></dt> |
| <dd> |
| <div class="block">Returns the name of the method called if a service is being unbound from |
| the Component or <code>null</code> if no such method is configued.</div> |
| </dd> |
| </dl> |
| <a name="_I_"> |
| <!-- --> |
| </a> |
| <h2 class="title">I</h2> |
| <dl> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#isDefaultEnabled()">isDefaultEnabled()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">Returns whether the Component is declared to be enabled initially.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#isImmediate()">isImmediate()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">Returns whether the Component is an Immediate or a Delayed Component.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Reference.html#isMultiple()">isMultiple()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Reference.html" title="interface in org.apache.felix.scr">Reference</a></dt> |
| <dd> |
| <div class="block">Returns whether this reference is multiple.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Reference.html#isOptional()">isOptional()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Reference.html" title="interface in org.apache.felix.scr">Reference</a></dt> |
| <dd> |
| <div class="block">Returns whether this reference is optional.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Reference.html#isSatisfied()">isSatisfied()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Reference.html" title="interface in org.apache.felix.scr">Reference</a></dt> |
| <dd> |
| <div class="block">Returns whether this reference is satisified.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#isServiceFactory()">isServiceFactory()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">Returns <code>true</code> if this component is a service factory.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Reference.html#isStatic()">isStatic()</a></span> - Method in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Reference.html" title="interface in org.apache.felix.scr">Reference</a></dt> |
| <dd> |
| <div class="block">Returns <code>true</code> if the reference is defined with static policy.</div> |
| </dd> |
| </dl> |
| <a name="_O_"> |
| <!-- --> |
| </a> |
| <h2 class="title">O</h2> |
| <dl> |
| <dt><a href="./org/apache/felix/scr/package-summary.html">org.apache.felix.scr</a> - package org.apache.felix.scr</dt> |
| <dd> </dd> |
| </dl> |
| <a name="_R_"> |
| <!-- --> |
| </a> |
| <h2 class="title">R</h2> |
| <dl> |
| <dt><a href="./org/apache/felix/scr/Reference.html" title="interface in org.apache.felix.scr"><span class="strong">Reference</span></a> - Interface in <a href="./org/apache/felix/scr/package-summary.html">org.apache.felix.scr</a></dt> |
| <dd> |
| <div class="block">The <code>Reference</code> interface represents a single reference (or |
| dependency) to a service used by a Component.</div> |
| </dd> |
| </dl> |
| <a name="_S_"> |
| <!-- --> |
| </a> |
| <h2 class="title">S</h2> |
| <dl> |
| <dt><a href="./org/apache/felix/scr/ScrService.html" title="interface in org.apache.felix.scr"><span class="strong">ScrService</span></a> - Interface in <a href="./org/apache/felix/scr/package-summary.html">org.apache.felix.scr</a></dt> |
| <dd> |
| <div class="block">The <code>ScrService</code> represents the Declarative Services main |
| controller also known as the Service Component Runtime or SCR for short.</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#STATE_ACTIVATING">STATE_ACTIVATING</a></span> - Static variable in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">The Component is currently being activated either because it has been |
| enabled or because any dependency which was previously unsatisfied has |
| become satisfied (value is 8).</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#STATE_ACTIVE">STATE_ACTIVE</a></span> - Static variable in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">The Component has successfully been activated and is fully functional |
| (value is 16).</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#STATE_DEACTIVATING">STATE_DEACTIVATING</a></span> - Static variable in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">The Component is being deactivated either because it is being disabled |
| or because a dependency is not satisfied any more (value is 128).</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#STATE_DESTROYED">STATE_DESTROYED</a></span> - Static variable in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">The Component has been destroyed and cannot be used any more (value is |
| 256).</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#STATE_DISABLED">STATE_DISABLED</a></span> - Static variable in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">The Component has just been created and is still disabled or it has |
| been disabled by calling the <a href="./org/apache/felix/scr/Component.html#disable()"><code>disable()</code></a> method (value is 1).</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#STATE_ENABLED">STATE_ENABLED</a></span> - Static variable in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">The Component has been enabled and is now going to be activated (value |
| is 2).</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#STATE_FACTORY">STATE_FACTORY</a></span> - Static variable in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">The Component is a Component Factory ready to manage Component instances |
| from configuration data received from the Configuration Admin Service |
| (value is 64).</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#STATE_REGISTERED">STATE_REGISTERED</a></span> - Static variable in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">The Component has successfully been activated but is a Delayed or Service |
| Factory Component pending instantiation on first use (value is 32).</div> |
| </dd> |
| <dt><span class="strong"><a href="./org/apache/felix/scr/Component.html#STATE_UNSATISFIED">STATE_UNSATISFIED</a></span> - Static variable in interface org.apache.felix.scr.<a href="./org/apache/felix/scr/Component.html" title="interface in org.apache.felix.scr">Component</a></dt> |
| <dd> |
| <div class="block">The Component activation failed because any dependency is not satisfied |
| (value is 4).</div> |
| </dd> |
| </dl> |
| <a href="#_C_">C</a> <a href="#_D_">D</a> <a href="#_E_">E</a> <a href="#_G_">G</a> <a href="#_I_">I</a> <a href="#_O_">O</a> <a href="#_R_">R</a> <a href="#_S_">S</a> </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="./org/apache/felix/scr/package-summary.html">Package</a></li> |
| <li>Class</li> |
| <li>Use</li> |
| <li><a href="./org/apache/felix/scr/package-tree.html">Tree</a></li> |
| <li><a href="./deprecated-list.html">Deprecated</a></li> |
| <li class="navBarCell1Rev">Index</li> |
| <li><a href="./help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev</li> |
| <li>Next</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="./index.html?index-all.html" target="_top">Frames</a></li> |
| <li><a href="index-all.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> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |