| <!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 14:53:20 CEST 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>ConfigurationAdmin (Apache Felix Configuration Admin Service 1.2.4 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="ConfigurationAdmin (Apache Felix Configuration Admin Service 1.2.4 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ConfigurationAdmin.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/osgi/service/cm/Configuration.html" title="interface in org.osgi.service.cm"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/osgi/service/cm/ConfigurationEvent.html" title="class in org.osgi.service.cm"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/osgi/service/cm/ConfigurationAdmin.html" target="_top">Frames</a></li> |
| <li><a href="ConfigurationAdmin.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><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </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.osgi.service.cm</div> |
| <h2 title="Interface ConfigurationAdmin" class="title">Interface ConfigurationAdmin</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">ConfigurationAdmin</span></pre> |
| <div class="block">Service for administering configuration data. |
| |
| <p> |
| The main purpose of this interface is to store bundle configuration data |
| persistently. This information is represented in <code>Configuration</code> |
| objects. The actual configuration data is a <code>Dictionary</code> of |
| properties inside a <code>Configuration</code> object. |
| |
| <p> |
| There are two principally different ways to manage configurations. First |
| there is the concept of a Managed Service, where configuration data is |
| uniquely associated with an object registered with the service registry. |
| |
| <p> |
| Next, there is the concept of a factory where the Configuration Admin service |
| will maintain 0 or more <code>Configuration</code> objects for a Managed |
| Service Factory that is registered with the Framework. |
| |
| <p> |
| The first concept is intended for configuration data about "things/services" |
| whose existence is defined externally, e.g. a specific printer. Factories are |
| intended for "things/services" that can be created any number of times, e.g. |
| a configuration for a DHCP server for different networks. |
| |
| <p> |
| Bundles that require configuration should register a Managed Service or a |
| Managed Service Factory in the service registry. A registration property |
| named <code>service.pid</code> (persistent identifier or PID) must be used to |
| identify this Managed Service or Managed Service Factory to the Configuration |
| Admin service. |
| |
| <p> |
| When the ConfigurationAdmin detects the registration of a Managed Service, it |
| checks its persistent storage for a configuration object whose |
| <code>service.pid</code> property matches the PID service property ( |
| <code>service.pid</code>) of the Managed Service. If found, it calls |
| <a href="../../../../org/osgi/service/cm/ManagedService.html#updated(java.util.Dictionary)"><code>ManagedService.updated(java.util.Dictionary)</code></a> method with the new properties. The |
| implementation of a Configuration Admin service must run these call-backs |
| asynchronously to allow proper synchronization. |
| |
| <p> |
| When the Configuration Admin service detects a Managed Service Factory |
| registration, it checks its storage for configuration objects whose |
| <code>service.factoryPid</code> property matches the PID service property of |
| the Managed Service Factory. For each such <code>Configuration</code> |
| objects, it calls the <code>ManagedServiceFactory.updated</code> method |
| asynchronously with the new properties. The calls to the <code>updated</code> |
| method of a <code>ManagedServiceFactory</code> must be executed sequentially |
| and not overlap in time. |
| |
| <p> |
| In general, bundles having permission to use the Configuration Admin service |
| can only access and modify their own configuration information. Accessing or |
| modifying the configuration of another bundle requires |
| <code>ConfigurationPermission[*,CONFIGURE]</code>. |
| |
| <p> |
| <code>Configuration</code> objects can be <i>bound </i> to a specified bundle |
| location. In this case, if a matching Managed Service or Managed Service |
| Factory is registered by a bundle with a different location, then the |
| Configuration Admin service must not do the normal callback, and it should |
| log an error. In the case where a <code>Configuration</code> object is not |
| bound, its location field is <code>null</code>, the Configuration Admin |
| service will bind it to the location of the bundle that registers the first |
| Managed Service or Managed Service Factory that has a corresponding PID |
| property. When a <code>Configuration</code> object is bound to a bundle |
| location in this manner, the Configuration Admin service must detect if the |
| bundle corresponding to the location is uninstalled. If this occurs, the |
| <code>Configuration</code> object is unbound, that is its location field is |
| set back to <code>null</code>. |
| |
| <p> |
| The method descriptions of this class refer to a concept of "the calling |
| bundle". This is a loose way of referring to the bundle which obtained the |
| Configuration Admin service from the service registry. Implementations of |
| <code>ConfigurationAdmin</code> must use a |
| <code>ServiceFactory</code> to support this concept.</div> |
| <dl><dt><span class="strong">Version:</span></dt> |
| <dd>$Revision: 809193 $</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/osgi/service/cm/ConfigurationAdmin.html#SERVICE_BUNDLELOCATION">SERVICE_BUNDLELOCATION</a></strong></code> |
| <div class="block">Configuration property naming the location of the bundle that is |
| associated with a a <code>Configuration</code> object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/osgi/service/cm/ConfigurationAdmin.html#SERVICE_FACTORYPID">SERVICE_FACTORYPID</a></strong></code> |
| <div class="block">Configuration property naming the Factory PID in the configuration |
| dictionary.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/osgi/service/cm/Configuration.html" title="interface in org.osgi.service.cm">Configuration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/osgi/service/cm/ConfigurationAdmin.html#createFactoryConfiguration(java.lang.String)">createFactoryConfiguration</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> factoryPid)</code> |
| <div class="block">Create a new factory <code>Configuration</code> object with a new PID.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/osgi/service/cm/Configuration.html" title="interface in org.osgi.service.cm">Configuration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/osgi/service/cm/ConfigurationAdmin.html#createFactoryConfiguration(java.lang.String, java.lang.String)">createFactoryConfiguration</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> factoryPid, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> location)</code> |
| <div class="block">Create a new factory <code>Configuration</code> object with a new PID.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/osgi/service/cm/Configuration.html" title="interface in org.osgi.service.cm">Configuration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/osgi/service/cm/ConfigurationAdmin.html#getConfiguration(java.lang.String)">getConfiguration</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pid)</code> |
| <div class="block">Get an existing or new <code>Configuration</code> object from the |
| persistent store.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/osgi/service/cm/Configuration.html" title="interface in org.osgi.service.cm">Configuration</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/osgi/service/cm/ConfigurationAdmin.html#getConfiguration(java.lang.String, java.lang.String)">getConfiguration</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pid, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> location)</code> |
| <div class="block">Get an existing <code>Configuration</code> object from the persistent |
| store, or create a new <code>Configuration</code> object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/osgi/service/cm/Configuration.html" title="interface in org.osgi.service.cm">Configuration</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/osgi/service/cm/ConfigurationAdmin.html#listConfigurations(java.lang.String)">listConfigurations</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filter)</code> |
| <div class="block">List the current <code>Configuration</code> objects which match the |
| filter.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="SERVICE_FACTORYPID"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SERVICE_FACTORYPID</h4> |
| <pre>static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SERVICE_FACTORYPID</pre> |
| <div class="block">Configuration property naming the Factory PID in the configuration |
| dictionary. The property's value is of type <code>String</code>.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.osgi.service.cm.ConfigurationAdmin.SERVICE_FACTORYPID">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="SERVICE_BUNDLELOCATION"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SERVICE_BUNDLELOCATION</h4> |
| <pre>static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SERVICE_BUNDLELOCATION</pre> |
| <div class="block">Configuration property naming the location of the bundle that is |
| associated with a a <code>Configuration</code> object. This property can |
| be searched for but must not appear in the configuration dictionary for |
| security reason. The property's value is of type <code>String</code>.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.osgi.service.cm.ConfigurationAdmin.SERVICE_BUNDLELOCATION">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="createFactoryConfiguration(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createFactoryConfiguration</h4> |
| <pre><a href="../../../../org/osgi/service/cm/Configuration.html" title="interface in org.osgi.service.cm">Configuration</a> createFactoryConfiguration(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> factoryPid) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Create a new factory <code>Configuration</code> object with a new PID. |
| |
| The properties of the new <code>Configuration</code> object are |
| <code>null</code> until the first time that its |
| <a href="../../../../org/osgi/service/cm/Configuration.html#update(java.util.Dictionary)"><code>Configuration.update(Dictionary)</code></a> method is called. |
| |
| <p> |
| It is not required that the <code>factoryPid</code> maps to a |
| registered Managed Service Factory. |
| <p> |
| The <code>Configuration</code> object is bound to the location of the |
| calling bundle.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>factoryPid</code> - PID of factory (not <code>null</code>).</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>A new <code>Configuration</code> object.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if access to persistent storage fails.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - if caller does not have <code>ConfigurationPermission[*,CONFIGURE]</code> and <code>factoryPid</code> is bound to another bundle.</dd></dl> |
| </li> |
| </ul> |
| <a name="createFactoryConfiguration(java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createFactoryConfiguration</h4> |
| <pre><a href="../../../../org/osgi/service/cm/Configuration.html" title="interface in org.osgi.service.cm">Configuration</a> createFactoryConfiguration(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> factoryPid, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> location) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Create a new factory <code>Configuration</code> object with a new PID. |
| |
| The properties of the new <code>Configuration</code> object are |
| <code>null</code> until the first time that its |
| <a href="../../../../org/osgi/service/cm/Configuration.html#update(java.util.Dictionary)"><code>Configuration.update(Dictionary)</code></a> method is called. |
| |
| <p> |
| It is not required that the <code>factoryPid</code> maps to a |
| registered Managed Service Factory. |
| |
| <p> |
| The <code>Configuration</code> is bound to the location specified. If |
| this location is <code>null</code> it will be bound to the location of |
| the first bundle that registers a Managed Service Factory with a |
| corresponding PID.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>factoryPid</code> - PID of factory (not <code>null</code>).</dd><dd><code>location</code> - A bundle location string, or <code>null</code>.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a new <code>Configuration</code> object.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if access to persistent storage fails.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - if caller does not have <code>ConfigurationPermission[*,CONFIGURE]</code>.</dd></dl> |
| </li> |
| </ul> |
| <a name="getConfiguration(java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfiguration</h4> |
| <pre><a href="../../../../org/osgi/service/cm/Configuration.html" title="interface in org.osgi.service.cm">Configuration</a> getConfiguration(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pid, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> location) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Get an existing <code>Configuration</code> object from the persistent |
| store, or create a new <code>Configuration</code> object. |
| |
| <p> |
| If a <code>Configuration</code> with this PID already exists in |
| Configuration Admin service return it. The location parameter is ignored |
| in this case. |
| |
| <p> |
| Else, return a new <code>Configuration</code> object. This new object |
| is bound to the location and the properties are set to <code>null</code>. |
| If the location parameter is <code>null</code>, it will be set when a |
| Managed Service with the corresponding PID is registered for the first |
| time.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pid</code> - Persistent identifier.</dd><dd><code>location</code> - The bundle location string, or <code>null</code>.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>An existing or new <code>Configuration</code> object.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if access to persistent storage fails.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - if the caller does not have <code>ConfigurationPermission[*,CONFIGURE]</code>.</dd></dl> |
| </li> |
| </ul> |
| <a name="getConfiguration(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfiguration</h4> |
| <pre><a href="../../../../org/osgi/service/cm/Configuration.html" title="interface in org.osgi.service.cm">Configuration</a> getConfiguration(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pid) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Get an existing or new <code>Configuration</code> object from the |
| persistent store. |
| |
| If the <code>Configuration</code> object for this PID does not exist, |
| create a new <code>Configuration</code> object for that PID, where |
| properties are <code>null</code>. Bind its location to the calling |
| bundle's location. |
| |
| <p> |
| Otherwise, if the location of the existing <code>Configuration</code> object |
| is <code>null</code>, set it to the calling bundle's location.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pid</code> - persistent identifier.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>an existing or new <code>Configuration</code> matching the PID.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if access to persistent storage fails.</dd> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - if the <code>Configuration</code> object is bound to a location different from that of the calling bundle and it has no <code>ConfigurationPermission[*,CONFIGURE]</code>.</dd></dl> |
| </li> |
| </ul> |
| <a name="listConfigurations(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>listConfigurations</h4> |
| <pre><a href="../../../../org/osgi/service/cm/Configuration.html" title="interface in org.osgi.service.cm">Configuration</a>[] listConfigurations(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filter) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, |
| org.osgi.framework.InvalidSyntaxException</pre> |
| <div class="block">List the current <code>Configuration</code> objects which match the |
| filter. |
| |
| <p> |
| Only <code>Configuration</code> objects with non- <code>null</code> |
| properties are considered current. That is, |
| <code>Configuration.getProperties()</code> is guaranteed not to return |
| <code>null</code> for each of the returned <code>Configuration</code> |
| objects. |
| |
| <p> |
| Normally only <code>Configuration</code> objects that are bound to the |
| location of the calling bundle are returned, or all if the caller has |
| <code>ConfigurationPermission[*,CONFIGURE]</code>. |
| |
| <p> |
| The syntax of the filter string is as defined in the |
| <code>Filter</code> class. The filter can test any |
| configuration properties including the following: |
| <ul> |
| <li><code>service.pid</code>-<code>String</code>- the PID under which |
| this is registered</li> |
| <li><code>service.factoryPid</code>-<code>String</code>- the factory if |
| applicable</li> |
| <li><code>service.bundleLocation</code>-<code>String</code>- the bundle |
| location</li> |
| </ul> |
| The filter can also be <code>null</code>, meaning that all |
| <code>Configuration</code> objects should be returned.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - A filter string, or <code>null</code> to retrieve all |
| <code>Configuration</code> objects.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>All matching <code>Configuration</code> objects, or |
| <code>null</code> if there aren't any.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if access to persistent storage fails</dd> |
| <dd><code>org.osgi.framework.InvalidSyntaxException</code> - if the filter string is invalid</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ConfigurationAdmin.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/osgi/service/cm/Configuration.html" title="interface in org.osgi.service.cm"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/osgi/service/cm/ConfigurationEvent.html" title="class in org.osgi.service.cm"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/osgi/service/cm/ConfigurationAdmin.html" target="_top">Frames</a></li> |
| <li><a href="ConfigurationAdmin.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><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </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 ======= --> |
| <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> |
