[RFC227] Update javadoc for configuration admin
@@ -241,17 +241,13 @@ public interface ConfigurationAdmin {
/**
* Get an existing or new {@code Configuration} object from the persistent
- * store.
- *
- * The PID for this {@code Configuration} object is generated from the
- * provided factory PID and the alias by starting with the factory PID
- * appending the character # and then appending the alias.
- *
+ * store. The PID for this {@code Configuration} object is generated from
+ * the provided factory PID and the name by starting with the factory PID
+ * appending the character ~ (tilde) and then appending the name.
* <p>
* If a {@code Configuration} with this PID already exists in Configuration
* Admin service return it. The location parameter is ignored in this case
* though it is still used for a security check.
- *
* <p>
* Else, return a new {@code Configuration} object. This new object is bound
* to the location and the properties are set to {@code null}. If the
@@ -261,7 +257,7 @@ public interface ConfigurationAdmin {
* targets that are registered with the corresponding PID.
*
* @param factoryPid PID of factory (not {@code null}).
- * @param alias An alias for {@code Configuration} (not {@code null}).
+ * @param name A name for {@code Configuration} (not {@code null}).
* @param location The bundle location string, or {@code null}.
* @return An existing or new {@code Configuration} object.
* @throws IOException if access to persistent storage fails.
@@ -276,26 +272,23 @@ public interface ConfigurationAdmin {
* {@code null}
* @since 1.6
*/
- public Configuration getFactoryConfiguration(String factoryPid, String alias, String location) throws IOException;
+ public Configuration getFactoryConfiguration(String factoryPid, String name,
+ String location) throws IOException;
/**
* Get an existing or new {@code Configuration} object from the persistent
- * store.
- *
- * The PID for this {@code Configuration} object is generated from the
- * provided factory PID and the alias by starting with the factory PID
- * appending the character # and then appending the alias.
- *
- * If the {@code Configuration} object for this PID does not exist, create a
- * new {@code Configuration} object for that PID, where properties are
+ * store. The PID for this {@code Configuration} object is generated from
+ * the provided factory PID and the name by starting with the factory PID
+ * appending the character ~ (tilde) and then appending the name. If the
+ * {@code Configuration} object for this PID does not exist, create a new
+ * {@code Configuration} object for that PID, where properties are
* {@code null}. Bind its location to the calling bundle's location.
- *
* <p>
* Otherwise, if the location of the existing {@code Configuration} object
* is {@code null}, set it to the calling bundle's location.
*
* @param factoryPid PID of factory (not {@code null}).
- * @param alias An alias for {@code Configuration} (not {@code null}).
+ * @param name A name for {@code Configuration} (not {@code null}).
* @return an existing or new {@code Configuration} matching the PID.
* @throws IOException if access to persistent storage fails.
* @throws SecurityException when the required permission is not available
@@ -304,7 +297,8 @@ public interface ConfigurationAdmin {
* {@code null}
* @since 1.6
*/
- public Configuration getFactoryConfiguration(String factoryPid, String alias) throws IOException;
+ public Configuration getFactoryConfiguration(String factoryPid, String name)
+ throws IOException;
/**
* List the current {@code Configuration} objects which match the filter.
