opendaylight/md-sal/eos-dom-akka/src/main/java/org/opendaylight/controller/eos/akka/owner/supervisor/command/GetEntitiesReply.java

   1 /*
   2  * Copyright (c) 2021 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.controller.eos.akka.owner.supervisor.command;
   9
  10 import static com.google.common.base.Verify.verify;
  11
  12 import com.google.common.collect.ImmutableMap;
  13 import com.google.common.collect.ImmutableSetMultimap;
  14 import com.google.common.collect.ImmutableSetMultimap.Builder;
  15 import com.google.common.collect.Iterables;
  16 import java.io.Serializable;
  17 import java.util.HashSet;
  18 import java.util.Map;
  19 import java.util.Map.Entry;
  20 import java.util.Set;
  21 import java.util.stream.Collectors;
  22 import org.eclipse.jdt.annotation.NonNull;
  23 import org.opendaylight.mdsal.binding.dom.codec.api.BindingInstanceIdentifierCodec;
  24 import org.opendaylight.mdsal.eos.dom.api.DOMEntity;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.entity.owners.norev.EntityName;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.entity.owners.norev.EntityType;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.entity.owners.norev.GetEntitiesOutput;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.entity.owners.norev.GetEntitiesOutputBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.entity.owners.norev.NodeName;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.entity.owners.norev.get.entities.output.EntitiesBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.mdsal.core.general.entity.rev150930.Entity;
  32 import org.opendaylight.yangtools.yang.binding.util.BindingMap;
  33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  35
  36 public final class GetEntitiesReply extends OwnerSupervisorReply implements Serializable {
  37     private static final long serialVersionUID = 1L;
  38
  39     private final ImmutableSetMultimap<DOMEntity, String> candidates;
  40     private final ImmutableMap<DOMEntity, String> owners;
  41
  42     public GetEntitiesReply(final Map<DOMEntity, String> owners, final Map<DOMEntity, Set<String>> candidates) {
  43         final Builder<DOMEntity, String> builder = ImmutableSetMultimap.builder();
  44         for (Entry<DOMEntity, Set<String>> entry : candidates.entrySet()) {
  45             builder.putAll(entry.getKey(), entry.getValue());
  46         }
  47         this.candidates = builder.build();
  48         this.owners = ImmutableMap.copyOf(owners);
  49     }
  50
  51     public @NonNull GetEntitiesOutput toOutput(final BindingInstanceIdentifierCodec iidCodec) {
  52         final Set<DOMEntity> entities = new HashSet<>();
  53         entities.addAll(owners.keySet());
  54         entities.addAll(candidates.keySet());
  55
  56         return new GetEntitiesOutputBuilder()
  57             .setEntities(entities.stream()
  58                 .map(entity -> {
  59                     final EntitiesBuilder eb = new EntitiesBuilder()
  60                         .setType(new EntityType(entity.getType()))
  61                         .setName(extractName(entity, iidCodec))
  62                         .setCandidateNodes(candidates.get(entity).stream()
  63                             .map(NodeName::new).collect(Collectors.toUnmodifiableList()));
  64
  65                     final String owner = owners.get(entity);
  66                     if (owner != null) {
  67                         eb.setOwnerNode(new NodeName(owner));
  68                     }
  69                     return eb.build();
  70                 })
  71                 .collect(BindingMap.toMap()))
  72             .build();
  73     }
  74
  75     /**
  76      * if the entity is general entity then shorthand the name to only the last path argument, otherwise return
  77      * full YIID path encoded as string.
  78      *
  79      * @param entity Entity to extract the name from
  80      * @param iidCodec codec to encode entity name back to InstanceIdentifier if needed
  81      * @return Extracted name
  82      */
  83     private static EntityName extractName(final DOMEntity entity, final BindingInstanceIdentifierCodec iidCodec) {
  84         final var id = entity.getIdentifier();
  85         if (id.isEmpty() || !id.getPathArguments().get(0).getNodeType().equals(Entity.QNAME)) {
  86             return new EntityName(iidCodec.toBinding(id));
  87         }
  88
  89         final PathArgument last = id.getLastPathArgument();
  90         verify(last instanceof NodeIdentifierWithPredicates, "Unexpected last argument %s", last);
  91         final Object value = Iterables.getOnlyElement(((NodeIdentifierWithPredicates) last).values());
  92         verify(value instanceof String, "Unexpected predicate value %s", value);
  93         return new EntityName((String) value);
  94     }
  95 }