aboutsummaryrefslogtreecommitdiffstats
path: root/utils/src/main/java/org/onap/policy/common/utils/services/ServiceManager.java
blob: 13cd6de8c1391680038c8c3398b493eff2f5dd2b (plain)
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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/*
 * ============LICENSE_START=======================================================
 * ONAP PAP
 * ================================================================================
 * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * 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.common.utils.services;

import java.util.Deque;
import java.util.Iterator;
import java.util.LinkedList;
import org.onap.policy.common.capabilities.Startable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Manages a series of services. The services are started in order, and stopped in reverse
 * order.
 */
public class ServiceManager implements Startable {
    private static final Logger logger = LoggerFactory.getLogger(ServiceManager.class);

    /**
     * Manager name.
     */
    private final String name;

    /**
     * Services to be started/stopped.
     */
    private final Deque<Service> items = new LinkedList<>();

    /**
     * {@code True} if the services are currently running, {@code false} otherwise.
     */
    private boolean running;

    /**
     * Constructs the object, with a default name.
     */
    public ServiceManager() {
        this("service manager");
    }

    /**
     * Constructs the object.
     * @param name the manager's name, used for logging purposes
     */
    public ServiceManager(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    /**
     * Adds a pair of service actions to the manager.
     *
     * @param stepName name to be logged when the service is started/stopped
     * @param starter function to start the service
     * @param stopper function to stop the service
     * @return this manager
     */
    public synchronized ServiceManager addAction(String stepName, RunnableWithEx starter, RunnableWithEx stopper) {
        if (running) {
            throw new IllegalStateException(name + " is already running; cannot add " + stepName);
        }

        items.add(new Service(stepName, starter, stopper));
        return this;
    }

    /**
     * Adds a service to the manager. The manager will invoke the service's
     * {@link Startable#start()} and {@link Startable#stop()} methods.
     *
     * @param stepName name to be logged when the service is started/stopped
     * @param service object to be started/stopped
     * @return this manager
     */
    public synchronized ServiceManager addService(String stepName, Startable service) {
        if (running) {
            throw new IllegalStateException(name + " is already running; cannot add " + stepName);
        }

        items.add(new Service(stepName, () -> service.start(), () -> service.stop()));
        return this;
    }

    @Override
    public synchronized boolean isAlive() {
        return running;
    }

    @Override
    public synchronized boolean start() {
        if (running) {
            throw new IllegalStateException(name + " is already running");
        }

        logger.info("{} starting", name);

        // tracks the services that have been started so far
        Deque<Service> started = new LinkedList<>();
        Exception ex = null;

        for (Service item : items) {
            try {
                logger.info("{} starting {}", name, item.stepName);
                item.starter.run();
                started.add(item);

            } catch (Exception e) {
                logger.error("{} failed to start {}; rewinding steps", name, item.stepName);
                ex = e;
                break;
            }
        }

        if (ex == null) {
            logger.info("{} started", name);
            running = true;
            return true;
        }

        // one of the services failed to start - rewind those we've previously started
        try {
            rewind(started);

        } catch (ServiceManagerException e) {
            logger.error("{} rewind failed", name, e);
        }

        throw new ServiceManagerException(ex);
    }

    @Override
    public synchronized boolean stop() {
        if (!running) {
            throw new IllegalStateException(name + " is not running");
        }

        running = false;
        rewind(items);

        return true;
    }

    @Override
    public void shutdown() {
        stop();
    }

    /**
     * Rewinds a list of services, stopping them in reverse order. Stops all of the
     * services, even if one of the "stop" functions throws an exception.
     *
     * @param running services that are running, in the order they were started
     * @throws ServiceManagerException if a service fails to stop
     */
    private void rewind(Deque<Service> running) throws ServiceManagerException {
        Exception ex = null;

        logger.info("{} stopping", name);

        // stop everything, in reverse order
        Iterator<Service> it = running.descendingIterator();
        while (it.hasNext()) {
            Service item = it.next();
            try {
                logger.info("{} stopping {}", name, item.stepName);
                item.stopper.run();
            } catch (Exception e) {
                logger.error("{} failed to stop {}", name, item.stepName);
                ex = e;

                // do NOT break or re-throw, as we must stop ALL remaining items
            }
        }

        logger.info("{} stopped", name);

        if (ex != null) {
            throw new ServiceManagerException(ex);
        }
    }

    /**
     * Service information.
     */
    private static class Service {
        private String stepName;
        private RunnableWithEx starter;
        private RunnableWithEx stopper;

        public Service(String stepName, RunnableWithEx starter, RunnableWithEx stopper) {
            this.stepName = stepName;
            this.starter = starter;
            this.stopper = stopper;
        }
    }

    @FunctionalInterface
    public static interface RunnableWithEx {
        void run() throws Exception;
    }
}