/* * Copyright 2015 Open Networking Laboratory * * Licensed 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.onosproject.net.config.impl; import com.fasterxml.jackson.databind.JsonNode; import com.google.common.collect.ImmutableSet; import com.google.common.collect.Maps; import org.apache.felix.scr.annotations.Activate; import org.apache.felix.scr.annotations.Component; import org.apache.felix.scr.annotations.Deactivate; import org.apache.felix.scr.annotations.Reference; import org.apache.felix.scr.annotations.ReferenceCardinality; import org.apache.felix.scr.annotations.Service; import org.onosproject.event.AbstractListenerManager; import org.onosproject.net.config.Config; import org.onosproject.net.config.ConfigFactory; import org.onosproject.net.config.NetworkConfigEvent; import org.onosproject.net.config.NetworkConfigListener; import org.onosproject.net.config.NetworkConfigRegistry; import org.onosproject.net.config.NetworkConfigService; import org.onosproject.net.config.NetworkConfigStore; import org.onosproject.net.config.NetworkConfigStoreDelegate; import org.onosproject.net.config.SubjectFactory; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.util.Map; import java.util.Objects; import java.util.Set; import static com.google.common.base.Preconditions.checkNotNull; /** * Implementation of the network configuration subsystem. */ @Component(immediate = true) @Service public class NetworkConfigManager extends AbstractListenerManager implements NetworkConfigRegistry, NetworkConfigService { private final Logger log = LoggerFactory.getLogger(getClass()); private static final String NULL_FACTORY_MSG = "Factory cannot be null"; private static final String NULL_SCLASS_MSG = "Subject class cannot be null"; private static final String NULL_CCLASS_MSG = "Config class cannot be null"; private static final String NULL_SUBJECT_MSG = "Subject cannot be null"; // Inventory of configuration factories private final Map factories = Maps.newConcurrentMap(); // Secondary indices to retrieve subject and config classes by keys private final Map subjectClasses = Maps.newConcurrentMap(); private final Map subjectClassKeys = Maps.newConcurrentMap(); private final Map> configClasses = Maps.newConcurrentMap(); private final NetworkConfigStoreDelegate storeDelegate = new InternalStoreDelegate(); @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) protected NetworkConfigStore store; @Activate public void activate() { eventDispatcher.addSink(NetworkConfigEvent.class, listenerRegistry); store.setDelegate(storeDelegate); log.info("Started"); } @Deactivate public void deactivate() { eventDispatcher.removeSink(NetworkConfigEvent.class); store.unsetDelegate(storeDelegate); log.info("Stopped"); } @Override @SuppressWarnings("unchecked") public void registerConfigFactory(ConfigFactory configFactory) { checkNotNull(configFactory, NULL_FACTORY_MSG); factories.put(key(configFactory), configFactory); configClasses.put(identifier(configFactory), configFactory.configClass()); SubjectFactory subjectFactory = configFactory.subjectFactory(); subjectClasses.putIfAbsent(subjectFactory.subjectClassKey(), subjectFactory); subjectClassKeys.putIfAbsent(subjectFactory.subjectClass(), subjectFactory); store.addConfigFactory(configFactory); } @Override public void unregisterConfigFactory(ConfigFactory configFactory) { checkNotNull(configFactory, NULL_FACTORY_MSG); factories.remove(key(configFactory)); configClasses.remove(identifier(configFactory)); // Note that we are deliberately not removing subject factory key bindings. store.removeConfigFactory(configFactory); } @Override public Set getConfigFactories() { return ImmutableSet.copyOf(factories.values()); } @Override @SuppressWarnings("unchecked") public > Set> getConfigFactories(Class subjectClass) { ImmutableSet.Builder> builder = ImmutableSet.builder(); factories.forEach((key, factory) -> { if (factory.subjectFactory().subjectClass().equals(subjectClass)) { builder.add(factory); } }); return builder.build(); } @Override public > ConfigFactory getConfigFactory(Class configClass) { checkNotNull(configClass, NULL_CCLASS_MSG); return store.getConfigFactory(configClass); } @Override public Set getSubjectClasses() { ImmutableSet.Builder builder = ImmutableSet.builder(); factories.forEach((k, v) -> builder.add(k.subjectClass)); return builder.build(); } @Override public SubjectFactory getSubjectFactory(String subjectClassKey) { return subjectClasses.get(subjectClassKey); } @Override public SubjectFactory getSubjectFactory(Class subjectClass) { return subjectClassKeys.get(subjectClass); } @Override public Class getConfigClass(String subjectClassKey, String configKey) { return configClasses.get(new ConfigIdentifier(subjectClassKey, configKey)); } @Override public Set getSubjects(Class subjectClass) { checkNotNull(subjectClass, NULL_SCLASS_MSG); return store.getSubjects(subjectClass); } @Override public > Set getSubjects(Class subjectClass, Class configClass) { checkNotNull(subjectClass, NULL_SCLASS_MSG); checkNotNull(configClass, NULL_CCLASS_MSG); return store.getSubjects(subjectClass, configClass); } @Override public Set> getConfigs(S subject) { checkNotNull(subject, NULL_SUBJECT_MSG); Set>> configClasses = store.getConfigClasses(subject); ImmutableSet.Builder> cfg = ImmutableSet.builder(); configClasses.forEach(cc -> cfg.add(store.getConfig(subject, cc))); return cfg.build(); } @Override public > T getConfig(S subject, Class configClass) { checkNotNull(subject, NULL_SUBJECT_MSG); checkNotNull(configClass, NULL_CCLASS_MSG); return store.getConfig(subject, configClass); } @Override public > C addConfig(S subject, Class configClass) { checkNotNull(subject, NULL_SUBJECT_MSG); checkNotNull(configClass, NULL_CCLASS_MSG); return store.createConfig(subject, configClass); } @Override public > C applyConfig(S subject, Class configClass, JsonNode json) { checkNotNull(subject, NULL_SUBJECT_MSG); checkNotNull(configClass, NULL_CCLASS_MSG); return store.applyConfig(subject, configClass, json); } @Override public > void removeConfig(S subject, Class configClass) { checkNotNull(subject, NULL_SUBJECT_MSG); checkNotNull(configClass, NULL_CCLASS_MSG); store.clearConfig(subject, configClass); } // Auxiliary store delegate to receive notification about changes in // the network configuration store state - by the store itself. private class InternalStoreDelegate implements NetworkConfigStoreDelegate { @Override public void notify(NetworkConfigEvent event) { post(event); } } // Produces a key for uniquely tracking a config factory. private static ConfigKey key(ConfigFactory factory) { return new ConfigKey(factory.subjectFactory().subjectClass(), factory.configClass()); } // Auxiliary key to track config factories. protected static final class ConfigKey { final Class subjectClass; final Class configClass; protected ConfigKey(Class subjectClass, Class configClass) { this.subjectClass = subjectClass; this.configClass = configClass; } @Override public int hashCode() { return Objects.hash(subjectClass, configClass); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof ConfigKey) { final ConfigKey other = (ConfigKey) obj; return Objects.equals(this.subjectClass, other.subjectClass) && Objects.equals(this.configClass, other.configClass); } return false; } } private static ConfigIdentifier identifier(ConfigFactory factory) { return new ConfigIdentifier(factory.subjectFactory().subjectClassKey(), factory.configKey()); } static final class ConfigIdentifier { final String subjectKey; final String configKey; protected ConfigIdentifier(String subjectKey, String configKey) { this.subjectKey = subjectKey; this.configKey = configKey; } @Override public int hashCode() { return Objects.hash(subjectKey, configKey); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof ConfigIdentifier) { final ConfigIdentifier other = (ConfigIdentifier) obj; return Objects.equals(this.subjectKey, other.subjectKey) && Objects.equals(this.configKey, other.configKey); } return false; } } }