| /* |
| * 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.cm.impl; |
| |
| |
| import java.io.IOException; |
| import java.util.Dictionary; |
| import java.util.Hashtable; |
| |
| import org.apache.felix.cm.PersistenceManager; |
| import org.osgi.framework.Constants; |
| import org.osgi.service.cm.Configuration; |
| import org.osgi.service.cm.ConfigurationAdmin; |
| import org.osgi.service.log.LogService; |
| |
| |
| /** |
| * The <code>ConfigurationImpl</code> is the backend implementation of the |
| * Configuration Admin Service Specification <i>Configuration object</i> |
| * (section 104.4). Instances of this class are shared by multiple instances of |
| * the {@link ConfigurationAdapter} class, whose instances are actually returned |
| * to clients. |
| */ |
| class ConfigurationImpl extends ConfigurationBase |
| { |
| |
| /* |
| * Concurrency note: There is a slight (but real) chance of a race condition |
| * between a configuration update and a ManagedService[Factory] registration. |
| * Per the specification a ManagedService must be called with configuration |
| * or null when registered and a ManagedService must be called with currently |
| * existing configuration when registered. Also the ManagedService[Factory] |
| * must be updated when the configuration is updated. |
| * |
| * Consider now this situation of two threads T1 and T2: |
| * |
| * T1. create and update configuration |
| * ConfigurationImpl.update persists configuration and sets field |
| * Thread preempted |
| * |
| * T2. ManagedServiceUpdate constructor reads configuration |
| * Uses configuration already persisted by T1 for update |
| * Schedules task to update service with the configuration |
| * |
| * T1. Runs again creating the UpdateConfiguration task with the |
| * configuration persisted before being preempted |
| * Schedules task to update service |
| * |
| * Update Thread: |
| * Updates ManagedService with configuration prepared by T2 |
| * Updates ManagedService with configuration prepared by T1 |
| * |
| * The correct behaviour would be here, that the second call to update |
| * would not take place. |
| * |
| * This concurrency safety is implemented with the help of the |
| * lastModificationTime field updated by the configure(Dictionary) method |
| * when setting the properties field and the lastUpdatedTime field updated |
| * in the Update Thread after calling the update(Dictionary) method of |
| * the ManagedService[Factory] service. |
| * |
| * The UpdateConfiguration task compares the lastModificationTime to the |
| * lastUpdateTime. If the configuration has been modified after being |
| * updated the last time, it is updated in the ManagedService[Factory]. If |
| * the configuration has already been updated since being modified (as in |
| * the case above), the UpdateConfiguration thread does not call the update |
| * method (but still sends the CM_UPDATED event). |
| * |
| * See also FELIX-1542. |
| * |
| * FELIX-1545 provides further update to the concurrency situation defining |
| * three more failure cases: |
| * |
| * (1) System.currentTimeMillis() may be too coarse graind to protect |
| * against race condition. |
| * (2) ManagedService update sets last update time regardless of whether |
| * configuration was provided or not. This may cause a configuration |
| * update to be lost. |
| * (3) ManagedService update does not respect last update time which |
| * in turn may cause duplicate configuration delivery. |
| */ |
| |
| /** |
| * The name of a synthetic property stored in the persisted configuration |
| * data to indicate that the configuration data is new, that is created but |
| * never updated (value is "_felix_.cm.newConfiguration"). |
| * <p> |
| * This special property is stored by the |
| * {@link #ConfigurationImpl(ConfigurationManager, PersistenceManager, String, String, String)} |
| * constructor, when the configuration is first created and persisted and is |
| * interpreted by the |
| * {@link #ConfigurationImpl(ConfigurationManager, PersistenceManager, Dictionary)} |
| * method when the configuration data is loaded in a new object. |
| * <p> |
| * The goal of this property is to keep the information on whether |
| * configuration data is new (but persisted as per the spec) or has already |
| * been assigned with possible no data. |
| */ |
| private static final String CONFIGURATION_NEW = "_felix_.cm.newConfiguration"; |
| |
| /** |
| * The factory PID of this configuration or <code>null</code> if this |
| * is not a factory configuration. |
| */ |
| private final String factoryPID; |
| |
| /** |
| * The statically bound bundle location, which is set explicitly by calling |
| * the Configuration.setBundleLocation(String) method or when the |
| * configuration was created with the two-argument method. |
| */ |
| private volatile String staticBundleLocation; |
| |
| /** |
| * The bundle location from dynamic binding. This value is set as the |
| * configuration or factory is assigned to a ManagedService[Factory]. |
| */ |
| private volatile String dynamicBundleLocation; |
| |
| /** |
| * The configuration data of this configuration instance. This is a private |
| * copy of the properties of which a copy is made when the |
| * {@link #getProperties()} method is called. This field is |
| * <code>null</code> if the configuration has been created and never been |
| * updated with acutal configuration properties. |
| */ |
| private volatile CaseInsensitiveDictionary properties; |
| |
| /** |
| * Flag indicating that this configuration has been deleted. |
| * |
| * @see #isDeleted() |
| */ |
| private volatile boolean isDeleted; |
| |
| /** |
| * Current configuration modification counter. This field is incremented |
| * each time the {@link #properties} field is set (in the constructor or the |
| * {@link #configure(Dictionary)} method. field. |
| */ |
| private volatile long lastModificationTime; |
| |
| /** |
| * Value of the {@link #lastModificationTime} counter at the time the non- |
| * <code>null</code> properties of this configuration have been updated to a |
| * ManagedService[Factory]. This field is initialized to -1 in the |
| * constructors and set to the value of the {@link #lastModificationTime} by |
| * the {@link #setLastUpdatedTime()} method called from the respective task |
| * updating the configuration. |
| * |
| * @see #lastModificationTime |
| */ |
| private volatile long lastUpdatedTime; |
| |
| |
| ConfigurationImpl( ConfigurationManager configurationManager, PersistenceManager persistenceManager, |
| Dictionary properties ) |
| { |
| super( configurationManager, persistenceManager, ( String ) properties.remove( Constants.SERVICE_PID ) ); |
| |
| this.factoryPID = ( String ) properties.remove( ConfigurationAdmin.SERVICE_FACTORYPID ); |
| this.isDeleted = false; |
| this.lastUpdatedTime = -1; |
| |
| // set bundle location from persistence and/or check for dynamic binding |
| this.staticBundleLocation = ( String ) properties.remove( ConfigurationAdmin.SERVICE_BUNDLELOCATION ) ; |
| this.dynamicBundleLocation = configurationManager.getDynamicBundleLocation( getBaseId() ); |
| |
| // set the properties internally |
| configureFromPersistence( properties ); |
| } |
| |
| |
| ConfigurationImpl( ConfigurationManager configurationManager, PersistenceManager persistenceManager, String pid, |
| String factoryPid, String bundleLocation ) throws IOException |
| { |
| super( configurationManager, persistenceManager, pid ); |
| |
| this.factoryPID = factoryPid; |
| this.isDeleted = false; |
| this.lastUpdatedTime = -1; |
| |
| // set bundle location from persistence and/or check for dynamic binding |
| this.staticBundleLocation = bundleLocation; |
| this.dynamicBundleLocation = configurationManager.getDynamicBundleLocation( getBaseId() ); |
| |
| // first "update" |
| this.properties = null; |
| setLastModificationTime(); |
| |
| // this is a new configuration object, store immediately unless |
| // the new configuration object is created from a factory, in which |
| // case the configuration is only stored when first updated |
| if ( factoryPid == null ) |
| { |
| Dictionary props = new Hashtable(); |
| setAutoProperties( props, true ); |
| props.put( CONFIGURATION_NEW, Boolean.TRUE ); |
| persistenceManager.store( pid, props ); |
| } |
| } |
| |
| |
| public void delete() throws IOException |
| { |
| this.isDeleted = true; |
| getPersistenceManager().delete( this.getPid() ); |
| getConfigurationManager().setDynamicBundleLocation( this.getPid(), null ); |
| getConfigurationManager().deleted( this ); |
| } |
| |
| |
| public String getPid() |
| { |
| return getBaseId(); |
| } |
| |
| |
| public String getFactoryPid() |
| { |
| return factoryPID; |
| } |
| |
| |
| |
| |
| /** |
| * Returns the "official" bundle location as visible from the outside |
| * world of code calling into the Configuration.getBundleLocation() method. |
| * <p> |
| * In other words: The {@link #getStaticBundleLocation()} is returned if |
| * not <code>null</code>. Otherwise the {@link #getDynamicBundleLocation()} |
| * is returned (which may also be <code>null</code>). |
| */ |
| String getBundleLocation() |
| { |
| if ( staticBundleLocation != null ) |
| { |
| return staticBundleLocation; |
| } |
| |
| return dynamicBundleLocation; |
| } |
| |
| |
| String getDynamicBundleLocation() |
| { |
| return dynamicBundleLocation; |
| } |
| |
| |
| String getStaticBundleLocation() |
| { |
| return staticBundleLocation; |
| } |
| |
| |
| void setStaticBundleLocation( final String bundleLocation ) |
| { |
| // CM 1.4; needed for bundle location change at the end |
| final String oldBundleLocation = getBundleLocation(); |
| |
| // 104.15.2.8 The bundle location will be set persistently |
| this.staticBundleLocation = bundleLocation; |
| storeSilently(); |
| |
| // check whether the dynamic bundle location is different from the |
| // static now. If so, the dynamic bundle location has to be |
| // removed. |
| if ( bundleLocation != null && getDynamicBundleLocation() != null |
| && !bundleLocation.equals( getDynamicBundleLocation() ) ) |
| { |
| setDynamicBundleLocation( null, false ); |
| } |
| |
| // CM 1.4 |
| this.getConfigurationManager().locationChanged( this, oldBundleLocation ); |
| } |
| |
| |
| void setDynamicBundleLocation( final String bundleLocation, final boolean dispatchConfiguration ) |
| { |
| // CM 1.4; needed for bundle location change at the end |
| final String oldBundleLocation = getBundleLocation(); |
| |
| this.dynamicBundleLocation = bundleLocation; |
| this.getConfigurationManager().setDynamicBundleLocation( this.getBaseId(), bundleLocation ); |
| |
| // CM 1.4 |
| if ( dispatchConfiguration ) |
| { |
| this.getConfigurationManager().locationChanged( this, oldBundleLocation ); |
| |
| } |
| } |
| |
| |
| /** |
| * Dynamically binds this configuration to the given location unless |
| * the configuration is already bound (statically or dynamically). In |
| * the case of this configuration to be dynamically bound a |
| * <code>CM_LOCATION_CHANGED</code> event is dispatched. |
| */ |
| boolean tryBindLocation( final String bundleLocation ) |
| { |
| if ( this.getBundleLocation() == null ) |
| { |
| setDynamicBundleLocation( bundleLocation, true ); |
| } |
| |
| return true; |
| } |
| |
| |
| /** |
| * Returns an optionally deep copy of the properties of this configuration |
| * instance. |
| * <p> |
| * This method returns a copy of the internal dictionary. If the |
| * <code>deepCopy</code> parameter is true array and collection values are |
| * copied into new arrays or collections. Otherwise just a new dictionary |
| * referring to the same objects is returned. |
| * |
| * @param deepCopy |
| * <code>true</code> if a deep copy is to be returned. |
| * @return |
| */ |
| public Dictionary getProperties( boolean deepCopy ) |
| { |
| // no properties yet |
| if ( properties == null ) |
| { |
| return null; |
| } |
| |
| CaseInsensitiveDictionary props = new CaseInsensitiveDictionary( properties, deepCopy ); |
| |
| // fix special properties (pid, factory PID, bundle location) |
| setAutoProperties( props, false ); |
| |
| return props; |
| } |
| |
| |
| /* (non-Javadoc) |
| * @see org.osgi.service.cm.Configuration#update() |
| */ |
| public void update() throws IOException |
| { |
| PersistenceManager localPersistenceManager = getPersistenceManager(); |
| if ( localPersistenceManager != null ) |
| { |
| // read configuration from persistence (again) |
| if ( localPersistenceManager.exists( getPid() ) ) |
| { |
| Dictionary properties = localPersistenceManager.load( getPid() ); |
| |
| // ensure serviceReference pid |
| String servicePid = ( String ) properties.get( Constants.SERVICE_PID ); |
| if ( servicePid != null && !getPid().equals( servicePid ) ) |
| { |
| throw new IOException( "PID of configuration file does match requested PID; expected " + getPid() |
| + ", got " + servicePid ); |
| } |
| |
| configureFromPersistence( properties ); |
| } |
| |
| // update the service but do not fire an CM_UPDATED event |
| getConfigurationManager().updated( this, false ); |
| } |
| } |
| |
| |
| /* (non-Javadoc) |
| * @see org.osgi.service.cm.Configuration#update(java.util.Dictionary) |
| */ |
| public void update( Dictionary properties ) throws IOException |
| { |
| PersistenceManager localPersistenceManager = getPersistenceManager(); |
| if ( localPersistenceManager != null ) |
| { |
| CaseInsensitiveDictionary newProperties = new CaseInsensitiveDictionary( properties ); |
| |
| setAutoProperties( newProperties, true ); |
| |
| // persist new configuration |
| localPersistenceManager.store( getPid(), newProperties ); |
| |
| // if this is a factory configuration, update the factory with |
| String factoryPid = getFactoryPid(); |
| if ( factoryPid != null ) |
| { |
| // If this is a new factory configuration, we also have to add |
| // it to the configuration manager cache |
| if ( isNew() ) |
| { |
| getConfigurationManager().cacheConfiguration( this ); |
| } |
| |
| Factory factory = getConfigurationManager().getFactory( factoryPid ); |
| if ( factory.addPID( getPid() ) ) |
| { |
| // only write back if the pid was not already registered |
| // with the factory |
| try |
| { |
| factory.store(); |
| } |
| catch ( IOException ioe ) |
| { |
| getConfigurationManager().log( LogService.LOG_ERROR, |
| "Failure storing factory " + factoryPid + " with new configuration " + getPid(), ioe ); |
| } |
| } |
| } |
| |
| // finally assign the configuration for use |
| configure( newProperties ); |
| |
| // update the service and fire an CM_UPDATED event |
| getConfigurationManager().updated( this, true ); |
| } |
| } |
| |
| |
| //---------- Object overwrites -------------------------------------------- |
| |
| public boolean equals( Object obj ) |
| { |
| if ( obj == this ) |
| { |
| return true; |
| } |
| |
| if ( obj instanceof Configuration ) |
| { |
| return getPid().equals( ( ( Configuration ) obj ).getPid() ); |
| } |
| |
| return false; |
| } |
| |
| |
| public int hashCode() |
| { |
| return getPid().hashCode(); |
| } |
| |
| |
| public String toString() |
| { |
| return "Configuration PID=" + getPid() + ", factoryPID=" + factoryPID + ", bundleLocation=" + getBundleLocation(); |
| } |
| |
| |
| // ---------- private helper ----------------------------------------------- |
| |
| void store() throws IOException |
| { |
| // we don't need a deep copy, since we are not modifying |
| // any value in the dictionary itself. we are just adding |
| // properties to it, which are required for storing |
| Dictionary props = getProperties( false ); |
| |
| // if this is a new configuration, we just use an empty Dictionary |
| if ( props == null ) |
| { |
| props = new Hashtable(); |
| |
| // add automatic properties including the bundle location (if |
| // statically bound) |
| setAutoProperties( props, true ); |
| } |
| else |
| { |
| replaceProperty( props, ConfigurationAdmin.SERVICE_BUNDLELOCATION, getStaticBundleLocation() ); |
| } |
| |
| // only store now, if this is not a new configuration |
| getPersistenceManager().store( getPid(), props ); |
| } |
| |
| |
| /** |
| * Increments the last modification counter of this configuration to cause |
| * the ManagedService or ManagedServiceFactory subscribed to this |
| * configuration to be updated. |
| * <p> |
| * This method is intended to only be called by the constructor(s) of this |
| * class and the {@link #update(Dictionary)} method to indicate to the |
| * update threads, the configuration is ready for distribution. |
| * <p> |
| * Setting the properties field and incrementing this counter should be |
| * done synchronized on this instance. |
| */ |
| void setLastModificationTime( ) |
| { |
| this.lastModificationTime++; |
| } |
| |
| |
| /** |
| * Returns the modification counter of the last modification of the |
| * properties of this configuration object. |
| * <p> |
| * This value may be compared to the {@link #getLastUpdatedTime()} to decide |
| * whether to update the ManagedService[Factory] or not. |
| * <p> |
| * Getting the properties of this configuration and this counter should be |
| * done synchronized on this instance. |
| */ |
| long getLastModificationTime() |
| { |
| return lastModificationTime; |
| } |
| |
| |
| /** |
| * Returns the modification counter of the last update of this configuration |
| * to the subscribing ManagedService or ManagedServiceFactory. This value |
| * may be compared to the {@link #getLastModificationTime()} to decide |
| * whether the configuration should be updated or not. |
| */ |
| long getLastUpdatedTime() |
| { |
| return lastUpdatedTime; |
| } |
| |
| |
| /** |
| * Sets the last update time field to the given value of the last |
| * modification time to indicate the version of configuration properties |
| * that have been updated in a ManagedService[Factory]. |
| * <p> |
| * This method should only be called from the Update Thread after supplying |
| * the configuration to the ManagedService[Factory]. |
| * |
| * @param lastModificationTime The value of the |
| * {@link #getLastModificationTime() last modification time field} at |
| * which the properties have been extracted from the configuration to |
| * be supplied to the service. |
| */ |
| void setLastUpdatedTime( long lastModificationTime ) |
| { |
| synchronized ( this ) |
| { |
| if ( this.lastUpdatedTime < lastModificationTime ) |
| { |
| this.lastUpdatedTime = lastModificationTime; |
| } |
| } |
| } |
| |
| |
| /** |
| * Returns <code>false</code> if this configuration contains configuration |
| * properties. Otherwise <code>true</code> is returned and this is a |
| * newly creted configuration object whose {@link #update(Dictionary)} |
| * method has never been called. |
| */ |
| boolean isNew() |
| { |
| return properties == null; |
| } |
| |
| |
| /** |
| * Returns <code>true</code> if this configuration has already been deleted |
| * on the persistence. |
| */ |
| boolean isDeleted() |
| { |
| return isDeleted; |
| } |
| |
| |
| private void configureFromPersistence( Dictionary properties ) |
| { |
| // if the this is not an empty/new configuration, accept the properties |
| // otherwise just set the properties field to null |
| if ( properties.get( CONFIGURATION_NEW ) == null ) |
| { |
| configure( properties ); |
| } |
| else |
| { |
| configure( null ); |
| } |
| } |
| |
| private void configure( final Dictionary properties ) |
| { |
| final CaseInsensitiveDictionary newProperties; |
| if ( properties == null ) |
| { |
| newProperties = null; |
| } |
| else |
| { |
| // remove predefined properties |
| clearAutoProperties( properties ); |
| |
| // ensure CaseInsensitiveDictionary |
| if ( properties instanceof CaseInsensitiveDictionary ) |
| { |
| newProperties = ( CaseInsensitiveDictionary ) properties; |
| } |
| else |
| { |
| newProperties = new CaseInsensitiveDictionary( properties ); |
| } |
| } |
| |
| synchronized ( this ) |
| { |
| this.properties = newProperties; |
| setLastModificationTime(); |
| } |
| } |
| |
| |
| void setAutoProperties( Dictionary properties, boolean withBundleLocation ) |
| { |
| // set pid and factory pid in the properties |
| replaceProperty( properties, Constants.SERVICE_PID, getPid() ); |
| replaceProperty( properties, ConfigurationAdmin.SERVICE_FACTORYPID, factoryPID ); |
| |
| // bundle location is not set here |
| if ( withBundleLocation ) |
| { |
| replaceProperty( properties, ConfigurationAdmin.SERVICE_BUNDLELOCATION, getStaticBundleLocation() ); |
| } |
| else |
| { |
| properties.remove( ConfigurationAdmin.SERVICE_BUNDLELOCATION ); |
| } |
| } |
| |
| |
| static void clearAutoProperties( Dictionary properties ) |
| { |
| properties.remove( Constants.SERVICE_PID ); |
| properties.remove( ConfigurationAdmin.SERVICE_FACTORYPID ); |
| properties.remove( ConfigurationAdmin.SERVICE_BUNDLELOCATION ); |
| } |
| } |