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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2019, 2021 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;
  22
  23 import java.util.Collections;
  24 import org.apache.commons.lang3.StringUtils;
  25 import org.onap.policy.common.utils.network.NetworkUtil;
  26 import org.onap.policy.models.pdp.concepts.PdpMessage;
  27 import org.onap.policy.models.pdp.concepts.PdpResponseDetails;
  28 import org.onap.policy.models.pdp.concepts.PdpStateChange;
  29 import org.onap.policy.models.pdp.concepts.PdpStatus;
  30 import org.onap.policy.models.pdp.concepts.PdpUpdate;
  31 import org.onap.policy.models.pdp.enums.PdpHealthStatus;
  32 import org.onap.policy.models.pdp.enums.PdpResponseStatus;
  33 import org.onap.policy.models.pdp.enums.PdpState;
  34 import org.onap.policy.pdpx.main.rest.XacmlPdpApplicationManager;
  35 import org.onap.policy.pdpx.main.startstop.XacmlPdpActivator;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 /**
  40  * Current state of this XACML PDP.
  41  */
  42 public class XacmlState {
  43     private static final Logger LOGGER = LoggerFactory.getLogger(XacmlState.class);
  44
  45     /**
  46      * The application manager.
  47      */
  48     private final XacmlPdpApplicationManager appManager;
  49
  50     /**
  51      * Records the current state of this PDP.
  52      */
  53     private final PdpStatus status;
  54
  55     /**
  56      * Constructs the object, initializing the state.
  57      */
  58     public XacmlState(XacmlPdpApplicationManager appManager, String pdpGroupName, String pdpType) {
  59         this.appManager = appManager;
  60
  61         this.status = new PdpStatus();
  62         this.status.setName(NetworkUtil.getHostname());
  63         this.status.setPdpType(pdpType);
  64         this.status.setState(PdpState.PASSIVE);
  65         this.status.setPolicies(Collections.emptyList());
  66         this.status.setPdpGroup(pdpGroupName);
  67     }
  68
  69     /**
  70      * Determines if this PDP should handle the given message.
  71      *
  72      * @param message message of interest
  73      * @return {@code true} if this PDP should handle the message, {@code false} otherwise
  74      */
  75     public boolean shouldHandle(PdpMessage message) {
  76         return message.appliesTo(status.getName(), status.getPdpGroup(), status.getPdpType());
  77     }
  78
  79     /**
  80      * Generates a new heart beat message.
  81      *
  82      * @return a new heart beat message
  83      */
  84     public synchronized PdpStatus genHeartbeat() {
  85         // first, update status fields
  86         status.setHealthy(XacmlPdpActivator.getCurrent().isAlive() ? PdpHealthStatus.HEALTHY
  87                         : PdpHealthStatus.NOT_HEALTHY);
  88
  89         return new PdpStatus(status);
  90     }
  91
  92     /**
  93      * Updates the internal state based on the given message.
  94      *
  95      * @param message message from which to update the internal state
  96      * @return a response to the message
  97      */
  98     public synchronized PdpStatus updateInternalState(PdpStateChange message) {
  99         LOGGER.info("set state of {} to {}", this, message.getState());
 100         status.setState(message.getState());
 101
 102         /*
 103          * NOTE: Do NOT update group & subgroup as state-change requests do not set those
 104          * fields to indicate new values; they only set them to do broadcasts to all PDPs
 105          * within a group/subgroup.
 106          */
 107
 108         PdpStatus status2 = makeResponse(message, "");
 109
 110         // these fields aren't needed in the response, so clear them out to avoid sending
 111         status2.setPolicies(null);
 112
 113         return status2;
 114     }
 115
 116     /**
 117      * Updates the internal state based on the given message. Assumes that the policies
 118      * have already been updated within the application manager.
 119      *
 120      * @param message message from which to update the internal state
 121      * @return a response to the message
 122      */
 123     public synchronized PdpStatus updateInternalState(PdpUpdate message, String errMessage) {
 124         status.setPdpSubgroup(message.getPdpSubgroup());
 125         status.setPolicies(appManager.getToscaPolicyIdentifiers());
 126
 127         return makeResponse(message, errMessage);
 128     }
 129
 130     /**
 131      * Updates the internal state to Terminated.
 132      *
 133      * @return the current PdpStatus with Terminated state
 134      */
 135     public synchronized PdpStatus terminatePdpMessage() {
 136         LOGGER.info("set state of {} to {}", this, PdpState.TERMINATED);
 137         status.setState(PdpState.TERMINATED);
 138         return new PdpStatus(status);
 139     }
 140
 141     /**
 142      * Makes a response to the given message, based on the current state.
 143      *
 144      * @param message message for which the response should be made
 145      * @param errMessage the error message to be sent to PAP
 146      * @return a new response
 147      */
 148     private PdpStatus makeResponse(PdpMessage message, String errMessage) {
 149         PdpResponseDetails resp = new PdpResponseDetails();
 150
 151         if (StringUtils.isBlank(errMessage)) {
 152             resp.setResponseStatus(PdpResponseStatus.SUCCESS);
 153         } else {
 154             resp.setResponseStatus(PdpResponseStatus.FAIL);
 155             resp.setResponseMessage(errMessage);
 156         }
 157         resp.setResponseTo(message.getRequestId());
 158
 159         PdpStatus status2 = new PdpStatus(status);
 160         status2.setResponse(resp);
 161         return status2;
 162     }
 163 }