2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2018 Samsung Electronics Co., Ltd. All rights reserved.
6 * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
20 * SPDX-License-Identifier: Apache-2.0
21 * ============LICENSE_END=========================================================
24 package org.onap.policy.api.main.startstop;
26 import org.onap.policy.api.main.exception.PolicyApiException;
27 import org.onap.policy.api.main.parameters.ApiParameterGroup;
28 import org.onap.policy.api.main.rest.ApiRestController;
29 import org.onap.policy.api.main.rest.LegacyApiRestController;
30 import org.onap.policy.api.main.rest.aaf.AafApiFilter;
31 import org.onap.policy.common.endpoints.http.server.RestServer;
32 import org.onap.policy.common.parameters.ParameterService;
33 import org.slf4j.Logger;
34 import org.slf4j.LoggerFactory;
37 * This class wraps a distributor so that it can be activated as a complete service together with all its api and
38 * forwarding handlers.
40 public class ApiActivator {
42 private static final Logger LOGGER = LoggerFactory.getLogger(ApiActivator.class);
44 private final ApiParameterGroup apiParameterGroup;
46 private static boolean alive = false;
48 private RestServer restServer;
51 * Instantiate the activator for policy api as a complete service.
53 * @param apiParameterGroup the parameters for the api service
55 public ApiActivator(final ApiParameterGroup apiParameterGroup) {
56 this.apiParameterGroup = apiParameterGroup;
60 * Initialize api as a complete service.
62 * @throws PolicyApiException on errors in initializing the service
64 public void initialize() throws PolicyApiException {
65 LOGGER.debug("Policy api starting as a service . . .");
67 registerToParameterService(apiParameterGroup);
68 ApiActivator.setAlive(true);
69 LOGGER.debug("Policy api started as a service");
73 * Starts the api rest server using configuration parameters.
75 * @throws PolicyApiException if server start fails
77 private void startApiRestServer() throws PolicyApiException {
78 apiParameterGroup.getRestServerParameters().setName(apiParameterGroup.getName());
79 restServer = new RestServer(apiParameterGroup.getRestServerParameters(), AafApiFilter.class,
80 LegacyApiRestController.class, ApiRestController.class);
81 if (!restServer.start()) {
82 throw new PolicyApiException("Failed to start api rest server. Check log for more details...");
87 * Terminate policy api.
89 * @throws PolicyApiException on termination errors
91 public void terminate() throws PolicyApiException {
93 deregisterToParameterService(apiParameterGroup);
95 if (ApiActivator.isAlive()) {
96 ApiActivator.setAlive(false);
99 // Stop the api rest server
100 if (restServer.isAlive()) {
103 } catch (final Exception exp) {
104 throw new PolicyApiException("Policy api service termination failed", exp);
109 * Get the parameters used by the activator.
111 * @return the parameters of the activator
113 public ApiParameterGroup getParameterGroup() {
114 return apiParameterGroup;
118 * Method to register the parameters to Common Parameter Service.
120 * @param apiParameterGroup the api parameter group
122 public void registerToParameterService(final ApiParameterGroup apiParameterGroup) {
123 ParameterService.register(apiParameterGroup, true);
127 * Method to deregister the parameters from Common Parameter Service.
129 * @param apiParameterGroup the api parameter group
131 public void deregisterToParameterService(final ApiParameterGroup apiParameterGroup) {
132 if (ParameterService.contains(apiParameterGroup.getName())) {
133 ParameterService.deregister(apiParameterGroup.getName());
138 * Returns the alive status of api service.
142 public static boolean isAlive() {
147 * Change the alive status of api service.
149 * @param status the status
151 public static void setAlive(final boolean status) {