aboutsummaryrefslogtreecommitdiffstats
path: root/context/context-management/src/main/java/org/onap/policy/apex/context/impl/distribution/DistributorFlushTimerTask.java
blob: bd31059f7548b2106fc596180f182e2d28594b99 (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
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
 *  Modifications Copyright (C) 2021 Bell Canada. 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.apex.context.impl.distribution;

import java.util.Timer;
import java.util.TimerTask;
import lombok.ToString;
import org.onap.policy.apex.context.ContextException;
import org.onap.policy.apex.context.Distributor;
import org.onap.policy.apex.context.parameters.ContextParameterConstants;
import org.onap.policy.apex.context.parameters.PersistorParameters;
import org.onap.policy.common.parameters.ParameterService;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;

/**
 * This class is used to periodically flush a context distributor.
 *
 * @author eeilfn
 */
@ToString
public class DistributorFlushTimerTask extends TimerTask {
    private static final XLogger LOGGER = XLoggerFactory.getXLogger(DistributorFlushTimerTask.class);

    // The timer for flushing
    @ToString.Exclude
    private Timer timer = null;

    // The context distributor to flush
    @ToString.Exclude
    private final Distributor contextDistributor;

    // Timing information
    private long flushPeriod = 0;
    private long flushCount = 0;

    /**
     * Constructor, save a reference to the event stream handler.
     *
     * @param contextDistributor the distributor that this timer task is flushing
     * @throws ContextException On flush setup errors
     */
    public DistributorFlushTimerTask(final Distributor contextDistributor) throws ContextException {
        // Save the context distributor and period
        this.contextDistributor = contextDistributor;

        // Set the period for persistence flushing
        final var persistorParameters =
                        (PersistorParameters) ParameterService.get(ContextParameterConstants.PERSISTENCE_GROUP_NAME);
        flushPeriod = persistorParameters.getFlushPeriod();

        // Set up the timer
        timer = new Timer(DistributorFlushTimerTask.class.getSimpleName(), true);
        timer.schedule(this, flushPeriod, flushPeriod);

        LOGGER.debug("context distributor {} flushing set up with interval: {} ms", contextDistributor.getKey().getId(),
                        flushPeriod);
    }

    /**
     * Flush the context distributor.
     */
    @Override
    public void run() {
        // Increment the flush counter
        flushCount++;

        LOGGER.debug("context distributor {} flushing: period={}: count={}", contextDistributor.getKey().getId(),
                        flushPeriod, flushCount);
        try {
            contextDistributor.flush();
            LOGGER.debug("context distributor {} flushed: period={}: count={}", contextDistributor.getKey().getId(),
                            flushPeriod, flushCount);
        } catch (final ContextException e) {
            LOGGER.error("flush error on context distributor {}: period={}: count={}",
                            contextDistributor.getKey().getId(), flushPeriod, flushCount, e);
        }
    }

    /**
     * Cancel the timer.
     *
     * @return true, if cancel
     */
    @Override
    public boolean cancel() {
        // Cancel the timer
        if (timer != null) {
            timer.cancel();
        }
        return true;
    }
}