dom/mdsal-dom-spi/src/main/java/org/opendaylight/mdsal/dom/spi/SimpleDOMActionResult.java

   1 /*
   2  * Copyright (c) 2018 Pantheon Technologies, 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.mdsal.dom.spi;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.base.MoreObjects;
  14 import com.google.common.collect.ImmutableList;
  15 import java.util.Collection;
  16 import java.util.Optional;
  17 import org.eclipse.jdt.annotation.NonNull;
  18 import org.eclipse.jdt.annotation.Nullable;
  19 import org.opendaylight.mdsal.dom.api.DOMActionResult;
  20 import org.opendaylight.yangtools.concepts.Immutable;
  21 import org.opendaylight.yangtools.yang.common.ErrorTag;
  22 import org.opendaylight.yangtools.yang.common.ErrorType;
  23 import org.opendaylight.yangtools.yang.common.RpcError;
  24 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  25 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  26
  27 @Beta
  28 public final class SimpleDOMActionResult implements DOMActionResult, Immutable {
  29     private final @NonNull Collection<RpcError> errors;
  30     private final @Nullable ContainerNode output;
  31
  32     private SimpleDOMActionResult(final @NonNull Collection<RpcError> errors, final @Nullable ContainerNode output) {
  33         this.errors = ImmutableList.copyOf(errors);
  34         this.output = output;
  35     }
  36
  37     public SimpleDOMActionResult(final @NonNull ContainerNode output) {
  38         errors = ImmutableList.of();
  39         this.output = requireNonNull(output);
  40     }
  41
  42     public SimpleDOMActionResult(final @NonNull Collection<RpcError> errors) {
  43         this(errors, null);
  44     }
  45
  46     public SimpleDOMActionResult(final @NonNull ContainerNode output, final @NonNull Collection<RpcError> errors) {
  47         this(errors, requireNonNull(output));
  48     }
  49
  50     // As per RFC7950 page 80 (top)
  51     public static @NonNull SimpleDOMActionResult ofMalformedMessage(final @NonNull Exception cause) {
  52         return new SimpleDOMActionResult(ImmutableList.of(RpcResultBuilder.newError(ErrorType.RPC,
  53             ErrorTag.MALFORMED_MESSAGE, cause.getMessage(), null, null, requireNonNull(cause))), null);
  54     }
  55
  56     @Override
  57     public Collection<RpcError> getErrors() {
  58         return errors;
  59     }
  60
  61     @Override
  62     public Optional<ContainerNode> getOutput() {
  63         return Optional.ofNullable(output);
  64     }
  65
  66     @Override
  67     public String toString() {
  68         final var helper = MoreObjects.toStringHelper(this).omitNullValues().add("output", output);
  69         if (!errors.isEmpty()) {
  70             helper.add("errors", errors);
  71         }
  72         return helper.toString();
  73     }
  74 }