main/src/main/java/org/onap/policy/pdpx/main/comm/XacmlPdpHearbeatPublisher.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.comm;
  22
  23 import java.util.concurrent.Executors;
  24 import java.util.concurrent.ScheduledExecutorService;
  25 import java.util.concurrent.ScheduledFuture;
  26 import java.util.concurrent.TimeUnit;
  27 import lombok.Getter;
  28 import org.onap.policy.common.endpoints.event.comm.client.TopicSinkClient;
  29 import org.onap.policy.models.pdp.concepts.PdpStatus;
  30 import org.onap.policy.pdpx.main.XacmlState;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33
  34 public class XacmlPdpHearbeatPublisher implements Runnable {
  35     public static final int DEFAULT_INTERVAL_MS = 60000;
  36
  37     private static final Logger LOGGER = LoggerFactory.getLogger(XacmlPdpHearbeatPublisher.class);
  38
  39     private final TopicSinkClient topicSinkClient;
  40
  41     /**
  42      * Tracks the state of this PDP.
  43      */
  44     private final XacmlState currentState;
  45
  46     /**
  47      * Current timer interval, in milliseconds.
  48      */
  49     @Getter
  50     private long intervalMs = DEFAULT_INTERVAL_MS;
  51
  52     private ScheduledExecutorService timerThread;
  53
  54     private ScheduledFuture<?> timer;
  55
  56
  57     /**
  58      * Constructor for instantiating XacmlPdpPublisher.
  59      *
  60      * @param topicSinkClient used to send heart beat message
  61      * @param state tracks the state of this PDP
  62      */
  63     public XacmlPdpHearbeatPublisher(TopicSinkClient topicSinkClient, XacmlState state) {
  64         this.topicSinkClient = topicSinkClient;
  65         this.currentState = state;
  66     }
  67
  68     @Override
  69     public void run() {
  70         PdpStatus message = currentState.genHeartbeat();
  71         LOGGER.info("Sending Xacml PDP heartbeat to the PAP - {}", message);
  72
  73         topicSinkClient.send(message);
  74     }
  75
  76     /**
  77      * Method to terminate the heart beat.
  78      */
  79     public synchronized void terminate() {
  80         if (timerThread != null) {
  81             timerThread.shutdownNow();
  82             timerThread = null;
  83             timer = null;
  84         }
  85     }
  86
  87     /**
  88      * Restarts the timer if the interval has changed. If the timer is not currently
  89      * running, then it updates the interval, but does not start the timer.
  90      *
  91      * @param intervalMs desired interval, or {@code null} to leave it unchanged
  92      */
  93     public synchronized void restart(Long intervalMs) {
  94         if (intervalMs != null && intervalMs > 0 && intervalMs != this.intervalMs) {
  95             this.intervalMs = intervalMs;
  96
  97             if (timerThread != null) {
  98                 timer.cancel(false);
  99                 timer = timerThread.scheduleWithFixedDelay(this, 0, this.intervalMs, TimeUnit.MILLISECONDS);
 100             }
 101         }
 102     }
 103
 104     /**
 105      * Starts the timer.
 106      */
 107     public synchronized void start() {
 108         if (timerThread == null) {
 109             timerThread = makeTimerThread();
 110             timer = timerThread.scheduleWithFixedDelay(this, 0, this.intervalMs, TimeUnit.MILLISECONDS);
 111         }
 112     }
 113
 114     // these may be overridden by junit tests
 115
 116     protected ScheduledExecutorService makeTimerThread() {
 117         return Executors.newScheduledThreadPool(1);
 118     }
 119 }