3 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
5 * This program and the accompanying materials are made available under the
6 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
7 * and is available at http://www.eclipse.org/legal/epl-v10.html
10 package org.opendaylight.controller.configuration.internal;
13 import java.util.ArrayList;
14 import java.util.Collections;
15 import java.util.Dictionary;
16 import java.util.EnumSet;
17 import java.util.HashSet;
18 import java.util.List;
20 import java.util.concurrent.ConcurrentMap;
22 import org.apache.felix.dm.Component;
23 import org.opendaylight.controller.clustering.services.CacheConfigException;
24 import org.opendaylight.controller.clustering.services.CacheExistException;
25 import org.opendaylight.controller.clustering.services.ICacheUpdateAware;
26 import org.opendaylight.controller.clustering.services.IClusterContainerServices;
27 import org.opendaylight.controller.clustering.services.IClusterServices;
28 import org.opendaylight.controller.configuration.ConfigurationEvent;
29 import org.opendaylight.controller.configuration.ConfigurationObject;
30 import org.opendaylight.controller.configuration.IConfigurationAware;
31 import org.opendaylight.controller.configuration.IConfigurationContainerAware;
32 import org.opendaylight.controller.configuration.IConfigurationContainerService;
33 import org.opendaylight.controller.sal.utils.GlobalConstants;
34 import org.opendaylight.controller.sal.utils.IObjectReader;
35 import org.opendaylight.controller.sal.utils.ObjectReader;
36 import org.opendaylight.controller.sal.utils.ObjectWriter;
37 import org.opendaylight.controller.sal.utils.Status;
38 import org.opendaylight.controller.sal.utils.StatusCode;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
43 * @file ConfigurationImpl.java
45 * @brief Backend functionality for all ConfigurationService related tasks.
49 public class ContainerConfigurationService implements IConfigurationContainerService,
50 IConfigurationAware, ICacheUpdateAware<ConfigurationEvent, String> {
51 public static final String CONTAINER_SAVE_EVENT_CACHE = "config.container.event.save";
52 private static final Logger logger = LoggerFactory.getLogger(ContainerConfigurationService.class);
53 private IClusterContainerServices clusterServices;
54 private ConcurrentMap <ConfigurationEvent, String> containerConfigEvent;
55 // Directory which contains the startup files for this container
57 private Set<IConfigurationContainerAware> configurationAwareList = Collections
58 .synchronizedSet(new HashSet<IConfigurationContainerAware>());
59 private ObjectReader objReader;
60 private ObjectWriter objWriter;
61 private String containerName;
63 public void addConfigurationContainerAware(
64 IConfigurationContainerAware configurationAware) {
65 if (!this.configurationAwareList.contains(configurationAware)) {
66 this.configurationAwareList.add(configurationAware);
70 public int getConfigurationAwareListSize() {
71 return this.configurationAwareList.size();
74 public void removeConfigurationContainerAware(
75 IConfigurationContainerAware configurationAware) {
76 this.configurationAwareList.remove(configurationAware);
79 public void setClusterServices(IClusterContainerServices i) {
80 this.clusterServices = i;
81 logger.debug("IClusterServices set");
84 public void unsetClusterServices(IClusterContainerServices i) {
85 if (this.clusterServices == i) {
86 this.clusterServices = null;
87 logger.debug("IClusterServices Unset");
91 void init(Component c) {
92 Dictionary<?, ?> props = c.getServiceProperties();
93 containerName = (props != null) ? (String) props.get("containerName") :
94 GlobalConstants.DEFAULT.toString();
95 root = String.format("%s%s/", GlobalConstants.STARTUPHOME.toString(), containerName);
101 objReader = new ObjectReader();
102 objWriter = new ObjectWriter();
105 public void destroy() {
106 // Clear local states
107 this.configurationAwareList.clear();
111 * Function called by the dependency manager before Container is Stopped and Destroyed.
113 public void containerStop() {
118 public String getConfigurationRoot() {
123 public Status saveConfiguration() {
124 boolean success = true;
126 for (IConfigurationContainerAware configurationAware : configurationAwareList) {
127 logger.trace("Save Config triggered for {}", configurationAware.getClass().getSimpleName());
129 Status status = configurationAware.saveConfiguration();
130 if (!status.isSuccess()) {
132 logger.warn("Failed to save config for {} ({})", configurationAware.getClass().getSimpleName(),
133 status.getDescription());
137 return new Status(StatusCode.SUCCESS);
139 return new Status(StatusCode.INTERNALERROR, "Failed to save one or more configurations");
144 public Status saveConfigurations() {
145 containerConfigEvent.put(ConfigurationEvent.SAVE, "");
146 return saveConfiguration();
150 public void entryCreated(ConfigurationEvent key, String cacheName,
151 boolean originLocal) {
158 public void entryUpdated(ConfigurationEvent key, String new_value,
159 String cacheName, boolean originLocal) {
163 logger.debug("Processing {} event", key);
164 if (key == ConfigurationEvent.SAVE) {
170 public void entryDeleted(ConfigurationEvent key, String cacheName,
171 boolean originLocal) {
177 private void allocateCache() {
178 if (this.clusterServices == null) {
179 logger.error("uninitialized clusterServices, can't create cache");
183 this.clusterServices.createCache(CONTAINER_SAVE_EVENT_CACHE,
184 EnumSet.of(IClusterServices.cacheMode.TRANSACTIONAL));
185 } catch (CacheConfigException cce) {
186 logger.debug("Error creating ContainerConfigurationService cache ", cce);
187 } catch (CacheExistException cce) {
188 logger.debug("ConfigurationService Cache already exists, destroy and recreate ", cce);
192 @SuppressWarnings({ "unchecked" })
193 private void retrieveCache() {
194 if (this.clusterServices == null) {
195 logger.error("uninitialized clusterServices, can't retrieve cache");
198 containerConfigEvent = (ConcurrentMap<ConfigurationEvent, String>) this.clusterServices.getCache(CONTAINER_SAVE_EVENT_CACHE);
199 if (containerConfigEvent == null) {
200 logger.error("Failed to retrieve configuration Cache");
205 public Status persistConfiguration(List<ConfigurationObject> config, String fileName) {
206 if (!hasBeenSaved()) {
207 return new Status(StatusCode.NOTALLOWED,
208 String.format("Container %s has not been saved yet", containerName));
210 String destination = String.format("%s%s", root, fileName);
211 return objWriter.write(config, destination);
215 public List<ConfigurationObject> retrieveConfiguration(IObjectReader reader, String fileName) {
216 if (!clusterServices.amICoordinator()) {
217 return Collections.emptyList();
219 String source = String.format("%s%s", root, fileName);
220 Object obj = objReader.read(reader, source);
222 return Collections.<ConfigurationObject> emptyList();
224 if (obj instanceof ConcurrentMap) {
225 return new ArrayList<ConfigurationObject>(((ConcurrentMap)obj).values());
227 return (List<ConfigurationObject>) obj;
231 public boolean hasBeenSaved() {
233 File configRoot = new File(this.getConfigurationRoot());
234 return configRoot.exists();
235 } catch (Exception e) {