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