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.nb.rfc8040.rests.transactions.MdsalRestconfStrategy;
  35 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy;
  36 import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy.StrategyAndTail;
  37 import org.opendaylight.restconf.server.api.ChildBody;
  38 import org.opendaylight.restconf.server.api.CreateResourceResult;
  39 import org.opendaylight.restconf.server.api.DataGetResult;
  40 import org.opendaylight.restconf.server.api.DataPatchResult;
  41 import org.opendaylight.restconf.server.api.DataPostBody;
  42 import org.opendaylight.restconf.server.api.DataPostResult;
  43 import org.opendaylight.restconf.server.api.DataPutResult;
  44 import org.opendaylight.restconf.server.api.DataYangPatchResult;
  45 import org.opendaylight.restconf.server.api.DatabindContext;
  46 import org.opendaylight.restconf.server.api.InvokeResult;
  47 import org.opendaylight.restconf.server.api.ModulesGetResult;
  48 import org.opendaylight.restconf.server.api.OperationInputBody;
  49 import org.opendaylight.restconf.server.api.PatchBody;
  50 import org.opendaylight.restconf.server.api.ResourceBody;
  51 import org.opendaylight.restconf.server.api.RestconfServer;
  52 import org.opendaylight.restconf.server.api.ServerException;
  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 void dataDELETE(final ServerRequest<Empty> request, final ApiPath identifier) {
 147         final StrategyAndTail stratAndTail;
 148         try {
 149             stratAndTail = localStrategy().resolveStrategy(identifier);
 150         } catch (ServerException e) {
 151             request.completeWith(e);
 152             return;
 153         }
 154         stratAndTail.strategy().dataDELETE(request, stratAndTail.tail());
 155     }
 156
 157     @Override
 158     public void dataGET(final ServerRequest<DataGetResult> request) {
 159         localStrategy().dataGET(request, ApiPath.empty());
 160     }
 161
 162     @Override
 163     public void dataGET(final ServerRequest<DataGetResult> request, final ApiPath identifier) {
 164         final StrategyAndTail stratAndTail;
 165         try {
 166             stratAndTail = localStrategy().resolveStrategy(identifier);
 167         } catch (ServerException e) {
 168             request.completeWith(e);
 169             return;
 170         }
 171         stratAndTail.strategy().dataGET(request, stratAndTail.tail());
 172     }
 173
 174     @Override
 175     public void dataPATCH(final ServerRequest<DataPatchResult> request, final ResourceBody body) {
 176         localStrategy().dataPATCH(request, ApiPath.empty(), body);
 177     }
 178
 179     @Override
 180     public void dataPATCH(final ServerRequest<DataPatchResult> request, final ApiPath identifier,
 181             final ResourceBody body) {
 182         final StrategyAndTail strategyAndTail;
 183         try {
 184             strategyAndTail = localStrategy().resolveStrategy(identifier);
 185         } catch (ServerException e) {
 186             request.completeWith(e);
 187             return;
 188         }
 189         strategyAndTail.strategy().dataPATCH(request, strategyAndTail.tail(), body);
 190     }
 191
 192     @Override
 193     public void dataPATCH(final ServerRequest<DataYangPatchResult> request, final PatchBody body) {
 194         localStrategy().dataPATCH(request, ApiPath.empty(), body);
 195     }
 196
 197     @Override
 198     public void dataPATCH(final ServerRequest<DataYangPatchResult> request, final ApiPath identifier,
 199             final PatchBody body) {
 200         final StrategyAndTail strategyAndTail;
 201         try {
 202             strategyAndTail = localStrategy().resolveStrategy(identifier);
 203         } catch (ServerException e) {
 204             request.completeWith(e);
 205             return;
 206         }
 207         strategyAndTail.strategy().dataPATCH(request, strategyAndTail.tail(), body);
 208     }
 209
 210     @Override
 211     public void dataPOST(final ServerRequest<CreateResourceResult> request, final ChildBody body) {
 212         localStrategy().dataCreatePOST(request, body);
 213     }
 214
 215     @Override
 216     public void dataPOST(final ServerRequest<DataPostResult> request, final ApiPath identifier,
 217             final DataPostBody body) {
 218         final StrategyAndTail strategyAndTail;
 219         try {
 220             strategyAndTail = localStrategy().resolveStrategy(identifier);
 221         } catch (ServerException e) {
 222             request.completeWith(e);
 223             return;
 224         }
 225         strategyAndTail.strategy().dataPOST(request, strategyAndTail.tail(), body);
 226     }
 227
 228     @Override
 229     public void dataPUT(final ServerRequest<DataPutResult> request, final ResourceBody body) {
 230         localStrategy().dataPUT(request, ApiPath.empty(), body);
 231     }
 232
 233     @Override
 234     public void dataPUT(final ServerRequest<DataPutResult> request, final ApiPath identifier, final ResourceBody body) {
 235         final StrategyAndTail strategyAndTail;
 236         try {
 237             strategyAndTail = localStrategy().resolveStrategy(identifier);
 238         } catch (ServerException e) {
 239             request.completeWith(e);
 240             return ;
 241         }
 242         strategyAndTail.strategy().dataPUT(request, strategyAndTail.tail(), body);
 243     }
 244
 245     @Override
 246     public void modulesYangGET(final ServerRequest<ModulesGetResult> request, final String fileName,
 247             final String revision) {
 248         modulesGET(request, fileName, revision, YangTextSource.class);
 249     }
 250
 251     @Override
 252     public void modulesYangGET(final ServerRequest<ModulesGetResult> request, final ApiPath mountPath,
 253             final String fileName, final String revision) {
 254         modulesGET(request, mountPath, fileName, revision, YangTextSource.class);
 255     }
 256
 257     @Override
 258     public void modulesYinGET(final ServerRequest<ModulesGetResult> request, final String fileName,
 259             final String revision) {
 260         modulesGET(request, fileName, revision, YinTextSource.class);
 261     }
 262
 263     @Override
 264     public void modulesYinGET(final ServerRequest<ModulesGetResult> request, final ApiPath mountPath,
 265             final String fileName, final String revision) {
 266         modulesGET(request, mountPath, fileName, revision, YinTextSource.class);
 267     }
 268
 269     private void modulesGET(final ServerRequest<ModulesGetResult> request, final String fileName, final String revision,
 270             final Class<? extends SourceRepresentation> representation) {
 271         modulesGET(request, localStrategy(), fileName, revision, representation);
 272     }
 273
 274     private void modulesGET(final ServerRequest<ModulesGetResult> request, final ApiPath mountPath,
 275             final String fileName, final String revision, final Class<? extends SourceRepresentation> representation) {
 276         final var mountOffset = mountPath.indexOf("yang-ext", "mount");
 277         if (mountOffset != mountPath.steps().size() - 1) {
 278             request.completeWith(new RestconfDocumentedException("Mount path has to end with yang-ext:mount"));
 279             return;
 280         }
 281
 282         final StrategyAndTail stratAndTail;
 283         try {
 284             stratAndTail = localStrategy().resolveStrategy(mountPath);
 285         } catch (ServerException e) {
 286             request.completeWith(e);
 287             return;
 288         }
 289         // FIXME: require remnant to be empty
 290         modulesGET(request, stratAndTail.strategy(), fileName, revision, representation);
 291     }
 292
 293     private static void modulesGET(final ServerRequest<ModulesGetResult> request, final RestconfStrategy strategy,
 294             final String moduleName, final String revisionStr,
 295             final Class<? extends SourceRepresentation> representation) {
 296         if (moduleName == null) {
 297             request.completeWith(new RestconfDocumentedException("Module name must be supplied",
 298                 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
 299             return;
 300         }
 301         if (moduleName.isEmpty() || !YangNames.IDENTIFIER_START.matches(moduleName.charAt(0))) {
 302             request.completeWith(new RestconfDocumentedException(
 303                 "Identifier must start with character from set 'a-zA-Z_", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
 304             return;
 305         }
 306         if (moduleName.toUpperCase(Locale.ROOT).startsWith("XML")) {
 307             request.completeWith(new RestconfDocumentedException(
 308                 "Identifier must NOT start with XML ignore case", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
 309             return;
 310         }
 311         if (YangNames.NOT_IDENTIFIER_PART.matchesAnyOf(moduleName.substring(1))) {
 312             request.completeWith(new RestconfDocumentedException(
 313                 "Supplied name has not expected identifier format", ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
 314             return;
 315         }
 316
 317         // YANG Revision-compliant string is required
 318         final Revision revision;
 319         try {
 320             revision = Revision.ofNullable(revisionStr).orElse(null);
 321         } catch (final DateTimeParseException e) {
 322             request.completeWith(new RestconfDocumentedException(
 323                 "Supplied revision is not in expected date format YYYY-mm-dd",
 324                 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, e));
 325             return;
 326         }
 327
 328         strategy.resolveSource(request, new SourceIdentifier(moduleName, revision), representation);
 329     }
 330
 331     @Override
 332     public void operationsGET(final ServerRequest<FormattableBody> request) {
 333         localStrategy().operationsGET(request);
 334     }
 335
 336     @Override
 337     public void operationsGET(final ServerRequest<FormattableBody> request, final ApiPath operation) {
 338         final StrategyAndTail strategyAndTail;
 339         try {
 340             strategyAndTail = localStrategy().resolveStrategy(operation);
 341         } catch (ServerException e) {
 342             request.completeWith(e);
 343             return;
 344         }
 345
 346         final var strategy = strategyAndTail.strategy();
 347         final var tail = strategyAndTail.tail();
 348         if (tail.isEmpty()) {
 349             strategy.operationsGET(request);
 350         } else {
 351             strategy.operationsGET(request, tail);
 352         }
 353     }
 354
 355     @Override
 356     public void operationsPOST(final ServerRequest<InvokeResult> request, final URI restconfURI, final ApiPath apiPath,
 357             final OperationInputBody body) {
 358         final StrategyAndTail strategyAndTail;
 359         try {
 360             strategyAndTail = localStrategy().resolveStrategy(apiPath);
 361         } catch (ServerException e) {
 362             request.completeWith(e);
 363             return;
 364         }
 365         strategyAndTail.strategy().operationsPOST(request, restconfURI, strategyAndTail.tail(), body);
 366     }
 367
 368     @Override
 369     public void yangLibraryVersionGET(final ServerRequest<FormattableBody> request) {
 370         localStrategy().yangLibraryVersionGET(request);
 371     }
 372 }