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 java.util.Properties;
  26 import lombok.Getter;
  27 import lombok.Setter;
  28 import org.onap.policy.common.endpoints.event.comm.TopicEndpoint;
  29 import org.onap.policy.common.endpoints.event.comm.TopicSource;
  30 import org.onap.policy.common.endpoints.event.comm.client.TopicSinkClient;
  31 import org.onap.policy.common.endpoints.event.comm.client.TopicSinkClientException;
  32 import org.onap.policy.common.endpoints.listeners.MessageTypeDispatcher;
  33 import org.onap.policy.common.parameters.ParameterService;
  34 import org.onap.policy.common.utils.services.ServiceManagerContainer;
  35 import org.onap.policy.models.pdp.concepts.PdpStatus;
  36 import org.onap.policy.models.pdp.enums.PdpMessageType;
  37 import org.onap.policy.pdpx.main.PolicyXacmlPdpRuntimeException;
  38 import org.onap.policy.pdpx.main.XacmlState;
  39 import org.onap.policy.pdpx.main.comm.XacmlPdpHearbeatPublisher;
  40 import org.onap.policy.pdpx.main.comm.listeners.XacmlPdpStateChangeListener;
  41 import org.onap.policy.pdpx.main.comm.listeners.XacmlPdpUpdateListener;
  42 import org.onap.policy.pdpx.main.parameters.XacmlPdpParameterGroup;
  43 import org.onap.policy.pdpx.main.rest.XacmlPdpApplicationManager;
  44 import org.onap.policy.pdpx.main.rest.XacmlPdpRestServer;
  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
  65     // The parameters of this policy xacml pdp activator
  66     private final XacmlPdpParameterGroup xacmlPdpParameterGroup;
  67
  68     /**
  69      * The XACML PDP REST API server.
  70      */
  71     private XacmlPdpRestServer restServer;
  72
  73     /**
  74      * Listens for messages on the topic, decodes them into a {@link PdpStatus} message, and then
  75      * dispatches them to appropriate listener.
  76      */
  77     private final MessageTypeDispatcher msgDispatcher;
  78
  79     /**
  80      * Instantiate the activator for policy xacml pdp as a complete service.
  81      *
  82      * @param xacmlPdpParameterGroup the parameters for the xacml pdp service
  83      * @param topicProperties properties used to configure the topics
  84      */
  85     public XacmlPdpActivator(final XacmlPdpParameterGroup xacmlPdpParameterGroup, Properties topicProperties) {
  86         LOGGER.info("Activator initializing using {} and {}", xacmlPdpParameterGroup, topicProperties);
  87
  88         TopicEndpoint.manager.addTopicSinks(topicProperties);
  89         TopicEndpoint.manager.addTopicSources(topicProperties);
  90
  91         final XacmlPdpHearbeatPublisher heartbeat;
  92         final TopicSinkClient sinkClient;
  93         final XacmlState state;
  94
  95         try {
  96             XacmlPdpApplicationManager appmgr =
  97                             new XacmlPdpApplicationManager(Paths.get(xacmlPdpParameterGroup.getApplicationPath()));
  98             XacmlPdpApplicationManager.setCurrent(appmgr);
  99
 100             XacmlPdpStatisticsManager stats = new XacmlPdpStatisticsManager();
 101             XacmlPdpStatisticsManager.setCurrent(stats);
 102             stats.setTotalPolicyTypesCount(appmgr.getPolicyTypeCount());
 103
 104             state = new XacmlState(appmgr);
 105
 106             this.xacmlPdpParameterGroup = xacmlPdpParameterGroup;
 107             this.msgDispatcher = new MessageTypeDispatcher(MSG_TYPE_NAMES);
 108
 109             sinkClient = new TopicSinkClient(TOPIC);
 110             heartbeat = new XacmlPdpHearbeatPublisher(sinkClient, state);
 111
 112             /*
 113              * since the dispatcher isn't registered with the topic yet, we can go ahead
 114              * and register the listeners with it.
 115              */
 116             msgDispatcher.register(PdpMessageType.PDP_STATE_CHANGE.name(),
 117                             new XacmlPdpStateChangeListener(sinkClient, state));
 118             msgDispatcher.register(PdpMessageType.PDP_UPDATE.name(),
 119                             new XacmlPdpUpdateListener(sinkClient, state, heartbeat, appmgr));
 120
 121         } catch (RuntimeException | TopicSinkClientException e) {
 122             throw new PolicyXacmlPdpRuntimeException(e.getMessage(), e);
 123         }
 124
 125         xacmlPdpParameterGroup.getRestServerParameters().setName(xacmlPdpParameterGroup.getName());
 126
 127         // @formatter:off
 128         addAction("XACML PDP parameters",
 129             () -> ParameterService.register(xacmlPdpParameterGroup),
 130             () -> ParameterService.deregister(xacmlPdpParameterGroup.getName()));
 131
 132         addAction("Message Dispatcher",
 133             this::registerMsgDispatcher,
 134             this::unregisterMsgDispatcher);
 135
 136         addAction("topics",
 137             TopicEndpoint.manager::start,
 138             TopicEndpoint.manager::shutdown);
 139
 140         addAction("Terminate PDP",
 141             () -> { },
 142             () -> sendTerminateMessage(sinkClient, state));
 143         // initial heart beats act as registration messages
 144         addAction("Heartbeat Publisher",
 145             heartbeat::start,
 146             heartbeat::terminate);
 147
 148         addAction("Create REST server",
 149             () -> restServer = new XacmlPdpRestServer(xacmlPdpParameterGroup.getRestServerParameters()),
 150             () -> restServer = null);
 151
 152         addAction("REST server",
 153             () -> restServer.start(),
 154             () -> restServer.stop());
 155
 156         // @formatter:on
 157     }
 158
 159     /*
 160      * Method used to send a terminate message to the PAP.
 161      */
 162     private void sendTerminateMessage(TopicSinkClient sinkClient, XacmlState state) {
 163         PdpStatus terminateStatus = state.terminatePdpMessage();
 164         sinkClient.send(terminateStatus);
 165     }
 166
 167     /**
 168      * Get the parameters used by the activator.
 169      *
 170      * @return the parameters of the activator
 171      */
 172     public XacmlPdpParameterGroup getParameterGroup() {
 173         return xacmlPdpParameterGroup;
 174     }
 175
 176     /**
 177      * Method to register the parameters to Common Parameter Service.
 178      *
 179      * @param xacmlPdpParameterGroup the xacml pdp parameter group
 180      */
 181     public void registerToParameterService(final XacmlPdpParameterGroup xacmlPdpParameterGroup) {
 182         ParameterService.register(xacmlPdpParameterGroup);
 183     }
 184
 185     /**
 186      * Method to deregister the parameters from Common Parameter Service.
 187      *
 188      * @param xacmlPdpParameterGroup the xacml pdp parameter group
 189      */
 190     public void deregisterToParameterService(final XacmlPdpParameterGroup xacmlPdpParameterGroup) {
 191         ParameterService.deregister(xacmlPdpParameterGroup.getName());
 192     }
 193
 194     /**
 195      * Registers the dispatcher with the topic source(s).
 196      */
 197     private void registerMsgDispatcher() {
 198         for (TopicSource source : TopicEndpoint.manager.getTopicSources(Arrays.asList(TOPIC))) {
 199             source.register(msgDispatcher);
 200         }
 201     }
 202
 203     /**
 204      * Unregisters the dispatcher from the topic source(s).
 205      */
 206     private void unregisterMsgDispatcher() {
 207         for (TopicSource source : TopicEndpoint.manager.getTopicSources(Arrays.asList(TOPIC))) {
 208             source.unregister(msgDispatcher);
 209         }
 210     }
 211 }