Author: fmeschbe
Date: Tue May 31 07:53:31 2011
New Revision: 1129533
URL: http://svn.apache.org/viewvc?rev=1129533&view=rev
Log:
JavaDoc and Doc reference
Modified:
felix/trunk/scr/src/main/java/org/apache/felix/scr/impl/config/ScrConfiguration.java
felix/trunk/scr/src/main/java/org/apache/felix/scr/impl/config/ScrManagedService.java
felix/trunk/scr/src/main/java/org/apache/felix/scr/impl/config/ScrManagedServiceMetaTypeProvider.java
Modified:
felix/trunk/scr/src/main/java/org/apache/felix/scr/impl/config/ScrConfiguration.java
URL:
http://svn.apache.org/viewvc/felix/trunk/scr/src/main/java/org/apache/felix/scr/impl/config/ScrConfiguration.java?rev=1129533&r1=1129532&r2=1129533&view=diff
==============================================================================
---
felix/trunk/scr/src/main/java/org/apache/felix/scr/impl/config/ScrConfiguration.java
(original)
+++
felix/trunk/scr/src/main/java/org/apache/felix/scr/impl/config/ScrConfiguration.java
Tue May 31 07:53:31 2011
@@ -30,10 +30,25 @@ import org.osgi.service.log.LogService;
/**
* The <code>ScrConfiguration</code> class conveys configuration for the
- * Felix DS implementation bundle. The basic configuration is retrieved from
- * bundle context properties. In addition, this class registers a
ManagedService
- * service to receive configuration supplied from the Configuration Admin
- * service overlaying the static context properties.
+ * Felix DS implementation bundle.
+ * <p>
+ * <b>Configuration Source</b>
+ * <p>
+ * <ol>
+ * <li>Framework properties: These are read when the Declarative Services
+ * implementation is first started.</li>
+ * <li>Configuration Admin Service: Properties are provided by means of a
+ * <code>ManagedService</code> with Service PID
+ * <code>org.apache.felix.scr.ScrService</code>. This class uses an OSGi
+ * Service Factory ({@link ScrManagedServiceServiceFactory}) to register the
+ * managed service without requiring the Configuration Admin Service API to be
+ * required upfront.
+ * </li>
+ * </ol>
+ * <p>
+ * See the <i>Configuration</i> section of the
+ * <a
href="http://felix.apache.org/site/apache-felix-service-component-runtime.html";>Apache
Felix Service Component Runtime</a>
+ * documentation page for detailed information.
*/
public class ScrConfiguration
{
@@ -83,6 +98,7 @@ public class ScrConfiguration
props);
}
+ // Called from the ScrManagedService.updated method to reconfigure
void configure( Dictionary config )
{
if ( config == null )
@@ -97,6 +113,10 @@ public class ScrConfiguration
}
}
+ /**
+ * Returns the current log level.
+ * @return
+ */
public int getLogLevel()
{
return logLevel;
Modified:
felix/trunk/scr/src/main/java/org/apache/felix/scr/impl/config/ScrManagedService.java
URL:
http://svn.apache.org/viewvc/felix/trunk/scr/src/main/java/org/apache/felix/scr/impl/config/ScrManagedService.java?rev=1129533&r1=1129532&r2=1129533&view=diff
==============================================================================
---
felix/trunk/scr/src/main/java/org/apache/felix/scr/impl/config/ScrManagedService.java
(original)
+++
felix/trunk/scr/src/main/java/org/apache/felix/scr/impl/config/ScrManagedService.java
Tue May 31 07:53:31 2011
@@ -25,9 +25,15 @@ import org.osgi.service.cm.ManagedServic
/**
* The <code>ScrManagedService</code> receives configuration for the
Declarative
- * Services Runtime itself. This class is instantiated in a ServiceFactory
- * manner by the {@link ScrManagedServiceServiceFactory} when the Configuration
- * Admin service implementation and API is available.
+ * Services Runtime itself.
+ * <p>
+ * This class is instantiated in a ServiceFactory manner by the
+ * {@link ScrManagedServiceServiceFactory} when the Configuration Admin service
+ * implementation and API is available.
+ * <p>
+ * Requires OSGi Configuration Admin Service API available
+ *
+ * @see ScrManagedServiceServiceFactory
*/
public class ScrManagedService implements ManagedService
{
Modified:
felix/trunk/scr/src/main/java/org/apache/felix/scr/impl/config/ScrManagedServiceMetaTypeProvider.java
URL:
http://svn.apache.org/viewvc/felix/trunk/scr/src/main/java/org/apache/felix/scr/impl/config/ScrManagedServiceMetaTypeProvider.java?rev=1129533&r1=1129532&r2=1129533&view=diff
==============================================================================
---
felix/trunk/scr/src/main/java/org/apache/felix/scr/impl/config/ScrManagedServiceMetaTypeProvider.java
(original)
+++
felix/trunk/scr/src/main/java/org/apache/felix/scr/impl/config/ScrManagedServiceMetaTypeProvider.java
Tue May 31 07:53:31 2011
@@ -30,6 +30,15 @@ import org.osgi.service.metatype.ObjectC
* The <code>ScrManagedServiceMetaTypeProvider</code> receives the Declarative
* Services Runtime configuration (by extending the {@link ScrManagedService}
* class but also provides a MetaType Service ObjectClassDefinition.
+ * <p>
+ * This class is instantiated in a ServiceFactory manner by the
+ * {@link ScrManagedServiceServiceFactory} when the Configuration Admin service
+ * implementation and API is available and if the Metatype Service API is also
+ * available.
+ * <p>
+ * Requires OSGi Metatype Service API available
+ *
+ * @see ScrManagedServiceServiceFactory
*/
class ScrManagedServiceMetaTypeProvider extends ScrManagedService
implements MetaTypeProvider
