aboutsummaryrefslogtreecommitdiffstats
path: root/main/src/main/java/org/onap/policy/pdpx/main/comm/XacmlPdpHearbeatPublisher.java
blob: 8c1f79282f540210c0b4b3637457d4b3459946e5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/*-
 * ============LICENSE_START=======================================================
 * Copyright (C) 2019, 2021 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.pdpx.main.comm;

import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import lombok.Getter;
import org.onap.policy.common.endpoints.event.comm.client.BidirectionalTopicClient;
import org.onap.policy.common.utils.coder.Coder;
import org.onap.policy.common.utils.coder.CoderException;
import org.onap.policy.common.utils.coder.StandardCoder;
import org.onap.policy.models.pdp.concepts.PdpStatus;
import org.onap.policy.models.pdp.concepts.PdpTopicCheck;
import org.onap.policy.pdpx.main.XacmlState;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class XacmlPdpHearbeatPublisher implements Runnable {
    public static final int DEFAULT_HB_INTERVAL_MS = 60000;

    private static final Logger LOGGER = LoggerFactory.getLogger(XacmlPdpHearbeatPublisher.class);
    private static final Coder CODER = new StandardCoder();

    private final BidirectionalTopicClient topicChecker;
    private final long probeHeartbeatTopicMs;

    /**
     * Tracks the state of this PDP.
     */
    private final XacmlState currentState;

    /**
     * Current timer interval, in milliseconds.
     */
    @Getter
    private long intervalMs = DEFAULT_HB_INTERVAL_MS;

    private ScheduledExecutorService timerThread;

    private ScheduledFuture<?> timer;


    /**
     * Constructor for instantiating XacmlPdpPublisher.
     *
     * @param topicChecker used to check the topic before sending heart beat message
     * @param probeHeartbeatTopicMs frequency, in milliseconds, with which to probe the
     *        heartbeat topic before sending the first heartbeat. Zero disables probing
     * @param state tracks the state of this PDP
     */
    public XacmlPdpHearbeatPublisher(BidirectionalTopicClient topicChecker, long probeHeartbeatTopicMs,
                    XacmlState state) {
        LOGGER.info("heartbeat topic probe {}ms", probeHeartbeatTopicMs);
        this.topicChecker = topicChecker;
        this.probeHeartbeatTopicMs = probeHeartbeatTopicMs;
        this.currentState = state;
    }

    @Override
    public void run() {
        try {
            if (!isTopicReady()) {
                return;
            }

            PdpStatus message = currentState.genHeartbeat();
            LOGGER.info("Sending Xacml PDP heartbeat to the PAP - {}", message);

            String json = CODER.encode(message);
            topicChecker.send(json);

        } catch (RuntimeException | CoderException e) {
            LOGGER.warn("send to {} failed because of {}", topicChecker.getSink().getTopic(), e.getMessage(), e);
        }
    }

    private boolean isTopicReady() throws CoderException {
        if (probeHeartbeatTopicMs <= 0 || topicChecker.isReady()) {
            return true;
        }

        var check = new PdpTopicCheck();
        check.setName(XacmlState.PDP_NAME);
        return topicChecker.awaitReady(check, probeHeartbeatTopicMs);
    }

    /**
     * Method to terminate the heart beat.
     */
    public synchronized void terminate() {
        topicChecker.stopWaiting();

        if (timerThread != null) {
            timerThread.shutdownNow();
            timerThread = null;
            timer = null;
        }
    }

    /**
     * Restarts the timer if the interval has changed. If the timer is not currently
     * running, then it updates the interval, but does not start the timer.
     *
     * @param intervalMs desired interval, or {@code null} to leave it unchanged
     */
    public synchronized void restart(Long intervalMs) {
        if (intervalMs != null && intervalMs > 0 && intervalMs != this.intervalMs) {
            this.intervalMs = intervalMs;

            if (timerThread != null) {
                timer.cancel(false);
                timer = timerThread.scheduleWithFixedDelay(this, 0, this.intervalMs, TimeUnit.MILLISECONDS);
            }
        }
    }

    /**
     * Starts the timer.
     */
    public synchronized void start() {
        if (timerThread == null) {
            timerThread = makeTimerThread();
            timer = timerThread.scheduleWithFixedDelay(this, 0, this.intervalMs, TimeUnit.MILLISECONDS);
        }
    }

    // these may be overridden by junit tests

    protected ScheduledExecutorService makeTimerThread() {
        return Executors.newScheduledThreadPool(1);
    }
}