FELIX-3090 Ensure target properties are properly considered when satisfying the ComponentFactory service
git-svn-id: https://svn.apache.org/repos/asf/felix/trunk@1245441 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/scr/src/main/java/org/apache/felix/scr/impl/manager/ComponentFactoryImpl.java b/scr/src/main/java/org/apache/felix/scr/impl/manager/ComponentFactoryImpl.java
index c9b17bc..803d9a2 100644
--- a/scr/src/main/java/org/apache/felix/scr/impl/manager/ComponentFactoryImpl.java
+++ b/scr/src/main/java/org/apache/felix/scr/impl/manager/ComponentFactoryImpl.java
@@ -22,12 +22,15 @@
import java.util.HashMap;
import java.util.Hashtable;
import java.util.IdentityHashMap;
+import java.util.Iterator;
+import java.util.List;
import java.util.Map;
import org.apache.felix.scr.Component;
import org.apache.felix.scr.impl.BundleComponentActivator;
import org.apache.felix.scr.impl.config.ComponentHolder;
import org.apache.felix.scr.impl.metadata.ComponentMetadata;
+import org.apache.felix.scr.impl.metadata.ReferenceMetadata;
import org.osgi.framework.Constants;
import org.osgi.framework.ServiceRegistration;
import org.osgi.service.component.ComponentConstants;
@@ -169,7 +172,7 @@
{
log( LogService.LOG_DEBUG, "registering component factory", null );
- Dictionary serviceProperties = getProperties();
+ Dictionary serviceProperties = getServiceProperties();
return getActivator().getBundleContext().registerService( new String[]
{ ComponentFactory.class.getName() }, getService(), serviceProperties );
}
@@ -190,6 +193,25 @@
public Dictionary getProperties()
{
+ Dictionary props = getServiceProperties();
+
+ // add target properties of references
+ List depMetaData = getComponentMetadata().getDependencies();
+ for ( Iterator di = depMetaData.iterator(); di.hasNext(); )
+ {
+ ReferenceMetadata rm = ( ReferenceMetadata ) di.next();
+ if ( rm.getTarget() != null )
+ {
+ props.put( rm.getTargetPropertyName(), rm.getTarget() );
+ }
+ }
+
+ return props;
+ }
+
+
+ public Dictionary getServiceProperties()
+ {
Dictionary props = new Hashtable();
// 112.5.5 The Component Factory service must register with the following properties
@@ -404,6 +426,7 @@
//---------- internal
+
/**
* Creates an {@link ImmediateComponentManager} instance with the
* {@link BundleComponentActivator} and {@link ComponentMetadata} of this
diff --git a/scr/src/test/java/org/apache/felix/scr/integration/ComponentFactoryTest.java b/scr/src/test/java/org/apache/felix/scr/integration/ComponentFactoryTest.java
index dc93819..32ded66 100644
--- a/scr/src/test/java/org/apache/felix/scr/integration/ComponentFactoryTest.java
+++ b/scr/src/test/java/org/apache/felix/scr/integration/ComponentFactoryTest.java
@@ -28,6 +28,7 @@
import org.apache.felix.scr.Component;
import org.apache.felix.scr.integration.components.SimpleComponent;
+import org.apache.felix.scr.integration.components.SimpleServiceImpl;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.ops4j.pax.exam.junit.JUnit4TestRunner;
@@ -488,4 +489,192 @@
}
}
}
+
+
+ @Test
+ public void test_component_factory_reference() throws InvalidSyntaxException
+ {
+ final String componentname = "factory.component.reference";
+ final String componentfactory = "factory.component.factory.reference";
+
+ SimpleServiceImpl.create( bundleContext, "ignored" ).setFilterProperty( "ignored" );
+
+ final Component component = findComponentByName( componentname );
+
+ TestCase.assertNotNull( component );
+ TestCase.assertFalse( component.isDefaultEnabled() );
+
+ TestCase.assertEquals( Component.STATE_DISABLED, component.getState() );
+ TestCase.assertNull( SimpleComponent.INSTANCE );
+
+ component.enable();
+ delay();
+
+ // missing reference -> unsatisfied
+ TestCase.assertEquals( Component.STATE_UNSATISFIED, component.getState() );
+ TestCase.assertNull( SimpleComponent.INSTANCE );
+
+ // register a service : filterprop=match
+ SimpleServiceImpl match = SimpleServiceImpl.create( bundleContext, "required" ).setFilterProperty( "required" );
+ delay();
+
+ TestCase.assertEquals( Component.STATE_FACTORY, component.getState() );
+ TestCase.assertNull( SimpleComponent.INSTANCE );
+
+ final ServiceReference[] refs = bundleContext.getServiceReferences( ComponentFactory.class.getName(), "("
+ + ComponentConstants.COMPONENT_FACTORY + "=" + componentfactory + ")" );
+ TestCase.assertNotNull( refs );
+ TestCase.assertEquals( 1, refs.length );
+ final ComponentFactory factory = ( ComponentFactory ) bundleContext.getService( refs[0] );
+ TestCase.assertNotNull( factory );
+
+ // non-overwrite filterprop
+ Hashtable<String, String> props = new Hashtable<String, String>();
+ props.put( PROP_NAME_FACTORY, PROP_NAME_FACTORY );
+ final ComponentInstance instance = factory.newInstance( props );
+ TestCase.assertNotNull( instance );
+
+ TestCase.assertNotNull( instance.getInstance() );
+ TestCase.assertEquals( SimpleComponent.INSTANCE, instance.getInstance() );
+ TestCase.assertEquals( PROP_NAME_FACTORY, SimpleComponent.INSTANCE.getProperty( PROP_NAME_FACTORY ) );
+ TestCase.assertEquals( 1, SimpleComponent.INSTANCE.m_multiRef.size() );
+ TestCase.assertTrue( SimpleComponent.INSTANCE.m_multiRef.contains( match ) );
+
+ final Map<?, ?> instanceMap = ( Map<?, ?> ) getFieldValue( component, "m_componentInstances" );
+ TestCase.assertNotNull( instanceMap );
+ TestCase.assertEquals( 1, instanceMap.size() );
+
+ final Object instanceManager = getFieldValue( instance, "m_componentManager" );
+ TestCase.assertTrue( instanceMap.containsValue( instanceManager ) );
+
+ // check registered components
+ final Component[] allFactoryComponents = findComponentsByName( componentname );
+ TestCase.assertNotNull( allFactoryComponents );
+ TestCase.assertEquals( 2, allFactoryComponents.length );
+ for ( int i = 0; i < allFactoryComponents.length; i++ )
+ {
+ final Component c = allFactoryComponents[i];
+ if ( c.getId() == component.getId() )
+ {
+ TestCase.assertEquals( Component.STATE_FACTORY, c.getState() );
+ }
+ else if ( c.getId() == SimpleComponent.INSTANCE.m_id )
+ {
+ TestCase.assertEquals( Component.STATE_ACTIVE, c.getState() );
+ }
+ else
+ {
+ TestCase.fail( "Unexpected Component " + c );
+ }
+ }
+
+ instance.dispose();
+ TestCase.assertNull( SimpleComponent.INSTANCE );
+ TestCase.assertNull( instance.getInstance() ); // SCR 112.12.6.2
+
+ TestCase.assertEquals( 0, instanceMap.size() );
+ TestCase.assertFalse( instanceMap.containsValue( instanceManager ) );
+
+ // overwritten filterprop
+ Hashtable<String, String> propsNonMatch = new Hashtable<String, String>();
+ propsNonMatch.put( PROP_NAME_FACTORY, PROP_NAME_FACTORY );
+ propsNonMatch.put( "ref.target", "(filterprop=nomatch)" );
+ try
+ {
+ factory.newInstance( propsNonMatch );
+ TestCase.fail( "Missing reference must fail instance creation" );
+ }
+ catch ( ComponentException ce )
+ {
+ // expected
+ }
+
+ final SimpleServiceImpl noMatch = SimpleServiceImpl.create( bundleContext, "nomatch" ).setFilterProperty(
+ "nomatch" );
+ delay();
+
+ final ComponentInstance instanceNonMatch = factory.newInstance( propsNonMatch );
+
+ TestCase.assertNotNull( instanceNonMatch );
+
+ TestCase.assertNotNull( instanceNonMatch.getInstance() );
+ TestCase.assertEquals( SimpleComponent.INSTANCE, instanceNonMatch.getInstance() );
+ TestCase.assertEquals( PROP_NAME_FACTORY, SimpleComponent.INSTANCE.getProperty( PROP_NAME_FACTORY ) );
+
+ TestCase.assertEquals( 1, SimpleComponent.INSTANCE.m_multiRef.size() );
+ TestCase.assertTrue( SimpleComponent.INSTANCE.m_multiRef.contains( noMatch ) );
+
+ // check registered components
+ final Component[] allFactoryComponents2 = findComponentsByName( componentname );
+ TestCase.assertNotNull( allFactoryComponents2 );
+ TestCase.assertEquals( 2, allFactoryComponents2.length );
+ for ( int i = 0; i < allFactoryComponents2.length; i++ )
+ {
+ final Component c = allFactoryComponents2[i];
+ if ( c.getId() == component.getId() )
+ {
+ TestCase.assertEquals( Component.STATE_FACTORY, c.getState() );
+ }
+ else if ( c.getId() == SimpleComponent.INSTANCE.m_id )
+ {
+ TestCase.assertEquals( Component.STATE_ACTIVE, c.getState() );
+ }
+ else
+ {
+ TestCase.fail( "Unexpected Component " + c );
+ }
+ }
+
+ match.getRegistration().unregister();
+ delay();
+
+ // check registered components (ComponentFactory aint no longer)
+ final Component[] allFactoryComponents3 = findComponentsByName( componentname );
+ TestCase.assertNotNull( allFactoryComponents3 );
+ TestCase.assertEquals( 2, allFactoryComponents3.length );
+ for ( int i = 0; i < allFactoryComponents3.length; i++ )
+ {
+ final Component c = allFactoryComponents3[i];
+ if ( c.getId() == component.getId() )
+ {
+ TestCase.assertEquals( Component.STATE_UNSATISFIED, c.getState() );
+ }
+ else if ( c.getId() == SimpleComponent.INSTANCE.m_id )
+ {
+ TestCase.assertEquals( Component.STATE_ACTIVE, c.getState() );
+ }
+ else
+ {
+ TestCase.fail( "Unexpected Component " + c );
+ }
+ }
+
+ noMatch.getRegistration().unregister();
+ delay();
+
+ // check registered components (ComponentFactory aint no longer)
+ final Component[] allFactoryComponents4 = findComponentsByName( componentname );
+ TestCase.assertNotNull( allFactoryComponents4 );
+ TestCase.assertEquals( 1, allFactoryComponents4.length );
+ for ( int i = 0; i < allFactoryComponents4.length; i++ )
+ {
+ final Component c = allFactoryComponents4[i];
+ if ( c.getId() == component.getId() )
+ {
+ TestCase.assertEquals( Component.STATE_UNSATISFIED, c.getState() );
+ }
+ else
+ {
+ TestCase.fail( "Unexpected Component " + c );
+ }
+ }
+
+ // deactivated due to unsatisfied reference
+ TestCase.assertNull( instanceNonMatch.getInstance() );
+ TestCase.assertNull( SimpleComponent.INSTANCE );
+
+ instanceNonMatch.dispose();
+ TestCase.assertNull( SimpleComponent.INSTANCE );
+ TestCase.assertNull( instanceNonMatch.getInstance() ); // SCR 112.12.6.2
+ }
}
diff --git a/scr/src/test/java/org/apache/felix/scr/integration/components/SimpleServiceImpl.java b/scr/src/test/java/org/apache/felix/scr/integration/components/SimpleServiceImpl.java
index 39a9903..f90d44a 100644
--- a/scr/src/test/java/org/apache/felix/scr/integration/components/SimpleServiceImpl.java
+++ b/scr/src/test/java/org/apache/felix/scr/integration/components/SimpleServiceImpl.java
@@ -74,27 +74,29 @@
}
- public void update( String value )
+ public SimpleService update( String value )
{
if ( this.m_registration != null )
{
this.m_value = value;
this.m_registration.setProperties( getProperties() );
}
+ return this;
}
- public void setFilterProperty( String filterProp )
+ public SimpleServiceImpl setFilterProperty( String filterProp )
{
if ( this.m_registration != null )
{
this.m_filterProp = filterProp;
this.m_registration.setProperties( getProperties() );
}
+ return this;
}
- public void drop()
+ public SimpleServiceImpl drop()
{
ServiceRegistration sr = getRegistration();
if ( sr != null )
@@ -102,6 +104,7 @@
setRegistration( null );
sr.unregister();
}
+ return this;
}
@@ -111,9 +114,10 @@
}
- public void setRegistration( ServiceRegistration registration )
+ public SimpleServiceImpl setRegistration( ServiceRegistration registration )
{
m_registration = registration;
+ return this;
}
diff --git a/scr/src/test/resources/integration_test_simple_components.xml b/scr/src/test/resources/integration_test_simple_components.xml
index 5bbfee8..d1410cb 100644
--- a/scr/src/test/resources/integration_test_simple_components.xml
+++ b/scr/src/test/resources/integration_test_simple_components.xml
@@ -104,5 +104,22 @@
factory="factory.component.factory.configuration" >
<implementation class="org.apache.felix.scr.integration.components.SimpleComponent" />
</scr:component>
+
+ <!-- Component Factory Instances, requiring configuration -->
+ <scr:component name="factory.component.reference"
+ enabled="false"
+ configuration-policy="ignore"
+ factory="factory.component.factory.reference" >
+ <implementation class="org.apache.felix.scr.integration.components.SimpleComponent" />
+ <reference
+ name="ref"
+ interface="org.apache.felix.scr.integration.components.SimpleService"
+ cardinality="1..n"
+ policy="static"
+ bind="bindSimpleService"
+ unbind="unbindSimpleService"
+ target="(filterprop=required)"
+ />
+ </scr:component>
</components>