You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by pd...@apache.org on 2010/07/03 23:38:58 UTC
svn commit: r960272 - in /felix/trunk/dependencymanager:
annotation/src/main/java/org/apache/felix/dm/annotation/api/
annotation/src/main/java/org/apache/felix/dm/annotation/plugin/bnd/
runtime/src/main/java/org/apache/felix/dm/runtime/
Author: pderop
Date: Sat Jul 3 21:38:57 2010
New Revision: 960272
URL: http://svn.apache.org/viewvc?rev=960272&view=rev
Log:
added a "changed" attribute in the ResourceAdapterService annotation. Fixed some javadocs
Modified:
felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/AdapterService.java
felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/AspectService.java
felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/ResourceAdapterService.java
felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/Service.java
felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/ServiceDependency.java
felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/plugin/bnd/AnnotationCollector.java
felix/trunk/dependencymanager/runtime/src/main/java/org/apache/felix/dm/runtime/ResourceAdapterServiceBuilder.java
Modified: felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/AdapterService.java
URL: http://svn.apache.org/viewvc/felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/AdapterService.java?rev=960272&r1=960271&r2=960272&view=diff
==============================================================================
--- felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/AdapterService.java (original)
+++ felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/AdapterService.java Sat Jul 3 21:38:57 2010
@@ -26,42 +26,39 @@ import java.lang.annotation.Target;
/**
* Annotates an Adapater Service. The adapter will be applied to any service that
- * matches the implemented interface and filter. For each matching service
- * 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 service 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.
+ * matches the implemented interface and filter. The adapter will be registered
+ * with the specified interface and existing properties from the original service
+ * 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.
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface AdapterService
{
/**
- * Returns the adapter service interface(s). By default, the directly implemented interface(s) is (are) used.
- * @return The service interface(s) provided by this adapter.
+ * Sets the adapter service interface(s). By default, the directly implemented interface(s) is (are) used.
*/
Class<?>[] adapterService() default {};
/**
- * The adapter service properites. They will be added to the adapted service properties.
- * @return additional properties to use with the adapter service registration
+ * Sets some additional properties to use with the adapter service registration. By default,
+ * the adapter will inherit all adaptee service properties.
*/
Property[] adapterProperties() default {};
/**
- * The adapted service interface
+ * Sets the adaptee service interface this adapter is applying to.
*/
Class<?> adapteeService();
/**
- * the filter condition to use with the adapted service interface.
- * @return the filter condition to use with the adapted ervice interface
+ * Sets the filter condition to use with the adapted service interface.
*/
String adapteeFilter() default "";
/**
- * Sets the static method used to create the AdapterService implementation instance.
+ * Sets the static method used to create the adapter service implementation instance.
+ * By default, the default constructor of the annotated class is used.
*/
String factoryMethod() default "";
}
Modified: felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/AspectService.java
URL: http://svn.apache.org/viewvc/felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/AspectService.java?rev=960272&r1=960271&r2=960272&view=diff
==============================================================================
--- felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/AspectService.java (original)
+++ felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/AspectService.java Sat Jul 3 21:38:57 2010
@@ -25,52 +25,47 @@ import java.lang.annotation.Target;
/**
* Annotates an Aspect Service. The aspect will be applied to any service that
- * matches the specified interface and filter. For each matching service
- * an aspect will be created based on the aspect implementation class.
- * The aspect will be registered with the same interface and properties
- * as the original service, 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.
+ * matches the specified interface and filter. The aspect will be registered
+ * with the same interface and properties as the original service, plus any
+ * extra properties you supply here. It will also inherit all dependencies,
+ * and if you can declare the original service as a member it will be injected.
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface AspectService
{
/**
- * Returns the service interface to apply the aspect to. By default, the directly implemented interface is used.
- * @return The service interface to apply the aspect to.
+ * Sets the service interface to apply the aspect to. By default, the directly implemented interface is used.
*/
Class<?> service() default Object.class;
/**
- * the filter condition to use with the service interface this aspect is applying to.
- * @return the filter condition to use with the service interface
+ * Sets the filter condition to use with the service interface this aspect is applying to.
*/
String filter() default "";
/**
- * Additional properties to use with the aspect service registration
- * @return additional properties to use with the aspect service registration
+ * Sets Additional properties to use with the aspect service registration
*/
Property[] properties() default {};
/**
- * Ranking of this aspect. Since aspects are chained, the ranking defines the order in which they are chained.
+ * Sets the ranking of this aspect. Since aspects are chained, the ranking defines the order in which they are chained.
* Chain ranking is implemented as a service ranking so service lookups automatically retrieve the top of the
* chain.
- *
- * @return the ranking of this aspect
*/
int ranking();
/**
- * Specifies the field name where to inject the original service. By default, the original service is injected
+ * Sets the field name where to inject the original service. By default, the original service is injected
* in any attributes in the aspect implementation that are of the same type as the aspect interface.
*/
String field() default "";
/**
- * Sets the static method used to create the AspectService implementation instance.
+ * Sets the static method used to create the AspectService implementation instance. By default, the
+ * default constructor of the annotated class is used. The factoryMethod can be used to provide a specific
+ * aspect implements, like a DynamicProxy.
*/
String factoryMethod() default "";
}
Modified: felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/ResourceAdapterService.java
URL: http://svn.apache.org/viewvc/felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/ResourceAdapterService.java?rev=960272&r1=960271&r2=960272&view=diff
==============================================================================
--- felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/ResourceAdapterService.java (original)
+++ felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/ResourceAdapterService.java Sat Jul 3 21:38:57 2010
@@ -58,6 +58,11 @@ public @interface ResourceAdapterService
boolean propagate() default false;
/**
+ * The callback method to be invoked when the Resource has changed.
+ */
+ String changed() default "";
+
+ /**
* Sets the static method used to create the AdapterService implementation instance.
*/
String factoryMethod() default "";
Modified: felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/Service.java
URL: http://svn.apache.org/viewvc/felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/Service.java?rev=960272&r1=960271&r2=960272&view=diff
==============================================================================
--- felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/Service.java (original)
+++ felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/Service.java Sat Jul 3 21:38:57 2010
@@ -28,9 +28,9 @@ import java.lang.annotation.Target;
* By default, all directly implemented interfaces are registered into the OSGi registry,
* and the Service is instantiated automatically, when the Service' bundle is started and
* when the Service dependencies are available. If you need to take control of when and how
- * much Service instance must be created, then you can use the <code>factory</code>
+ * much Service instances must be created, then you can use the <code>factorySet</code>
* Service attribute.<p>
- * If a <code>factory</code> attribute is set, the Service is not started automatically
+ * If a <code>factorySet</code> attribute is set, the Service is not started automatically
* during bundle startup, and a <code>java.util.Set<Dictionary></code>
* object is registered into the OSGi registry on behalf of the Service. This Set will act
* as a Factory API, and another component may use this Set and add some configuration
@@ -58,11 +58,12 @@ import java.lang.annotation.Target;
* @Start
* void start() {
* // Our Service is starting and is about to be registered in the OSGi registry as a Z service.
- * }
+ * }
*
- * public void doService() {
+ * public void doService() {
* // ...
- * }
+ * }
+ * }
* </pre>
* </blockquote>
*
@@ -151,10 +152,11 @@ public @interface Service
* So, basically, another component may then be injected with this set in order to dynamically instantiate some Service instances:
* <ul>
* <li> Each time a new Dictionary is added into the Set, then a new instance of the annotated service will be instantiated.</li>
- * <li> Each time an existing Dictionary is updated from the Set, then the corresponding Service instance will be updated.</li>
+ * <li> Each time an existing Dictionary is re-added into the Set, then the corresponding Service instance will be updated.</li>
* <li> Each time an existing Dictionary is removed from the Set, then the corresponding Service instance will be destroyed.</li>
* </ul>
- * The dictionary registered in the Set will be provided to the created Service instance using a callback method that you can
+ *
+ * <p>The dictionary registered in the Set will be provided to the created Service instance using a callback method that you can
* optionally specify in the {@link Service#factoryConfigure()} attribute. Each public properties from that dictionary
* (which don't start with a dot) will be propagated along with the annotated Service properties.
*/
Modified: felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/ServiceDependency.java
URL: http://svn.apache.org/viewvc/felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/ServiceDependency.java?rev=960272&r1=960271&r2=960272&view=diff
==============================================================================
--- felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/ServiceDependency.java (original)
+++ felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/ServiceDependency.java Sat Jul 3 21:38:57 2010
@@ -32,7 +32,8 @@ import java.lang.annotation.Target;
public @interface ServiceDependency
{
/**
- * The type if the service this dependency is applying on. By default, the type is method parameter or the class field type.
+ * The type if the service this dependency is applying on. By default, the method parameter
+ * (or the class field) is used as the type.
*/
Class<?> service() default Object.class;
@@ -131,6 +132,12 @@ public @interface ServiceDependency
* m_config = config;
* }
*
+ * // This named dependency will be configured by our init method (see below).
+ * @ServiceDependency(name="dependency1")
+ * void bindOtherService(OtherService other) {
+ * // the filter and required flag will be configured from our init method.
+ * }
+
* // The returned Map will be used to configure our "dependency1" Dependency.
* @Init
* Map init() {
@@ -139,11 +146,6 @@ public @interface ServiceDependency
* put("dependency1.required", m_config.get("required"));
* }};
* }
- *
- * @ServiceDependency(name="dependency1")
- * void bindOtherService(OtherService other) {
- * // the filter and required flag will be configured from our init method.
- * }
* }
* </pre></blockquote>
*/
Modified: felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/plugin/bnd/AnnotationCollector.java
URL: http://svn.apache.org/viewvc/felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/plugin/bnd/AnnotationCollector.java?rev=960272&r1=960271&r2=960272&view=diff
==============================================================================
--- felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/plugin/bnd/AnnotationCollector.java (original)
+++ felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/plugin/bnd/AnnotationCollector.java Sat Jul 3 21:38:57 2010
@@ -574,6 +574,9 @@ public class AnnotationCollector extends
// Parse propagate attribute
writer.putString(annotation, EntryParam.propagate, Boolean.FALSE.toString());
+
+ // Parse changed attribute
+ writer.putString(annotation, EntryParam.changed, null);
}
/**
Modified: felix/trunk/dependencymanager/runtime/src/main/java/org/apache/felix/dm/runtime/ResourceAdapterServiceBuilder.java
URL: http://svn.apache.org/viewvc/felix/trunk/dependencymanager/runtime/src/main/java/org/apache/felix/dm/runtime/ResourceAdapterServiceBuilder.java?rev=960272&r1=960271&r2=960272&view=diff
==============================================================================
--- felix/trunk/dependencymanager/runtime/src/main/java/org/apache/felix/dm/runtime/ResourceAdapterServiceBuilder.java (original)
+++ felix/trunk/dependencymanager/runtime/src/main/java/org/apache/felix/dm/runtime/ResourceAdapterServiceBuilder.java Sat Jul 3 21:38:57 2010
@@ -44,7 +44,8 @@ public class ResourceAdapterServiceBuild
String[] service = srvMeta.getStrings(Params.service, null);
Dictionary<String, Object> properties = srvMeta.getDictionary(Params.properties, null);
boolean propagate = "true".equals(srvMeta.getString(Params.propagate, "false"));
- Service srv = dm.createResourceAdapterService(filter, propagate, null, "changed")
+ String changed = srvMeta.getString(Params.changed, null /* no change callback if not specified explicitly */);
+ Service srv = dm.createResourceAdapterService(filter, propagate, null, changed)
.setInterface(service, properties);
String factoryMethod = srvMeta.getString(Params.factoryMethod, null);
if (factoryMethod == null)