aboutsummaryrefslogtreecommitdiffstats
path: root/utils/src/main/java/org/onap/policy/common/utils/services/ServiceManagerContainer.java
blob: 6afc1ab01e36d78b1910814b30b24e80a10865c2 (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
/*
 * ============LICENSE_START=======================================================
 * ONAP
 * ================================================================================
 * 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 org.onap.policy.common.capabilities.Startable;
import org.onap.policy.common.utils.services.ServiceManager.RunnableWithEx;

/**
 * Container, of a service manager, that implements a {@link Startable} interface by
 * delegating to the contained service manager. This allows subclasses to add actions to
 * the service manager, while preventing other classes from doing so.
 */
public class ServiceManagerContainer implements Startable {

    /**
     * The contained manager.
     */
    private final ServiceManager serviceManager;

    /**
     * Constructs the object, with a default name.
     */
    public ServiceManagerContainer() {
        serviceManager = new ServiceManager();
    }

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

    public String getName() {
        return serviceManager.getName();
    }

    /**
     * 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
     */
    protected void addAction(String stepName, RunnableWithEx starter, RunnableWithEx stopper) {
        serviceManager.addAction(stepName, starter, stopper);
    }

    /**
     * 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
     */
    protected void addService(String stepName, Startable service) {
        serviceManager.addService(stepName, service);
    }

    @Override
    public boolean isAlive() {
        return serviceManager.isAlive();
    }

    @Override
    public boolean start() {
        return serviceManager.start();
    }

    @Override
    public boolean stop() {
        return serviceManager.stop();
    }

    @Override
    public void shutdown() {
        serviceManager.shutdown();
    }
}