main/src/main/java/org/onap/policy/pdpx/main/startstop/XacmlPdpActivator.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.pdpx.main.startstop;
  22
  23 import java.nio.file.Paths;
  24 import java.util.Arrays;
  25 import lombok.Getter;
  26 import lombok.Setter;
  27 import org.onap.policy.common.endpoints.event.comm.TopicEndpointManager;
  28 import org.onap.policy.common.endpoints.event.comm.TopicSource;
  29 import org.onap.policy.common.endpoints.event.comm.client.TopicSinkClient;
  30 import org.onap.policy.common.endpoints.event.comm.client.TopicSinkClientException;
  31 import org.onap.policy.common.endpoints.listeners.MessageTypeDispatcher;
  32 import org.onap.policy.common.parameters.ParameterService;
  33 import org.onap.policy.common.utils.services.ServiceManagerContainer;
  34 import org.onap.policy.models.pdp.concepts.PdpStatus;
  35 import org.onap.policy.models.pdp.enums.PdpMessageType;
  36 import org.onap.policy.pdpx.main.PolicyXacmlPdpRuntimeException;
  37 import org.onap.policy.pdpx.main.XacmlState;
  38 import org.onap.policy.pdpx.main.comm.XacmlPdpHearbeatPublisher;
  39 import org.onap.policy.pdpx.main.comm.listeners.XacmlPdpStateChangeListener;
  40 import org.onap.policy.pdpx.main.comm.listeners.XacmlPdpUpdateListener;
  41 import org.onap.policy.pdpx.main.parameters.XacmlPdpParameterGroup;
  42 import org.onap.policy.pdpx.main.rest.XacmlPdpAafFilter;
  43 import org.onap.policy.pdpx.main.rest.XacmlPdpApplicationManager;
  44 import org.onap.policy.pdpx.main.rest.XacmlPdpRestController;
  45 import org.onap.policy.pdpx.main.rest.XacmlPdpStatisticsManager;
  46 import org.slf4j.Logger;
  47 import org.slf4j.LoggerFactory;
  48
  49 /**
  50  * This class wraps a distributor so that it can be activated as a complete service together with
  51  * all its xacml pdp and forwarding handlers.
  52  */
  53 public class XacmlPdpActivator extends ServiceManagerContainer {
  54
  55     // The logger for this class
  56     private static final Logger LOGGER = LoggerFactory.getLogger(XacmlPdpActivator.class);
  57
  58     private static final String[] MSG_TYPE_NAMES = {"messageName"};
  59     private static final String TOPIC = "POLICY-PDP-PAP";
  60
  61     @Getter
  62     @Setter
  63     private static XacmlPdpActivator current = null;
  64     private final XacmlPdpRestServer restServer;
  65
  66     // The parameters of this policy xacml pdp activator
  67     private final XacmlPdpParameterGroup xacmlPdpParameterGroup;
  68
  69     /**
  70      * Listens for messages on the topic, decodes them into a {@link PdpStatus} message, and then
  71      * dispatches them to appropriate listener.
  72      */
  73     private final MessageTypeDispatcher msgDispatcher;
  74
  75     /**
  76      * Instantiate the activator for policy xacml pdp as a complete service.
  77      *
  78      * @param xacmlPdpParameterGroup the parameters for the xacml pdp service
  79      */
  80     public XacmlPdpActivator(final XacmlPdpParameterGroup xacmlPdpParameterGroup) {
  81         LOGGER.info("Activator initializing using {}", xacmlPdpParameterGroup);
  82
  83         TopicEndpointManager.getManager().addTopics(xacmlPdpParameterGroup.getTopicParameterGroup());
  84
  85         final XacmlPdpHearbeatPublisher heartbeat;
  86         final TopicSinkClient sinkClient;
  87         final XacmlState state;
  88
  89         try {
  90             XacmlPdpApplicationManager appmgr =
  91                             new XacmlPdpApplicationManager(Paths.get(xacmlPdpParameterGroup.getApplicationPath()),
  92                                     xacmlPdpParameterGroup.getPolicyApiParameters());
  93             XacmlPdpApplicationManager.setCurrent(appmgr);
  94
  95             XacmlPdpStatisticsManager stats = new XacmlPdpStatisticsManager();
  96             XacmlPdpStatisticsManager.setCurrent(stats);
  97             stats.setTotalPolicyTypesCount(appmgr.getPolicyTypeCount());
  98             stats.setTotalPolicyCount(appmgr.getPolicyCount());
  99
 100             state = new XacmlState(appmgr, xacmlPdpParameterGroup.getPdpGroup());
 101
 102             this.xacmlPdpParameterGroup = xacmlPdpParameterGroup;
 103             this.msgDispatcher = new MessageTypeDispatcher(MSG_TYPE_NAMES);
 104
 105             sinkClient = new TopicSinkClient(TOPIC);
 106             heartbeat = new XacmlPdpHearbeatPublisher(sinkClient, state);
 107
 108             /*
 109              * since the dispatcher isn't registered with the topic yet, we can go ahead
 110              * and register the listeners with it.
 111              */
 112             msgDispatcher.register(PdpMessageType.PDP_STATE_CHANGE.name(),
 113                             new XacmlPdpStateChangeListener(sinkClient, state));
 114             msgDispatcher.register(PdpMessageType.PDP_UPDATE.name(),
 115                             new XacmlPdpUpdateListener(sinkClient, state, heartbeat, appmgr));
 116
 117             restServer = new XacmlPdpRestServer(xacmlPdpParameterGroup.getRestServerParameters(),
 118                     XacmlPdpAafFilter.class, XacmlPdpRestController.class);
 119
 120         } catch (RuntimeException | TopicSinkClientException e) {
 121             throw new PolicyXacmlPdpRuntimeException(e.getMessage(), e);
 122         }
 123
 124         xacmlPdpParameterGroup.getRestServerParameters().setName(xacmlPdpParameterGroup.getName());
 125
 126         // @formatter:off
 127         addAction("XACML PDP parameters",
 128             () -> ParameterService.register(xacmlPdpParameterGroup),
 129             () -> ParameterService.deregister(xacmlPdpParameterGroup.getName()));
 130
 131         addAction("Message Dispatcher",
 132             this::registerMsgDispatcher,
 133             this::unregisterMsgDispatcher);
 134
 135         addAction("topics",
 136             TopicEndpointManager.getManager()::start,
 137             TopicEndpointManager.getManager()::shutdown);
 138
 139         addAction("Terminate PDP",
 140             () -> { },
 141             () -> sendTerminateMessage(sinkClient, state));
 142         // initial heart beats act as registration messages
 143         addAction("Heartbeat Publisher",
 144             heartbeat::start,
 145             heartbeat::terminate);
 146
 147         // @formatter:on
 148     }
 149
 150     /*
 151      * Method used to send a terminate message to the PAP.
 152      */
 153     private void sendTerminateMessage(TopicSinkClient sinkClient, XacmlState state) {
 154         PdpStatus terminateStatus = state.terminatePdpMessage();
 155         sinkClient.send(terminateStatus);
 156     }
 157
 158     /**
 159      * Get the parameters used by the activator.
 160      *
 161      * @return the parameters of the activator
 162      */
 163     public XacmlPdpParameterGroup getParameterGroup() {
 164         return xacmlPdpParameterGroup;
 165     }
 166
 167     /**
 168      * Method to register the parameters to Common Parameter Service.
 169      *
 170      * @param xacmlPdpParameterGroup the xacml pdp parameter group
 171      */
 172     public void registerToParameterService(final XacmlPdpParameterGroup xacmlPdpParameterGroup) {
 173         ParameterService.register(xacmlPdpParameterGroup);
 174     }
 175
 176     /**
 177      * Method to deregister the parameters from Common Parameter Service.
 178      *
 179      * @param xacmlPdpParameterGroup the xacml pdp parameter group
 180      */
 181     public void deregisterToParameterService(final XacmlPdpParameterGroup xacmlPdpParameterGroup) {
 182         ParameterService.deregister(xacmlPdpParameterGroup.getName());
 183     }
 184
 185     /**
 186      * Registers the dispatcher with the topic source(s).
 187      */
 188     private void registerMsgDispatcher() {
 189         for (TopicSource source : TopicEndpointManager.getManager().getTopicSources(Arrays.asList(TOPIC))) {
 190             source.register(msgDispatcher);
 191         }
 192     }
 193
 194     /**
 195      * Unregisters the dispatcher from the topic source(s).
 196      */
 197     private void unregisterMsgDispatcher() {
 198         for (TopicSource source : TopicEndpointManager.getManager().getTopicSources(Arrays.asList(TOPIC))) {
 199             source.unregister(msgDispatcher);
 200         }
 201     }
 202
 203     /**
 204      * Start the xacmlpdp rest controller.
 205      */
 206     public void startXacmlRestController() {
 207         if (isXacmlRestControllerAlive()) {
 208             LOGGER.info("Xacml rest controller already running");
 209         } else {
 210             restServer.start();
 211         }
 212     }
 213
 214     /**
 215      * Stop the xacmlpdp rest controller.
 216      */
 217     public void stopXacmlRestController() {
 218         if (isXacmlRestControllerAlive()) {
 219             restServer.stop();
 220         } else {
 221             LOGGER.info("Xacml rest controller already stopped");
 222         }
 223     }
 224
 225     public boolean isXacmlRestControllerAlive() {
 226         return restServer.isAlive();
 227     }
 228 }