* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
-
package org.opendaylight.yanglib.impl;
+import static com.google.common.base.Preconditions.checkArgument;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Predicate;
import com.google.common.collect.Iterables;
import com.google.common.util.concurrent.FutureCallback;
-import com.google.common.util.concurrent.Futures;
-import java.util.ArrayList;
-import java.util.List;
-import javax.annotation.Nullable;
-import org.opendaylight.controller.md.sal.binding.api.DataBroker;
-import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
-import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
-import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
-import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
+import com.google.common.util.concurrent.MoreExecutors;
+import java.io.File;
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Optional;
+import java.util.concurrent.ExecutionException;
+import javax.annotation.PreDestroy;
+import javax.inject.Inject;
+import javax.inject.Singleton;
+import javax.ws.rs.NotFoundException;
+import javax.ws.rs.WebApplicationException;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.mdsal.binding.api.DataBroker;
+import org.opendaylight.mdsal.binding.api.WriteTransaction;
+import org.opendaylight.mdsal.common.api.CommitInfo;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.ModulesState;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.ModulesStateBuilder;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.OptionalRevision;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.RevisionIdentifier;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.module.list.Module;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.module.list.ModuleBuilder;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160409.module.list.ModuleKey;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.LegacyRevisionUtils;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.ModulesState;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.ModulesStateBuilder;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.Module;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.ModuleBuilder;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.ModuleKey;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.YangIdentifier;
-import org.opendaylight.yanglib.api.YangLibRestAppService;
+import org.opendaylight.yanglib.api.YangLibService;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.common.Uint32;
+import org.opendaylight.yangtools.yang.model.repo.api.MissingSchemaSourceException;
import org.opendaylight.yangtools.yang.model.repo.api.SchemaSourceRepresentation;
import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
+import org.opendaylight.yangtools.yang.model.repo.fs.FilesystemSchemaSourceCache;
import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
import org.opendaylight.yangtools.yang.model.repo.spi.SchemaListenerRegistration;
import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceListener;
+import org.opendaylight.yangtools.yang.parser.api.YangParserFactory;
import org.opendaylight.yangtools.yang.parser.repo.SharedSchemaRepository;
-import org.osgi.framework.BundleContext;
-import org.osgi.framework.FrameworkUtil;
-import org.osgi.framework.ServiceReference;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
+import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.metatype.annotations.AttributeDefinition;
+import org.osgi.service.metatype.annotations.Designate;
+import org.osgi.service.metatype.annotations.ObjectClassDefinition;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-
/**
* Listens on new schema sources registered event. For each new source
* registered generates URL representing its schema source and write this URL
* along with source identifier to
* ietf-netconf-yang-library/modules-state/module list.
*/
-public class YangLibProvider implements BindingAwareProvider, AutoCloseable, SchemaSourceListener{
+@Singleton
+@Component(service = YangLibService.class, configurationPid = "org.opendaylight.netconf.yanglib")
+@Designate(ocd = YangLibProvider.Configuration.class)
+public final class YangLibProvider implements YangLibService, SchemaSourceListener, AutoCloseable {
+ @ObjectClassDefinition
+ public @interface Configuration {
+ @AttributeDefinition(min = "1",
+ description = "Local filesystem folder to use as cache + to load yang models from")
+ @NonNull String cache$_$folder() default "cache/schema";
+
+ @AttributeDefinition(
+ description = "Binding address is necessary for generating proper URLS (accessible from the outside world) "
+ + "for models present directly in the library")
+ @NonNull String binding$_$address() default "localhost";
+
+ @AttributeDefinition(required = true, min = "1", max = "65535",
+ description = "binding port is necessary for generating proper URLS (accessible from the outside world) "
+ + "for models present directly in the library")
+ int binding$_$port() default 8181;
+ }
+
private static final Logger LOG = LoggerFactory.getLogger(YangLibProvider.class);
- private static final OptionalRevision NO_REVISION = new OptionalRevision("");
private static final Predicate<PotentialSchemaSource<?>> YANG_SCHEMA_SOURCE =
- input -> YangTextSchemaSource.class.isAssignableFrom(input.getRepresentation());
+ input -> YangTextSchemaSource.class.isAssignableFrom(input.getRepresentation());
- protected DataBroker dataBroker;
- protected SchemaListenerRegistration schemaListenerRegistration;
- protected final SharedSchemaRepository schemaRepository;
+ private final DataBroker dataBroker;
private final String bindingAddress;
- private final long bindingPort;
+ private final Uint32 bindingPort;
+ private final SharedSchemaRepository schemaRepository;
+
+ private final SchemaListenerRegistration schemaListenerRegistration;
+
+ @Inject
+ @Activate
+ public YangLibProvider(@Reference final @NonNull DataBroker dataBroker,
+ @Reference final @NonNull YangParserFactory parserFactory, final @NonNull Configuration configuration) {
+ this(dataBroker, parserFactory, configuration.cache$_$folder(), configuration.binding$_$address(),
+ Uint32.valueOf(configuration.binding$_$port()));
+ }
- public YangLibProvider(final SharedSchemaRepository schemaRepository,
- final String bindingAddress, final long bindingPort) {
- this.schemaRepository = schemaRepository;
+ @VisibleForTesting
+ YangLibProvider(final @NonNull DataBroker dataBroker, final @NonNull YangParserFactory parserFactory,
+ final @NonNull String cacheFolder, final @NonNull String bindingAddress,
+ final @NonNull Uint32 bindingPort) {
this.bindingAddress = bindingAddress;
this.bindingPort = bindingPort;
- }
+ this.dataBroker = requireNonNull(dataBroker);
+
+ final File cacheFolderFile = new File(cacheFolder);
+ if (cacheFolderFile.exists()) {
+ LOG.info("cache-folder {} already exists", cacheFolderFile);
+ } else {
+ checkArgument(cacheFolderFile.mkdirs(), "cache-folder %s cannot be created", cacheFolderFile);
+ LOG.info("cache-folder {} was created", cacheFolderFile);
+ }
+ checkArgument(cacheFolderFile.isDirectory(), "cache-folder %s is not a directory", cacheFolderFile);
- @Override
- public void close() throws Exception {
- dataBroker = null;
- schemaListenerRegistration.close();
+ schemaRepository = new SharedSchemaRepository("yang-library", parserFactory);
+ final var cache = new FilesystemSchemaSourceCache<>(schemaRepository, YangTextSchemaSource.class,
+ cacheFolderFile);
+ schemaRepository.registerSchemaSourceListener(cache);
+
+ schemaListenerRegistration = schemaRepository.registerSchemaSourceListener(this);
+
+ LOG.info("Started yang library with sources from {}", cacheFolderFile);
}
+ @PreDestroy
+ @Deactivate
@Override
- public void onSessionInitiated(final BindingAwareBroker.ProviderContext providerContext) {
- this.dataBroker = providerContext.getSALService(DataBroker.class);
- schemaListenerRegistration = schemaRepository.registerSchemaSourceListener(this);
- getObjectFromBundleContext(YangLibRestAppService.class, YangLibRestAppService.class.getName())
- .getYangLibService().setSchemaRepository(schemaRepository);
+ public void close() {
+ schemaListenerRegistration.close();
}
@Override
@Override
public void schemaSourceRegistered(final Iterable<PotentialSchemaSource<?>> sources) {
- final List<Module> newModules = new ArrayList<>();
-
- for(PotentialSchemaSource<?> potentialYangSource : Iterables.filter(sources, YANG_SCHEMA_SOURCE)) {
- final YangIdentifier moduleName = new YangIdentifier(potentialYangSource.getSourceIdentifier().getName());
+ final var newModules = new HashMap<ModuleKey, Module>();
- final OptionalRevision moduleRevision = getRevisionForModule(potentialYangSource.getSourceIdentifier());
+ for (var potentialYangSource : Iterables.filter(sources, YANG_SCHEMA_SOURCE::test)) {
+ final var moduleName = new YangIdentifier(potentialYangSource.getSourceIdentifier().name().getLocalName());
- final Module newModule = new ModuleBuilder()
+ final var newModule = new ModuleBuilder()
.setName(moduleName)
- .setRevision(moduleRevision)
+ .setRevision(LegacyRevisionUtils.fromYangCommon(
+ Optional.ofNullable(potentialYangSource.getSourceIdentifier().revision())))
.setSchema(getUrlForModule(potentialYangSource.getSourceIdentifier()))
.build();
- newModules.add(newModule);
+ newModules.put(newModule.key(), newModule);
}
- if(newModules.isEmpty()) {
+ if (newModules.isEmpty()) {
// If no new yang modules then do nothing
return;
}
tx.merge(LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.create(ModulesState.class),
new ModulesStateBuilder().setModule(newModules).build());
- Futures.addCallback(tx.submit(), new FutureCallback<Void>() {
+ tx.commit().addCallback(new FutureCallback<CommitInfo>() {
@Override
- public void onSuccess(@Nullable final Void result) {
+ public void onSuccess(final CommitInfo result) {
LOG.debug("Modules state successfully populated with new modules");
}
@Override
- public void onFailure(final Throwable t) {
- LOG.warn("Unable to update modules state", t);
+ public void onFailure(final Throwable throwable) {
+ LOG.warn("Unable to update modules state", throwable);
}
- });
+ }, MoreExecutors.directExecutor());
}
@Override
public void schemaSourceUnregistered(final PotentialSchemaSource<?> source) {
- if(!YANG_SCHEMA_SOURCE.apply(source)) {
+ if (!YANG_SCHEMA_SOURCE.test(source)) {
// if representation of potential schema source is not yang text schema source do nothing
// we do not want to delete this module entry from module list
return;
}
WriteTransaction tx = dataBroker.newWriteOnlyTransaction();
- tx.delete(LogicalDatastoreType.OPERATIONAL,
- InstanceIdentifier.create(ModulesState.class)
- .child(Module.class,
- new ModuleKey(
- new YangIdentifier(source.getSourceIdentifier().getName()),
- getRevisionForModule(source.getSourceIdentifier()))));
-
- Futures.addCallback(tx.submit(), new FutureCallback<Void>() {
+ tx.delete(LogicalDatastoreType.OPERATIONAL, InstanceIdentifier.create(ModulesState.class)
+ .child(Module.class, new ModuleKey(new YangIdentifier(source.getSourceIdentifier().name().getLocalName()),
+ LegacyRevisionUtils.fromYangCommon(Optional.ofNullable(source.getSourceIdentifier().revision())))));
+
+ tx.commit().addCallback(new FutureCallback<CommitInfo>() {
@Override
- public void onSuccess(@Nullable final Void result) {
+ public void onSuccess(final CommitInfo result) {
LOG.debug("Modules state successfully updated.");
}
@Override
- public void onFailure(final Throwable t) {
- LOG.warn("Unable to update modules state", t);
+ public void onFailure(final Throwable throwable) {
+ LOG.warn("Unable to update modules state", throwable);
}
- });
+ }, MoreExecutors.directExecutor());
}
+ @Override
+ public String getSchema(final String name, final String revision) {
+ LOG.debug("Attempting load for schema source {}:{}", name, revision);
+ return getYangModel(name, revision.isEmpty() ? null : revision);
+ }
-
- private Uri getUrlForModule(final SourceIdentifier sourceIdentifier) {
- return new Uri("http://" + bindingAddress + ':' + bindingPort + "/yanglib/schemas/"
- + sourceIdentifier.getName() + '/' + revString(sourceIdentifier));
+ @Override
+ public String getSchema(final String name) {
+ LOG.debug("Attempting load for schema source {}: no-revision", name);
+ return getYangModel(name, null);
}
- private static String revString(final SourceIdentifier id) {
- final String rev = id.getRevision();
- return rev == null || SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION.equals(rev) ? "" : rev;
+ private String getYangModel(final String name, final String revision) {
+ final var sourceId = new SourceIdentifier(name, revision);
+ final var yangTextSchemaFuture = schemaRepository.getSchemaSource(sourceId, YangTextSchemaSource.class);
+ try {
+ final var yangTextSchemaSource = yangTextSchemaFuture.get();
+ return yangTextSchemaSource.read();
+ } catch (ExecutionException e) {
+ if (e.getCause() instanceof MissingSchemaSourceException) {
+ throw new NotFoundException("Schema source " + sourceId + " not found", e);
+ }
+ throw new WebApplicationException("Unable to retrieve schema source " + sourceId, e);
+ } catch (IOException e) {
+ throw new WebApplicationException("Unable to read schema " + sourceId, e);
+ } catch (InterruptedException e) {
+ Thread.currentThread().interrupt();
+ throw new WebApplicationException("Retrieving schema source " + sourceId + " has been interrupted", e);
+ }
}
- private static OptionalRevision getRevisionForModule(final SourceIdentifier sourceIdentifier) {
- final String rev = sourceIdentifier.getRevision();
- return rev == null || SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION.equals(rev) ? NO_REVISION
- : new OptionalRevision(new RevisionIdentifier(rev));
+ private Uri getUrlForModule(final SourceIdentifier sourceIdentifier) {
+ return new Uri("http://" + bindingAddress + ':' + bindingPort + "/yanglib/schemas/"
+ + sourceIdentifier.name().getLocalName() + revString(sourceIdentifier));
}
- private <T> T getObjectFromBundleContext(final Class<T> type, final String serviceRefName) {
- final BundleContext bundleContext = FrameworkUtil.getBundle(getClass()).getBundleContext();
- final ServiceReference<?> serviceReference = bundleContext.getServiceReference(serviceRefName);
- return (T) bundleContext.getService(serviceReference);
+ private static String revString(final SourceIdentifier id) {
+ final var rev = id.revision();
+ return rev != null ? "/" + rev : "";
}
}
Code Review / netconf.git / blobdiff