main/src/main/java/org/onap/policy/pdpx/main/XacmlState.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2019, 2021-2022 AT&T Intellectual Property. All rights reserved.
   4  * Modifications Copyright (C) 2023 Nordix Foundation.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.pdpx.main;
  23
  24 import java.util.Collections;
  25 import org.apache.commons.lang3.StringUtils;
  26 import org.onap.policy.common.utils.network.NetworkUtil;
  27 import org.onap.policy.models.pdp.concepts.PdpMessage;
  28 import org.onap.policy.models.pdp.concepts.PdpResponseDetails;
  29 import org.onap.policy.models.pdp.concepts.PdpStateChange;
  30 import org.onap.policy.models.pdp.concepts.PdpStatus;
  31 import org.onap.policy.models.pdp.concepts.PdpUpdate;
  32 import org.onap.policy.models.pdp.enums.PdpHealthStatus;
  33 import org.onap.policy.models.pdp.enums.PdpResponseStatus;
  34 import org.onap.policy.models.pdp.enums.PdpState;
  35 import org.onap.policy.pdpx.main.rest.XacmlPdpApplicationManager;
  36 import org.onap.policy.pdpx.main.startstop.XacmlPdpActivator;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 /**
  41  * Current state of this XACML PDP.
  42  */
  43 public class XacmlState {
  44     // The logger for this class
  45     private static final Logger LOGGER = LoggerFactory.getLogger(XacmlState.class);
  46
  47     /**
  48      * Unique name for the xacml-pdp JVM, used in PdpStatus messages.
  49      */
  50     public static final String PDP_NAME = NetworkUtil.genUniqueName("xacml");
  51
  52     /**
  53      * The application manager.
  54      */
  55     private final XacmlPdpApplicationManager appManager;
  56
  57     /**
  58      * Records the current state of this PDP.
  59      */
  60     private final PdpStatus status;
  61
  62     /**
  63      * Constructs the object, initializing the state.
  64      */
  65     public XacmlState(XacmlPdpApplicationManager appManager, String pdpGroupName, String pdpType) {
  66         this.appManager = appManager;
  67
  68         this.status = new PdpStatus();
  69         this.status.setName(PDP_NAME);
  70         this.status.setPdpType(pdpType);
  71         this.status.setState(PdpState.PASSIVE);
  72         this.status.setPolicies(Collections.emptyList());
  73         this.status.setPdpGroup(pdpGroupName);
  74     }
  75
  76     /**
  77      * Determines if this PDP should handle the given message.
  78      *
  79      * @param message message of interest
  80      * @return {@code true} if this PDP should handle the message, {@code false} otherwise
  81      */
  82     public boolean shouldHandle(PdpMessage message) {
  83         return message.appliesTo(status.getName(), status.getPdpGroup(), status.getPdpType());
  84     }
  85
  86     /**
  87      * Generates a new heart beat message.
  88      *
  89      * @return a new heart beat message
  90      */
  91     public synchronized PdpStatus genHeartbeat() {
  92         // first, update status fields
  93         status.setHealthy(XacmlPdpActivator.getCurrent().isAlive() ? PdpHealthStatus.HEALTHY
  94             : PdpHealthStatus.NOT_HEALTHY);
  95
  96         return new PdpStatus(status);
  97     }
  98
  99     /**
 100      * Updates the internal state based on the given message.
 101      *
 102      * @param message message from which to update the internal state
 103      * @return a response to the message
 104      */
 105     public synchronized PdpStatus updateInternalState(PdpStateChange message) {
 106         LOGGER.info("set state of {} to {}", this, message.getState());
 107         status.setState(message.getState());
 108
 109         /*
 110          * NOTE: Do NOT update group & subgroup as state-change requests do not set those
 111          * fields to indicate new values; they only set them to do broadcasts to all PDPs
 112          * within a group/subgroup.
 113          */
 114
 115         PdpStatus status2 = makeResponse(message, "");
 116
 117         // start/stop rest controller based on state change
 118         handleXacmlRestController();
 119
 120         // these fields aren't needed in the response, so clear them out to avoid sending
 121         status2.setPolicies(null);
 122
 123         return status2;
 124     }
 125
 126     /**
 127      * Updates the internal state based on the given message. Assumes that the policies
 128      * have already been updated within the application manager.
 129      *
 130      * @param message message from which to update the internal state
 131      * @return a response to the message
 132      */
 133     public synchronized PdpStatus updateInternalState(PdpUpdate message, String errMessage) {
 134         status.setPdpSubgroup(message.getPdpSubgroup());
 135         status.setPolicies(appManager.getToscaPolicyIdentifiers());
 136
 137         return makeResponse(message, errMessage);
 138     }
 139
 140     /**
 141      * Updates the internal state to Terminated.
 142      *
 143      * @return the current PdpStatus with Terminated state
 144      */
 145     public synchronized PdpStatus terminatePdpMessage() {
 146         LOGGER.info("set state of {} to {}", this, PdpState.TERMINATED);
 147         status.setState(PdpState.TERMINATED);
 148         return new PdpStatus(status);
 149     }
 150
 151     /**
 152      * Makes a response to the given message, based on the current state.
 153      *
 154      * @param message message for which the response should be made
 155      * @param errMessage the error message to be sent to PAP
 156      * @return a new response
 157      */
 158     private PdpStatus makeResponse(PdpMessage message, String errMessage) {
 159         var resp = new PdpResponseDetails();
 160
 161         if (StringUtils.isBlank(errMessage)) {
 162             resp.setResponseStatus(PdpResponseStatus.SUCCESS);
 163         } else {
 164             resp.setResponseStatus(PdpResponseStatus.FAIL);
 165             resp.setResponseMessage(errMessage);
 166         }
 167         resp.setResponseTo(message.getRequestId());
 168
 169         var status2 = new PdpStatus(status);
 170         status2.setResponse(resp);
 171         return status2;
 172     }
 173
 174     /**
 175      * Manages the Xacml-Pdp rest controller based on the Xacml-Pdp State.
 176      * Current supported states:
 177      * ACTIVE  - rest service is running and handling requests
 178      * PASSIVE - rest service is not running
 179      */
 180     private void handleXacmlRestController() {
 181         if (status.getState() == PdpState.ACTIVE) {
 182             LOGGER.info("State change: {} - Starting rest controller", status.getState());
 183             XacmlPdpActivator.getCurrent().enableApi();
 184         } else if (status.getState() == PdpState.PASSIVE) {
 185             LOGGER.info("State change: {} - Stopping rest controller", status.getState());
 186             XacmlPdpActivator.getCurrent().disableApi();
 187         } else {
 188             // unsupported state
 189             LOGGER.warn("Unsupported state: {}", status.getState());
 190         }
 191     }
 192 }