aboutsummaryrefslogtreecommitdiffstats
path: root/main/src/main/java/org/onap/policy/distribution/main/startstop/DistributionActivator.java
blob: 6121034360d4e136cfaf8a7bb7612328a6152ab3 (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
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2018 Ericsson. All rights reserved.
 *  Copyright (C) 2019 Nordix Foundation.
 *  Modifications Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.
 *  Modifications Copyright (C) 2021 Bell Canada. 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.distribution.main.startstop;

import java.lang.reflect.InvocationTargetException;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;
import lombok.Getter;
import lombok.Setter;
import org.onap.policy.common.endpoints.http.server.RestServer;
import org.onap.policy.common.parameters.ParameterService;
import org.onap.policy.distribution.main.PolicyDistributionException;
import org.onap.policy.distribution.main.parameters.DistributionParameterGroup;
import org.onap.policy.distribution.main.parameters.PolicyForwarderConfigurationParameterGroup;
import org.onap.policy.distribution.main.rest.DistributionRestController;
import org.onap.policy.distribution.main.rest.aaf.AafDistributionFilter;
import org.onap.policy.distribution.reception.decoding.PluginInitializationException;
import org.onap.policy.distribution.reception.handling.AbstractReceptionHandler;
import org.onap.policy.distribution.reception.parameters.PolicyDecoderConfigurationParameterGroup;
import org.onap.policy.distribution.reception.parameters.ReceptionHandlerConfigurationParameterGroup;
import org.onap.policy.distribution.reception.parameters.ReceptionHandlerParameters;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This class wraps a distributor so that it can be activated as a complete service together with all its distribution
 * and forwarding handlers.
 */
public class DistributionActivator {

    private static final Logger LOGGER = LoggerFactory.getLogger(DistributionActivator.class);

    // The parameters of this policy distribution activator
    @Getter
    private final DistributionParameterGroup distributionParameterGroup;

    // The map of reception handlers initialized by this distribution activator
    private final Map<String, AbstractReceptionHandler> receptionHandlersMap = new HashMap<>();

    @Getter
    @Setter
    private static boolean alive = false;

    private RestServer restServer;

    /**
     * Instantiate the activator for policy distribution as a complete service.
     *
     * @param distributionParameterGroup the parameters for the distribution service
     */
    public DistributionActivator(final DistributionParameterGroup distributionParameterGroup) {
        this.distributionParameterGroup = distributionParameterGroup;
    }

    /**
     * Initialize distribution as a complete service.
     *
     * @throws PolicyDistributionException on errors in initializing the service
     */
    @SuppressWarnings("unchecked")
    public void initialize() throws PolicyDistributionException {
        LOGGER.debug("Policy distribution starting as a service . . .");
        startDistributionRestServer();
        registerToParameterService(distributionParameterGroup);
        for (final ReceptionHandlerParameters receptionHandlerParameters : distributionParameterGroup
                .getReceptionHandlerParameters().values()) {
            try {
                final Class<AbstractReceptionHandler> receptionHandlerClass = (Class<AbstractReceptionHandler>) Class
                        .forName(receptionHandlerParameters.getReceptionHandlerClassName());
                final AbstractReceptionHandler receptionHandler =
                        receptionHandlerClass.getDeclaredConstructor().newInstance();
                receptionHandler.initialize(receptionHandlerParameters.getName());
                receptionHandlersMap.put(receptionHandlerParameters.getName(), receptionHandler);
                DistributionActivator.setAlive(true);
            } catch (final ClassNotFoundException | InstantiationException | IllegalAccessException
                    | PluginInitializationException | IllegalArgumentException | InvocationTargetException
                    | NoSuchMethodException | SecurityException exp) {
                throw new PolicyDistributionException(exp.getMessage(), exp);
            }
        }
        LOGGER.debug("Policy distribution started as a service");
    }

    /**
     * Starts the distribution rest server using configuration parameters.
     *
     * @throws PolicyDistributionException if server start fails
     */
    private void startDistributionRestServer() throws PolicyDistributionException {
        distributionParameterGroup.getRestServerParameters().setName(distributionParameterGroup.getName());
        restServer = new RestServer(distributionParameterGroup.getRestServerParameters(), AafDistributionFilter.class,
                        DistributionRestController.class);
        if (!restServer.start()) {
            throw new PolicyDistributionException(
                    "Failed to start distribution rest server. Check log for more details...");
        }
    }

    /**
     * Terminate policy distribution.
     *
     * @throws PolicyDistributionException on termination errors
     */
    public void terminate() throws PolicyDistributionException {
        try {
            for (final AbstractReceptionHandler handler : receptionHandlersMap.values()) {
                handler.destroy();
            }
            receptionHandlersMap.clear();
            deregisterToParameterService(distributionParameterGroup);
            DistributionActivator.setAlive(false);

            // Stop the distribution rest server
            restServer.stop();
        } catch (final Exception exp) {
            throw new PolicyDistributionException(exp.getMessage(), exp);
        }
    }

    /**
     * Method to register the parameters to Common Parameter Service.
     *
     * @param distributionParameterGroup the distribution parameter group
     */
    public void registerToParameterService(final DistributionParameterGroup distributionParameterGroup) {
        ParameterService.register(distributionParameterGroup);
        for (final ReceptionHandlerParameters params : distributionParameterGroup.getReceptionHandlerParameters()
                .values()) {
            params.setName(distributionParameterGroup.getName());
            params.getPluginHandlerParameters().setName(distributionParameterGroup.getName());
            ParameterService.register(params);
            ParameterService.register(params.getPluginHandlerParameters());
        }
        //@formatter:off
        for (final Entry<String, PolicyForwarderConfigurationParameterGroup> forwarderConfiguration
                : distributionParameterGroup.getPolicyForwarderConfigurationParameters().entrySet()) {
            forwarderConfiguration.getValue().setName(forwarderConfiguration.getKey());
            ParameterService.register(forwarderConfiguration.getValue());
        }
        for (final Entry<String, ReceptionHandlerConfigurationParameterGroup> receptionHandlerConfiguration
                : distributionParameterGroup.getReceptionHandlerConfigurationParameters().entrySet()) {
            receptionHandlerConfiguration.getValue().setName(receptionHandlerConfiguration.getKey());
            ParameterService.register(receptionHandlerConfiguration.getValue());
        }
        for (final Entry<String, PolicyDecoderConfigurationParameterGroup> decoderConfiguration
                : distributionParameterGroup.getPolicyDecoderConfigurationParameters().entrySet()) {
            decoderConfiguration.getValue().setName(decoderConfiguration.getKey());
            ParameterService.register(decoderConfiguration.getValue());
        }
        //@formatter:on
    }

    /**
     * Method to deregister the parameters from Common Parameter Service.
     *
     * @param distributionParameterGroup the distribution parameter group
     */
    public void deregisterToParameterService(final DistributionParameterGroup distributionParameterGroup) {
        ParameterService.deregister(distributionParameterGroup.getName());
        for (final ReceptionHandlerParameters params : distributionParameterGroup.getReceptionHandlerParameters()
                .values()) {
            ParameterService.deregister((params.getName()));
            ParameterService.deregister((params.getPluginHandlerParameters().getName()));
        }
        //@formatter:off
        for (final Entry<String, PolicyForwarderConfigurationParameterGroup> forwarderConfiguration
                : distributionParameterGroup.getPolicyForwarderConfigurationParameters().entrySet()) {
            forwarderConfiguration.getValue().setName(forwarderConfiguration.getKey());
            ParameterService.deregister(forwarderConfiguration.getKey());
        }
        for (final Entry<String, ReceptionHandlerConfigurationParameterGroup> receptionHandlerConfiguration
                : distributionParameterGroup.getReceptionHandlerConfigurationParameters().entrySet()) {
            receptionHandlerConfiguration.getValue().setName(receptionHandlerConfiguration.getKey());
            ParameterService.deregister(receptionHandlerConfiguration.getKey());
        }
        for (final Entry<String, PolicyDecoderConfigurationParameterGroup> decoderConfiguration
                : distributionParameterGroup.getPolicyDecoderConfigurationParameters().entrySet()) {
            decoderConfiguration.getValue().setName(decoderConfiguration.getKey());
            ParameterService.deregister(decoderConfiguration.getKey());
        }
        //@formatter:on
    }
}