restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/mdsal/MdsalRestconfServer.java

   1 /*
   2  * Copyright (c) 2023 PANTHEON.tech, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.restconf.server.mdsal;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.collect.ImmutableMap;
  14 import com.google.common.collect.Maps;
  15 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  16 import java.lang.invoke.MethodHandles;
  17 import java.lang.invoke.VarHandle;
  18 import java.net.URI;
  19 import java.time.format.DateTimeParseException;
  20 import java.util.List;
  21 import java.util.Locale;
  22 import javax.annotation.PreDestroy;
  23 import javax.inject.Inject;
  24 import javax.inject.Singleton;
  25 import org.eclipse.jdt.annotation.NonNull;
  26 import org.eclipse.jdt.annotation.Nullable;
  27 import org.opendaylight.mdsal.dom.api.DOMActionService;
  28 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  29 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  30 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  31 import org.opendaylight.restconf.api.ApiPath;
  32 import org.opendaylight.restconf.api.FormattableBody;
  33 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  34 import org.opendaylight.restconf.common.errors.RestconfFuture;
  35 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
  36 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy;
  37 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy.StrategyAndTail;
  38 import org.opendaylight.restconf.server.api.ChildBody;
  39 import org.opendaylight.restconf.server.api.CreateResourceResult;
  40 import org.opendaylight.restconf.server.api.DataGetResult;
  41 import org.opendaylight.restconf.server.api.DataPatchResult;
  42 import org.opendaylight.restconf.server.api.DataPostBody;
  43 import org.opendaylight.restconf.server.api.DataPostResult;
  44 import org.opendaylight.restconf.server.api.DataPutResult;
  45 import org.opendaylight.restconf.server.api.DataYangPatchResult;
  46 import org.opendaylight.restconf.server.api.DatabindContext;
  47 import org.opendaylight.restconf.server.api.InvokeResult;
  48 import org.opendaylight.restconf.server.api.ModulesGetResult;
  49 import org.opendaylight.restconf.server.api.OperationInputBody;
  50 import org.opendaylight.restconf.server.api.PatchBody;
  51 import org.opendaylight.restconf.server.api.ResourceBody;
  52 import org.opendaylight.restconf.server.api.RestconfServer;
  53 import org.opendaylight.restconf.server.api.ServerRequest;
  54 import org.opendaylight.restconf.server.spi.RpcImplementation;
  55 import org.opendaylight.yangtools.yang.common.Empty;
  56 import org.opendaylight.yangtools.yang.common.ErrorTag;
  57 import org.opendaylight.yangtools.yang.common.ErrorType;
  58 import org.opendaylight.yangtools.yang.common.QName;
  59 import org.opendaylight.yangtools.yang.common.Revision;
  60 import org.opendaylight.yangtools.yang.common.YangNames;
  61 import org.opendaylight.yangtools.yang.model.api.source.SourceIdentifier;
  62 import org.opendaylight.yangtools.yang.model.api.source.SourceRepresentation;
  63 import org.opendaylight.yangtools.yang.model.api.source.YangTextSource;
  64 import org.opendaylight.yangtools.yang.model.api.source.YinTextSource;
  65 import org.osgi.service.component.annotations.Activate;
  66 import org.osgi.service.component.annotations.Component;
  67 import org.osgi.service.component.annotations.Deactivate;
  68 import org.osgi.service.component.annotations.Reference;
  69 import org.osgi.service.component.annotations.ReferencePolicyOption;
  70
  71 /**
  72  * A RESTCONF server implemented on top of MD-SAL.
  73  */
  74 @Singleton
  75 @Component(service = RestconfServer.class)
  76 public final class MdsalRestconfServer implements RestconfServer, AutoCloseable {
  77     private static final VarHandle LOCAL_STRATEGY;
  78
  79     static {
  80         try {
  81             LOCAL_STRATEGY = MethodHandles.lookup()
  82                 .findVarHandle(MdsalRestconfServer.class, "localStrategy", MdsalRestconfStrategy.class);
  83         } catch (NoSuchFieldException | IllegalAccessException e) {
  84             throw new ExceptionInInitializerError(e);
  85         }
  86     }
  87
  88     private final @NonNull ImmutableMap<QName, RpcImplementation> localRpcs;
  89     private final @NonNull DOMMountPointService mountPointService;
  90     private final @NonNull MdsalDatabindProvider databindProvider;
  91     private final @NonNull DOMDataBroker dataBroker;
  92     private final @Nullable DOMRpcService rpcService;
  93     private final @Nullable DOMActionService actionService;
  94
  95     @SuppressFBWarnings(value = "URF_UNREAD_FIELD", justification = "https://github.com/spotbugs/spotbugs/issues/2749")
  96     private volatile MdsalRestconfStrategy localStrategy;
  97
  98     @Inject
  99     @Activate
 100     public MdsalRestconfServer(@Reference final MdsalDatabindProvider databindProvider,
 101             @Reference final DOMDataBroker dataBroker, @Reference final DOMRpcService rpcService,
 102             @Reference final DOMActionService actionService,
 103             @Reference final DOMMountPointService mountPointService,
 104             @Reference(policyOption = ReferencePolicyOption.GREEDY) final List<RpcImplementation> localRpcs) {
 105         this.databindProvider = requireNonNull(databindProvider);
 106         this.dataBroker = requireNonNull(dataBroker);
 107         this.rpcService = requireNonNull(rpcService);
 108         this.actionService = requireNonNull(actionService);
 109         this.mountPointService = requireNonNull(mountPointService);
 110
 111         this.localRpcs = Maps.uniqueIndex(localRpcs, RpcImplementation::qname);
 112         localStrategy = createLocalStrategy(databindProvider.currentDatabind());
 113     }
 114
 115     public MdsalRestconfServer(final MdsalDatabindProvider databindProvider, final DOMDataBroker dataBroker,
 116             final DOMRpcService rpcService, final DOMActionService actionService,
 117             final DOMMountPointService mountPointService, final RpcImplementation... localRpcs) {
 118         this(databindProvider, dataBroker, rpcService, actionService, mountPointService, List.of(localRpcs));
 119     }
 120
 121     private @NonNull MdsalRestconfStrategy createLocalStrategy(final DatabindContext databind) {
 122         return new MdsalRestconfStrategy(databind, dataBroker, localRpcs, rpcService, actionService,
 123             databindProvider.sourceProvider(), mountPointService);
 124     }
 125
 126     private @NonNull MdsalRestconfStrategy localStrategy() {
 127         final var strategy = verifyNotNull((@NonNull MdsalRestconfStrategy) LOCAL_STRATEGY.getAcquire(this));
 128         final var databind = databindProvider.currentDatabind();
 129         return databind.equals(strategy.databind()) ? strategy : updateLocalStrategy(databind);
 130     }
 131
 132     private @NonNull MdsalRestconfStrategy updateLocalStrategy(final DatabindContext databind) {
 133         final var strategy = createLocalStrategy(databind);
 134         localStrategy = strategy;
 135         return strategy;
 136     }
 137
 138     @PreDestroy
 139     @Deactivate
 140     @Override
 141     public void close() {
 142         localStrategy = null;
 143     }
 144
 145     @Override
 146     public RestconfFuture<Empty> dataDELETE(final ServerRequest request, final ApiPath identifier) {
 147         final StrategyAndTail stratAndTail;
 148         try {
 149             stratAndTail = localStrategy().resolveStrategy(identifier);
 150         } catch (RestconfDocumentedException e) {
 151             return RestconfFuture.failed(e);
 152         }
 153         return stratAndTail.strategy().dataDELETE(request, stratAndTail.tail());
 154     }
 155
 156     @Override
 157     public RestconfFuture<DataGetResult> dataGET(final ServerRequest request) {
 158         return localStrategy().dataGET(request, ApiPath.empty());
 159     }
 160
 161     @Override
 162     public RestconfFuture<DataGetResult> dataGET(final ServerRequest request, final ApiPath identifier) {
 163         final StrategyAndTail stratAndTail;
 164         try {
 165             stratAndTail = localStrategy().resolveStrategy(identifier);
 166         } catch (RestconfDocumentedException e) {
 167             return RestconfFuture.failed(e);
 168         }
 169         return stratAndTail.strategy().dataGET(request, stratAndTail.tail());
 170     }
 171
 172     @Override
 173     public RestconfFuture<DataPatchResult> dataPATCH(final ServerRequest request, final ResourceBody body) {
 174         return localStrategy().dataPATCH(ApiPath.empty(), body);
 175     }
 176
 177     @Override
 178     public RestconfFuture<DataPatchResult> dataPATCH(final ServerRequest request, final ApiPath identifier,
 179             final ResourceBody body) {
 180         final StrategyAndTail strategyAndTail;
 181         try {
 182             strategyAndTail = localStrategy().resolveStrategy(identifier);
 183         } catch (RestconfDocumentedException e) {
 184             return RestconfFuture.failed(e);
 185         }
 186         return strategyAndTail.strategy().dataPATCH(strategyAndTail.tail(), body);
 187     }
 188
 189     @Override
 190     public RestconfFuture<DataYangPatchResult> dataPATCH(final ServerRequest request, final PatchBody body) {
 191         return localStrategy().dataPATCH(ApiPath.empty(), body);
 192     }
 193
 194     @Override
 195     public RestconfFuture<DataYangPatchResult> dataPATCH(final ServerRequest request, final ApiPath identifier,
 196             final PatchBody body) {
 197         final StrategyAndTail strategyAndTail;
 198         try {
 199             strategyAndTail = localStrategy().resolveStrategy(identifier);
 200         } catch (RestconfDocumentedException e) {
 201             return RestconfFuture.failed(e);
 202         }
 203         return strategyAndTail.strategy().dataPATCH(strategyAndTail.tail(), body);
 204     }
 205
 206     @Override
 207     public RestconfFuture<CreateResourceResult> dataPOST(final ServerRequest request, final ChildBody body) {
 208         return localStrategy().dataCreatePOST(request, body);
 209     }
 210
 211     @Override
 212     public RestconfFuture<? extends DataPostResult> dataPOST(final ServerRequest request, final ApiPath identifier,
 213             final DataPostBody body) {
 214         final StrategyAndTail strategyAndTail;
 215         try {
 216             strategyAndTail = localStrategy().resolveStrategy(identifier);
 217         } catch (RestconfDocumentedException e) {
 218             return RestconfFuture.failed(e);
 219         }
 220         return strategyAndTail.strategy().dataPOST(request, strategyAndTail.tail(), body);
 221     }
 222
 223     @Override
 224     public RestconfFuture<DataPutResult> dataPUT(final ServerRequest request, final ResourceBody body) {
 225         return localStrategy().dataPUT(request, ApiPath.empty(), body);
 226     }
 227
 228     @Override
 229     public RestconfFuture<DataPutResult> dataPUT(final ServerRequest request, final ApiPath identifier,
 230             final ResourceBody body) {
 231         final StrategyAndTail strategyAndTail;
 232         try {
 233             strategyAndTail = localStrategy().resolveStrategy(identifier);
 234         } catch (RestconfDocumentedException e) {
 235             return RestconfFuture.failed(e);
 236         }
 237         return strategyAndTail.strategy().dataPUT(request, strategyAndTail.tail(), body);
 238     }
 239
 240     @Override
 241     public RestconfFuture<ModulesGetResult> modulesYangGET(final ServerRequest request, final String fileName,
 242             final String revision) {
 243         return modulesGET(fileName, revision, YangTextSource.class);
 244     }
 245
 246     @Override
 247     public RestconfFuture<ModulesGetResult> modulesYangGET(final ServerRequest request, final ApiPath mountPath,
 248             final String fileName, final String revision) {
 249         return modulesGET(mountPath, fileName, revision, YangTextSource.class);
 250     }
 251
 252     @Override
 253     public RestconfFuture<ModulesGetResult> modulesYinGET(final ServerRequest request, final String fileName,
 254             final String revision) {
 255         return modulesGET(fileName, revision, YinTextSource.class);
 256     }
 257
 258     @Override
 259     public RestconfFuture<ModulesGetResult> modulesYinGET(final ServerRequest request, final ApiPath mountPath,
 260             final String fileName, final String revision) {
 261         return modulesGET(mountPath, fileName, revision, YinTextSource.class);
 262     }
 263
 264     private @NonNull RestconfFuture<ModulesGetResult> modulesGET(final String fileName, final String revision,
 265             final Class<? extends SourceRepresentation> representation) {
 266         return modulesGET(localStrategy(), fileName, revision, representation);
 267     }
 268
 269     private @NonNull RestconfFuture<ModulesGetResult> modulesGET(final ApiPath mountPath, final String fileName,
 270             final String revision, final Class<? extends SourceRepresentation> representation) {
 271         final var mountOffset = mountPath.indexOf("yang-ext", "mount");
 272         if (mountOffset != mountPath.steps().size() - 1) {
 273             return RestconfFuture.failed(new RestconfDocumentedException("Mount path has to end with yang-ext:mount"));
 274         }
 275
 276         final StrategyAndTail stratAndTail;
 277         try {
 278             stratAndTail = localStrategy().resolveStrategy(mountPath);
 279         } catch (RestconfDocumentedException e) {
 280             return RestconfFuture.failed(e);
 281         }
 282         // FIXME: require remnant to be empty
 283         return modulesGET(stratAndTail.strategy(), fileName, revision, representation);
 284     }
 285
 286     private static @NonNull RestconfFuture<ModulesGetResult> modulesGET(final RestconfStrategy strategy,
 287             final String moduleName, final String revisionStr,
 288             final Class<? extends SourceRepresentation> representation) {
 289         if (moduleName == null) {
 290             return RestconfFuture.failed(new RestconfDocumentedException("Module name must be supplied",
 291                 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
 292         }
 293         if (moduleName.isEmpty() || !YangNames.IDENTIFIER_START.matches(moduleName.charAt(0))) {
 294             return RestconfFuture.failed(new RestconfDocumentedException(
 295                 "Identifier must start with character from set 'a-zA-Z_", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
 296         }
 297         if (moduleName.toUpperCase(Locale.ROOT).startsWith("XML")) {
 298             return RestconfFuture.failed(new RestconfDocumentedException(
 299                 "Identifier must NOT start with XML ignore case", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
 300         }
 301         if (YangNames.NOT_IDENTIFIER_PART.matchesAnyOf(moduleName.substring(1))) {
 302             return RestconfFuture.failed(new RestconfDocumentedException(
 303                 "Supplied name has not expected identifier format", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
 304         }
 305
 306         // YANG Revision-compliant string is required
 307         final Revision revision;
 308         try {
 309             revision = Revision.ofNullable(revisionStr).orElse(null);
 310         } catch (final DateTimeParseException e) {
 311             return RestconfFuture.failed(new RestconfDocumentedException(
 312                 "Supplied revision is not in expected date format YYYY-mm-dd",
 313                 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, e));
 314         }
 315
 316         return strategy.resolveSource(new SourceIdentifier(moduleName, revision), representation)
 317             .transform(ModulesGetResult::new);
 318     }
 319
 320     @Override
 321     public RestconfFuture<FormattableBody> operationsGET(final ServerRequest request) {
 322         return localStrategy().operationsGET(request);
 323     }
 324
 325     @Override
 326     public RestconfFuture<FormattableBody> operationsGET(final ServerRequest request, final ApiPath operation) {
 327         final StrategyAndTail strategyAndTail;
 328         try {
 329             strategyAndTail = localStrategy().resolveStrategy(operation);
 330         } catch (RestconfDocumentedException e) {
 331             return RestconfFuture.failed(e);
 332         }
 333
 334         final var strategy = strategyAndTail.strategy();
 335         final var tail = strategyAndTail.tail();
 336         return tail.isEmpty() ? strategy.operationsGET(request) : strategy.operationsGET(request, tail);
 337     }
 338
 339     @Override
 340     public RestconfFuture<InvokeResult> operationsPOST(final ServerRequest request, final URI restconfURI,
 341             final ApiPath apiPath, final OperationInputBody body) {
 342         final StrategyAndTail strategyAndTail;
 343         try {
 344             strategyAndTail = localStrategy().resolveStrategy(apiPath);
 345         } catch (RestconfDocumentedException e) {
 346             return RestconfFuture.failed(e);
 347         }
 348         final var strategy = strategyAndTail.strategy();
 349         return strategy.operationsPOST(request, restconfURI, strategyAndTail.tail(), body);
 350     }
 351
 352     @Override
 353     public RestconfFuture<FormattableBody> yangLibraryVersionGET(final ServerRequest request) {
 354         return localStrategy().yangLibraryVersionGET(request);
 355     }
 356 }