aboutsummaryrefslogtreecommitdiffstats
path: root/services/services-onappf/src/main/java/org/onap/policy/apex/starter/ApexStarterActivator.java
blob: a6bd702aa86d66d092a9b88a25661350647adfd9 (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
/*-
 * ============LICENSE_START=======================================================
 *  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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.apex.starter;

import java.util.List;
import java.util.Properties;

import lombok.Getter;
import lombok.Setter;

import org.onap.policy.apex.starter.comm.PdpStateChangeListener;
import org.onap.policy.apex.starter.comm.PdpStatusPublisher;
import org.onap.policy.apex.starter.comm.PdpUpdateListener;
import org.onap.policy.apex.starter.exception.ApexStarterException;
import org.onap.policy.apex.starter.exception.ApexStarterRunTimeException;
import org.onap.policy.apex.starter.handler.PdpMessageHandler;
import org.onap.policy.apex.starter.parameters.ApexStarterParameterGroup;
import org.onap.policy.common.endpoints.event.comm.TopicEndpoint;
import org.onap.policy.common.endpoints.event.comm.TopicSink;
import org.onap.policy.common.endpoints.event.comm.TopicSource;
import org.onap.policy.common.endpoints.listeners.MessageTypeDispatcher;
import org.onap.policy.common.utils.services.Registry;
import org.onap.policy.common.utils.services.ServiceManager;
import org.onap.policy.common.utils.services.ServiceManagerException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This class activates the ApexStarter as a complete service together with all its handlers.
 *
 * @author Ajith Sreekumar (ajith.sreekumar@est.tech)
 */
public class ApexStarterActivator {

    private static final Logger LOGGER = LoggerFactory.getLogger(ApexStarterActivator.class);
    private final ApexStarterParameterGroup apexStarterParameterGroup;
    private List<TopicSink> topicSinks;// topics to which apex-pdp sends pdp status
    private List<TopicSource> topicSources; // topics to which apex-pdp listens to for messages from pap.
    private static final String[] MSG_TYPE_NAMES = { "messageName" };
    /**
     * Listens for messages on the topic, decodes them into a message, and then dispatches them.
     */
    private final MessageTypeDispatcher msgDispatcher;

    /**
     * Used to manage the services.
     */
    private ServiceManager manager;

    @Getter
    @Setter(lombok.AccessLevel.PRIVATE)
    private volatile boolean alive = false;

    public ApexStarterActivator(final ApexStarterParameterGroup apexStarterParameterGroup,
            final Properties topicProperties) {

        topicSinks = TopicEndpoint.manager.addTopicSinks(topicProperties);
        topicSources = TopicEndpoint.manager.addTopicSources(topicProperties);

        // TODO: instanceId currently set as a random string, could be fetched from actual deployment
        final int random = (int) (Math.random() * 100);
        final String instanceId = "apex_" + random;

        try {
            this.apexStarterParameterGroup = apexStarterParameterGroup;
            this.msgDispatcher = new MessageTypeDispatcher(MSG_TYPE_NAMES);
        } catch (final RuntimeException e) {
            throw new ApexStarterRunTimeException(e);
        }

        final PdpUpdateListener pdpUpdateListener = new PdpUpdateListener();
        final PdpStateChangeListener pdpStateChangeListener = new PdpStateChangeListener();
        // @formatter:off
        this.manager = new ServiceManager()
                .addAction("topics",
                        () -> TopicEndpoint.manager.start(),
                        () -> TopicEndpoint.manager.shutdown())
                .addAction("set alive",
                        () -> setAlive(true),
                        () -> setAlive(false))
                .addAction("register pdp status context object",
                        () -> Registry.register(ApexStarterConstants.REG_PDP_STATUS_OBJECT,
                                new PdpMessageHandler().createPdpStatusFromParameters(instanceId,
                                        apexStarterParameterGroup.getPdpStatusParameters())),
                        () -> Registry.unregister(ApexStarterConstants.REG_PDP_STATUS_OBJECT))
                .addAction("topic sinks",
                        () -> Registry.register(ApexStarterConstants.REG_APEX_PDP_TOPIC_SINKS, topicSinks),
                        () -> Registry.unregister(ApexStarterConstants.REG_APEX_PDP_TOPIC_SINKS))
                .addAction("Pdp Status publisher",
                        () -> Registry.register(ApexStarterConstants.REG_PDP_STATUS_PUBLISHER,
                                new PdpStatusPublisher(topicSinks,
                                        apexStarterParameterGroup.getPdpStatusParameters().getTimeIntervalMs())),
                        () -> stopAndRemovePdpStatusPublisher())
                .addAction("Register pdp update listener",
                    () -> msgDispatcher.register("PDP_UPDATE", pdpUpdateListener),
                    () -> msgDispatcher.unregister("PDP_UPDATE"))
                .addAction("Register pdp state change request dispatcher",
                        () -> msgDispatcher.register("PDP_STATE_CHANGE", pdpStateChangeListener),
                        () -> msgDispatcher.unregister("PDP_STATE_CHANGE"))
                .addAction("Message Dispatcher",
                    () -> registerMsgDispatcher(),
                    () -> unregisterMsgDispatcher());
        // @formatter:on
    }

    /**
     * Method to stop and unregister the pdp status publisher.
     */
    private void stopAndRemovePdpStatusPublisher() {
        final PdpStatusPublisher pdpStatusPublisher =
                Registry.get(ApexStarterConstants.REG_PDP_STATUS_PUBLISHER, PdpStatusPublisher.class);
        // send a final heartbeat with terminated status
        pdpStatusPublisher.send(new PdpMessageHandler().getTerminatedPdpStatus());
        pdpStatusPublisher.terminate();
        Registry.unregister(ApexStarterConstants.REG_PDP_STATUS_PUBLISHER);
    }

    /**
     * Initialize ApexStarter service.
     *
     * @throws ApexStarterException on errors in initializing the service
     */
    public void initialize() throws ApexStarterException {
        if (isAlive()) {
            throw new IllegalStateException("activator already initialized");
        }

        try {
            LOGGER.debug("ApexStarter starting as a service . . .");
            manager.start();
            LOGGER.debug("ApexStarter started as a service");
        } catch (final ServiceManagerException exp) {
            LOGGER.error("ApexStarter service startup failed");
            throw new ApexStarterException(exp.getMessage(), exp);
        }
    }

    /**
     * Terminate ApexStarter.
     *
     * @throws ApexStarterException on errors in terminating the service
     */
    public void terminate() throws ApexStarterException {
        if (!isAlive()) {
            throw new IllegalStateException("activator is not running");
        }
        try {
            manager.stop();
            Registry.unregister(ApexStarterConstants.REG_APEX_STARTER_ACTIVATOR);
        } catch (final ServiceManagerException exp) {
            LOGGER.error("ApexStarter termination failed");
            throw new ApexStarterException(exp.getMessage(), exp);
        }
    }

    /**
     * Get the parameters used by the activator.
     *
     * @return the parameters of the activator
     */
    public ApexStarterParameterGroup getParameterGroup() {
        return apexStarterParameterGroup;
    }

    /**
     * Registers the dispatcher with the topic source(s).
     */
    private void registerMsgDispatcher() {
        for (final TopicSource source : topicSources) {
            source.register(msgDispatcher);
        }
    }

    /**
     * Unregisters the dispatcher from the topic source(s).
     */
    private void unregisterMsgDispatcher() {
        for (final TopicSource source : topicSources) {
            source.unregister(msgDispatcher);
        }
    }
}