models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/ActorService.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ActorService
   4  * ================================================================================
   5  * Copyright (C) 2017-2018, 2020 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2019 Nordix Foundation.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.controlloop.actorserviceprovider;
  23
  24 import com.google.common.collect.ImmutableMap;
  25 import java.util.Collection;
  26 import java.util.HashMap;
  27 import java.util.Iterator;
  28 import java.util.Map;
  29 import java.util.ServiceConfigurationError;
  30 import java.util.ServiceLoader;
  31 import java.util.Set;
  32 import org.onap.policy.common.parameters.BeanValidationResult;
  33 import org.onap.policy.controlloop.actorserviceprovider.impl.StartConfigPartial;
  34 import org.onap.policy.controlloop.actorserviceprovider.parameters.ParameterValidationRuntimeException;
  35 import org.onap.policy.controlloop.actorserviceprovider.spi.Actor;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 /**
  40  * Service that manages a set of actors. To use the service, first invoke
  41  * {@link #configure(Map)} to configure all of the actors, and then invoke
  42  * {@link #start()} to start all of the actors. When finished using the actor service,
  43  * invoke {@link #stop()} or {@link #shutdown()}.
  44  */
  45 public class ActorService extends StartConfigPartial<Map<String, Object>> {
  46     private static final Logger logger = LoggerFactory.getLogger(ActorService.class);
  47
  48     private final Map<String, Actor> name2actor;
  49
  50     /**
  51      * Constructs the object and loads the list of actors.
  52      */
  53     public ActorService() {
  54         super("actors");
  55
  56         Map<String, Actor> map = new HashMap<>();
  57
  58         Iterator<Actor> iter = loadActors().iterator();
  59         while (iter.hasNext()) {
  60
  61             Actor newActor;
  62             try {
  63                 newActor = iter.next();
  64             } catch (ServiceConfigurationError e) {
  65                 logger.warn("unable to load actor", e);
  66                 continue;
  67             }
  68
  69             map.compute(newActor.getName(), (name, existingActor) -> {
  70                 if (existingActor == null) {
  71                     return newActor;
  72                 }
  73
  74                 logger.warn("duplicate actor names for {}: {}, ignoring {}", name,
  75                                 existingActor.getClass().getSimpleName(), newActor.getClass().getSimpleName());
  76                 return existingActor;
  77             });
  78         }
  79
  80         name2actor = ImmutableMap.copyOf(map);
  81     }
  82
  83     /**
  84      * Gets a particular actor.
  85      *
  86      * @param name name of the actor of interest
  87      * @return the desired actor
  88      * @throws IllegalArgumentException if no actor by the given name exists
  89      */
  90     public Actor getActor(String name) {
  91         Actor actor = name2actor.get(name);
  92         if (actor == null) {
  93             throw new IllegalArgumentException("unknown actor " + name);
  94         }
  95
  96         return actor;
  97     }
  98
  99     /**
 100      * Gets the actors.
 101      *
 102      * @return the actors
 103      */
 104     public Collection<Actor> getActors() {
 105         return name2actor.values();
 106     }
 107
 108     /**
 109      * Gets the names of the actors.
 110      *
 111      * @return the actor names
 112      */
 113     public Set<String> getActorNames() {
 114         return name2actor.keySet();
 115     }
 116
 117     @Override
 118     protected void doConfigure(Map<String, Object> parameters) {
 119         logger.info("configuring actors");
 120
 121         BeanValidationResult valres = new BeanValidationResult("ActorService", parameters);
 122
 123         for (Actor actor : name2actor.values()) {
 124             String actorName = actor.getName();
 125             Object paramValue = parameters.get(actorName);
 126
 127             if (paramValue instanceof Map) {
 128                 @SuppressWarnings("unchecked")
 129                 Map<String, Object> subparams = (Map<String, Object>) paramValue;
 130
 131                 try {
 132                     actor.configure(subparams);
 133
 134                 } catch (ParameterValidationRuntimeException e) {
 135                     logger.warn("failed to configure actor {}", actorName, e);
 136                     valres.addResult(e.getResult());
 137
 138                 } catch (RuntimeException e) {
 139                     logger.warn("failed to configure actor {}", actorName, e);
 140                 }
 141
 142             } else if (actor.isConfigured()) {
 143                 logger.warn("missing configuration parameters for actor {}; using previous parameters", actorName);
 144
 145             } else {
 146                 logger.warn("missing configuration parameters for actor {}; actor cannot be started", actorName);
 147             }
 148         }
 149
 150         if (!valres.isValid() && logger.isWarnEnabled()) {
 151             logger.warn("actor services validation errors:\n{}", valres.getResult());
 152         }
 153     }
 154
 155     @Override
 156     protected void doStart() {
 157         logger.info("starting actors");
 158
 159         for (Actor actor : name2actor.values()) {
 160             if (actor.isConfigured()) {
 161                 Util.runFunction(actor::start, "failed to start actor {}", actor.getName());
 162
 163             } else {
 164                 logger.warn("not starting unconfigured actor {}", actor.getName());
 165             }
 166         }
 167     }
 168
 169     @Override
 170     protected void doStop() {
 171         logger.info("stopping actors");
 172         name2actor.values().forEach(actor -> Util.runFunction(actor::stop, "failed to stop actor {}", actor.getName()));
 173     }
 174
 175     @Override
 176     protected void doShutdown() {
 177         logger.info("shutting down actors");
 178
 179         // @formatter:off
 180         name2actor.values().forEach(
 181             actor -> Util.runFunction(actor::shutdown, "failed to shutdown actor {}", actor.getName()));
 182
 183         // @formatter:on
 184     }
 185
 186     // the following methods may be overridden by junit tests
 187
 188     protected Iterable<Actor> loadActors() {
 189         return ServiceLoader.load(Actor.class);
 190     }
 191 }