You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by gu...@apache.org on 2013/10/03 13:49:36 UTC
svn commit: r1528820 - in /felix/trunk/ipojo/runtime/core/src:
main/java/org/apache/felix/ipojo/IPojoFactory.java
test/java/org/apache/felix/ipojo/IPojoFactoryTestCase.java
Author: guillaume
Date: Thu Oct 3 11:49:36 2013
New Revision: 1528820
URL: http://svn.apache.org/r1528820
Log:
FELIX-4268 Duplicated name errors always happen when there are 2 factories with the same name
* Generating a name always produce a unique name
* When name is provided by the instance, only check uniqueness and try appending factory's version if any, then re-check
* Changes NameGenerator interface (no more used for provided name verification)
Added:
felix/trunk/ipojo/runtime/core/src/test/java/org/apache/felix/ipojo/IPojoFactoryTestCase.java
Modified:
felix/trunk/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/IPojoFactory.java
Modified: felix/trunk/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/IPojoFactory.java
URL: http://svn.apache.org/viewvc/felix/trunk/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/IPojoFactory.java?rev=1528820&r1=1528819&r2=1528820&view=diff
==============================================================================
--- felix/trunk/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/IPojoFactory.java (original)
+++ felix/trunk/ipojo/runtime/core/src/main/java/org/apache/felix/ipojo/IPojoFactory.java Thu Oct 3 11:49:36 2013
@@ -18,6 +18,8 @@
*/
package org.apache.felix.ipojo;
+import static java.lang.String.format;
+
import org.apache.felix.ipojo.architecture.ComponentTypeDescription;
import org.apache.felix.ipojo.architecture.PropertyDescription;
import org.apache.felix.ipojo.extender.internal.Extender;
@@ -33,6 +35,7 @@ import org.osgi.service.cm.ManagedServic
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.atomic.AtomicLong;
/**
* This class defines common mechanisms of iPOJO component factories
@@ -136,7 +139,7 @@ public abstract class IPojoFactory imple
/**
* Generates a unique instance name if not provided by the configuration.
*/
- private NameGenerator m_generator = new UniquenessNameGenerator(new SwitchNameGenerator());
+ private final NameGenerator m_generator = new RetryNameGenerator(new DefaultNameGenerator());
/**
* Creates an iPOJO Factory.
@@ -273,30 +276,36 @@ public abstract class IPojoFactory imple
}
// Find name in the configuration
- String name;
- if (configuration.get(Factory.INSTANCE_NAME_PROPERTY) == null && configuration.get("name") == null) {
- // No name provided
- name = null;
- } else {
- // Support both instance.name & name
- name = (String) configuration.get(Factory.INSTANCE_NAME_PROPERTY);
- if (name == null) {
- name = (String) configuration.get("name");
- getLogger().log(Logger.WARNING, "The 'name' (" + name + ") attribute, used as the instance name, is deprecated, please use the 'instance.name' attribute");
- }
- }
+ String name = findInstanceName(configuration);
+ // Execute name generation and verification in a synchronized block to ensure uniqueness
+ synchronized (INSTANCE_NAME) {
+ if (name != null) {
+ // Needs to ensure name uniqueness
+ if (INSTANCE_NAME.contains(name)) {
+ // name already in use, try to append factory's version
+ if (m_version != null) {
+ name = name + "-" + m_version;
+ if (INSTANCE_NAME.contains(name)) {
+ // It's still not unique
+ // We've done our best: throw an Exception
+ throw new UnacceptableConfiguration(format("%s : Instance name (suffixed with factory's version) \"%s\" is already used", getFactoryName(), name));
+ }
+ } else {
+ // No version provided: we cannot do more
+ throw new UnacceptableConfiguration(format("%s : Instance name (provided by the instance) \"%s\" is already used", getFactoryName(), name));
+ }
+ }
+ } else {
+ // Generated name is always unique, no verification required
+ name = m_generator.generate(this, INSTANCE_NAME);
+ }
- // Generate a unique name if required and verify uniqueness
- // We extract the version from the configuration because it may help to compute a unique name by appending
- // the version to the given name.
- String version = (String) configuration.get(Factory.FACTORY_VERSION_PROPERTY);
-
- // If the extracted version is null, we use the current factory version (as we were called)
- if (version == null) {
- version = m_version;
+ // Reserve name
+ INSTANCE_NAME.add(name);
}
- name = m_generator.generate(name, version);
+
+ // Update name in configuration
configuration.put(Factory.INSTANCE_NAME_PROPERTY, name);
// Here we are sure to be valid until the end of the method.
@@ -321,6 +330,22 @@ public abstract class IPojoFactory imple
}
+ private String findInstanceName(final Dictionary configuration) {
+ String name;
+ if (configuration.get(Factory.INSTANCE_NAME_PROPERTY) == null && configuration.get("name") == null) {
+ // No name provided
+ name = null;
+ } else {
+ // Support both instance.name & name
+ name = (String) configuration.get(Factory.INSTANCE_NAME_PROPERTY);
+ if (name == null) {
+ name = (String) configuration.get("name");
+ getLogger().log(Logger.WARNING, "The 'name' (" + name + ") attribute, used as the instance name, is deprecated, please use the 'instance.name' attribute");
+ }
+ }
+ return name;
+ }
+
/**
* Gets the bundle context of the factory.
* @return the bundle context of the factory.
@@ -1063,111 +1088,81 @@ public abstract class IPojoFactory imple
}
}
- /**
- * Generate a unique name for a component instance.
- */
- private interface NameGenerator {
-
- /**
- * @return a unique name.
- * @param name The user provided name (may be null)
- * @param version the factory version if set. Instances can specify the version of the factory they are bound
- * to. This parameter may be used to avoid name conflicts.
- */
- String generate(String name, String version) throws UnacceptableConfiguration;
- }
/**
* This generator implements the default naming strategy.
* The name is composed of the factory name suffixed with a unique number identifier (starting from 0).
*/
- private class DefaultNameGenerator implements NameGenerator {
- private long m_nextId = 0;
+ public static class DefaultNameGenerator implements NameGenerator {
- /**
- * This method has to be synchronized to ensure name uniqueness.
- * @param name The user provided name (may be null)
- * @param version ignored.
- */
- public synchronized String generate(String name, String version) throws UnacceptableConfiguration
- {
- // Note: This method is overridden by handlers to get the full name.
- return IPojoFactory.this.getFactoryName() + "-" + m_nextId++;
+ private AtomicLong m_nextId = new AtomicLong();
+
+ public String generate(Factory factory, List<String> reserved) throws UnacceptableConfiguration {
+ StringBuilder sb = new StringBuilder();
+ sb.append(factory.getName());
+ if (factory.getVersion() != null) {
+ sb.append("/");
+ sb.append(factory.getVersion());
+ }
+ sb.append("-");
+ sb.append(m_nextId.getAndIncrement());
+ return sb.toString();
}
}
/**
- * This generator implements the naming strategy when client provides the instance name value.
+ * This generator implements a retry naming strategy.
+ * It uses a delegate {@link org.apache.felix.ipojo.IPojoFactory.NameGenerator}, and call it in sequence until an unused value is found.
*/
- private static class UserProvidedNameGenerator implements NameGenerator {
+ public static class RetryNameGenerator implements NameGenerator {
+
+ private final NameGenerator m_delegate;
/**
- * @param name The user provided name (not null)
- * @param version ignored.
+ * Bound the loop to avoid Stack overflows
*/
- public String generate(String name, String version) throws UnacceptableConfiguration
- {
- return name;
- }
- }
-
- /**
- * This generator ensure that the returned name is globally unique.
- */
- private class UniquenessNameGenerator implements NameGenerator {
-
- private NameGenerator delegate;
+ private long maximum = 8096;
- private UniquenessNameGenerator(NameGenerator delegate)
- {
- this.delegate = delegate;
+ public RetryNameGenerator(final NameGenerator delegate) {
+ m_delegate = delegate;
}
- /**
- * This method has to be synchronized to ensure name uniqueness.
- * @param name The user provided name (may be null)
- */
- public String generate(String name, String version) throws UnacceptableConfiguration
- {
- // Produce the name
- String name2 = delegate.generate(name, version);
+ public void setMaximum(final long maximum) {
+ this.maximum = maximum;
+ }
- // Needs to be in a synchronized block because we want to ensure that the name is unique
- synchronized (INSTANCE_NAME) {
+ public String generate(final Factory factory, final List<String> reserved) throws UnacceptableConfiguration {
+ // Loop until we obtain a unique value (or counter overflow)
+ long counter = 0;
+ while (counter < maximum) {
+ String generated = m_delegate.generate(factory, reserved);
+ counter++;
// Verify uniqueness
- if (INSTANCE_NAME.contains(name2) && version != null) {
- // Named already used, try to append the version.
- name2 = name2 + "-" + version;
- if (INSTANCE_NAME.contains(name2)) {
- m_logger.log(Logger.ERROR, "The configuration is not acceptable : Name already used");
- throw new UnacceptableConfiguration(getFactoryName() + " : Name already used : " + name2);
- }
- } else if (INSTANCE_NAME.contains(name2)) {
- m_logger.log(Logger.ERROR, "The configuration is not acceptable : Name already used");
- throw new UnacceptableConfiguration(getFactoryName() + " : Name already used : " + name2);
+ if (!reserved.contains(generated)) {
+ return generated;
}
- // reserve the name
- INSTANCE_NAME.add(name2);
}
- return name2;
+
+ // Should never happen (except is NameGenerator composition is broken: like a delegate that
+ // never change its return value)
+ throw new UnacceptableConfiguration(format("Cannot generate unique instance name for factory %s/%s from bundle %d",
+ factory.getName(),
+ factory.getVersion(),
+ factory.getBundleContext().getBundle().getBundleId()));
}
}
/**
- * This generator choose the right NameGenerator.
+ * Generate a unique name for a component instance.
*/
- private class SwitchNameGenerator implements NameGenerator {
- private NameGenerator computed = new DefaultNameGenerator();
- private NameGenerator userProvided = new UserProvidedNameGenerator();
+ public static interface NameGenerator {
- public String generate(String name, String version) throws UnacceptableConfiguration
- {
- if (name == null) {
- return computed.generate(null, null);
- }
- return userProvided.generate(name, version);
- }
+ /**
+ * @return a unique name.
+ * @param factory Factory called to create the instance
+ * @param reserved List of reserved (already used) instance names.
+ * This has to be used tp ensure generated name is unique among all other instances.
+ */
+ String generate(Factory factory, List<String> reserved) throws UnacceptableConfiguration;
}
-
-
}
Added: felix/trunk/ipojo/runtime/core/src/test/java/org/apache/felix/ipojo/IPojoFactoryTestCase.java
URL: http://svn.apache.org/viewvc/felix/trunk/ipojo/runtime/core/src/test/java/org/apache/felix/ipojo/IPojoFactoryTestCase.java?rev=1528820&view=auto
==============================================================================
--- felix/trunk/ipojo/runtime/core/src/test/java/org/apache/felix/ipojo/IPojoFactoryTestCase.java (added)
+++ felix/trunk/ipojo/runtime/core/src/test/java/org/apache/felix/ipojo/IPojoFactoryTestCase.java Thu Oct 3 11:49:36 2013
@@ -0,0 +1,118 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.felix.ipojo;
+
+import static org.mockito.Matchers.anyList;
+import static org.mockito.Matchers.eq;
+import static org.mockito.Mockito.when;
+
+import java.util.Arrays;
+import java.util.Collections;
+
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import org.osgi.framework.Bundle;
+import org.osgi.framework.BundleContext;
+
+import junit.framework.TestCase;
+
+/**
+ * User: guillaume
+ * Date: 03/10/13
+ * Time: 11:53
+ */
+public class IPojoFactoryTestCase extends TestCase {
+ @Mock
+ private IPojoFactory.NameGenerator m_delegate;
+ @Mock
+ private Factory m_factory;
+ @Mock
+ private BundleContext m_bundleContext;
+ @Mock
+ private Bundle m_bundle;
+
+ @Override
+ public void setUp() throws Exception {
+ MockitoAnnotations.initMocks(this);
+ }
+
+ public void testRetryNameGenerator() throws Exception {
+ when(m_factory.getName()).thenReturn("test");
+ when(m_delegate.generate(eq(m_factory), anyList())).thenReturn("my.instance");
+
+ IPojoFactory.RetryNameGenerator retry = new IPojoFactory.RetryNameGenerator(m_delegate);
+
+ assertEquals("my.instance", retry.generate(m_factory, Collections.<String>emptyList()));
+ }
+
+ public void testRetryNameGeneratorWithCollisions() throws Exception {
+ when(m_factory.getName()).thenReturn("test");
+ when(m_delegate.generate(eq(m_factory), anyList())).thenReturn("my.instance", "my.instance2");
+
+ IPojoFactory.RetryNameGenerator retry = new IPojoFactory.RetryNameGenerator(m_delegate);
+
+ assertEquals("my.instance2", retry.generate(m_factory, Arrays.asList("my.instance")));
+ }
+
+ public void testRetryNameGeneratorDoNotGenerateStackOverflow() throws Exception {
+ when(m_factory.getName()).thenReturn("test");
+ when(m_delegate.generate(eq(m_factory), anyList())).thenReturn("my.instance");
+ when(m_factory.getBundleContext()).thenReturn(m_bundleContext);
+ when(m_bundleContext.getBundle()).thenReturn(m_bundle);
+ when(m_bundle.getBundleId()).thenReturn(42l);
+
+ IPojoFactory.RetryNameGenerator retry = new IPojoFactory.RetryNameGenerator(m_delegate);
+ retry.setMaximum(100);
+
+ try {
+ retry.generate(m_factory, Arrays.asList("my.instance"));
+ } catch (UnacceptableConfiguration unacceptableConfiguration) {
+ return;
+ }
+ fail("Expecting an Exception");
+ }
+
+
+ public void testDefaultNameGenerator() throws Exception {
+ when(m_factory.getName()).thenReturn("test");
+
+ IPojoFactory.DefaultNameGenerator generator = new IPojoFactory.DefaultNameGenerator();
+
+ assertEquals("test-0", generator.generate(m_factory, null));
+ assertEquals("test-1", generator.generate(m_factory, null));
+ assertEquals("test-2", generator.generate(m_factory, null));
+ assertEquals("test-3", generator.generate(m_factory, null));
+ assertEquals("test-4", generator.generate(m_factory, null));
+ }
+
+ public void testDefaultNameGeneratorWithVersion() throws Exception {
+ when(m_factory.getName()).thenReturn("test");
+ when(m_factory.getVersion()).thenReturn("1.2.3");
+
+ IPojoFactory.DefaultNameGenerator generator = new IPojoFactory.DefaultNameGenerator();
+
+ assertEquals("test/1.2.3-0", generator.generate(m_factory, null));
+ assertEquals("test/1.2.3-1", generator.generate(m_factory, null));
+ assertEquals("test/1.2.3-2", generator.generate(m_factory, null));
+ assertEquals("test/1.2.3-3", generator.generate(m_factory, null));
+ assertEquals("test/1.2.3-4", generator.generate(m_factory, null));
+ }
+
+}