aboutsummaryrefslogtreecommitdiffstats
path: root/dcae-analytics-tca/src/main/java/org/openecomp/dcae/analytics/tca/worker/TCADMaaPSubscriberWorker.java
blob: 8d773e4c79e8d352e8946ca469a94949126d3235 (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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
/*
 * ============LICENSE_START=========================================================
 * dcae-analytics
 * ================================================================================
 *  Copyright © 2017 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.
 * ============LICENSE_END=========================================================
 */

package org.openecomp.dcae.analytics.tca.worker;

import co.cask.cdap.api.annotation.Property;
import co.cask.cdap.api.metrics.Metrics;
import co.cask.cdap.api.worker.AbstractWorker;
import co.cask.cdap.api.worker.WorkerContext;
import org.openecomp.dcae.analytics.common.AnalyticsConstants;
import org.openecomp.dcae.analytics.common.CDAPComponentsConstants;
import org.openecomp.dcae.analytics.common.exception.DCAEAnalyticsRuntimeException;
import org.openecomp.dcae.analytics.dmaap.DMaaPMRFactory;
import org.openecomp.dcae.analytics.dmaap.domain.config.DMaaPMRSubscriberConfig;
import org.openecomp.dcae.analytics.dmaap.service.subscriber.DMaaPMRSubscriber;
import org.openecomp.dcae.analytics.model.util.AnalyticsModelIOUtils;
import org.openecomp.dcae.analytics.tca.settings.TCAAppPreferences;
import org.openecomp.dcae.analytics.tca.utils.AppPreferencesToSubscriberConfigMapper;
import org.openecomp.dcae.analytics.tca.utils.TCAUtils;
import org.quartz.JobBuilder;
import org.quartz.JobDataMap;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.SimpleScheduleBuilder;
import org.quartz.SimpleTrigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Properties;
import java.util.concurrent.atomic.AtomicBoolean;

import static java.lang.String.format;

/**
 * TCA DMaaP Subscriber will read messages and post them to cdap stream at regular intervals
 * <p>
 * @author Rajiv Singla. Creation Date: 10/14/2016.
 */
public class TCADMaaPSubscriberWorker extends AbstractWorker {

    private static final Logger LOG = LoggerFactory.getLogger(TCADMaaPSubscriberWorker.class);

    /**
     * DMaaP MR Subscriber
     */
    private DMaaPMRSubscriber subscriber;
    /**
     * Quartz Scheduler
     */
    private Scheduler scheduler;
    /**
     * Determines if scheduler is shutdown
     */
    private AtomicBoolean isSchedulerShutdown;
    /**
     * Store runtime metrics
     */
    private Metrics metrics;

    /**
     * CDAP output stream name
     */
    @Property
    private final String tcaSubscriberOutputStreamName;

    public TCADMaaPSubscriberWorker(final String tcaSubscriberOutputStreamName) {
        this.tcaSubscriberOutputStreamName = tcaSubscriberOutputStreamName;
    }


    @Override
    public void configure() {
        // configure
        setName(CDAPComponentsConstants.TCA_FIXED_DMAAP_SUBSCRIBER_WORKER);
        setDescription(CDAPComponentsConstants.TCA_FIXED_DMAAP_SUBSCRIBER_DESCRIPTION_WORKER);
        LOG.debug("Configuring TCA MR DMaaP Subscriber worker with name: {}",
                CDAPComponentsConstants.TCA_FIXED_DMAAP_SUBSCRIBER_WORKER);
    }

    @Override
    public void initialize(WorkerContext context) throws Exception {
        super.initialize(context);

        // Parse runtime arguments
        final TCAAppPreferences tcaAppPreferences = TCAUtils.getValidatedTCAAppPreferences(context);

        LOG.info("Initializing TCA MR DMaaP Subscriber worker with preferences: {}", tcaAppPreferences);

        // Map TCA App Preferences to DMaaP MR Subscriber Config
        final DMaaPMRSubscriberConfig subscriberConfig = AppPreferencesToSubscriberConfigMapper.map(tcaAppPreferences);

        LOG.info("TCA DMaaP MR Subscriber worker will be writing to CDAP Stream: {}", tcaSubscriberOutputStreamName);

        // Create an instance of DMaaP MR Subscriber
        LOG.debug("Creating an instance of DMaaP Subscriber");
        subscriber = DMaaPMRFactory.create().createSubscriber(subscriberConfig);

        // initialize a new Quartz scheduler
        initializeScheduler(tcaAppPreferences);

        // initialize scheduler state
        isSchedulerShutdown = new AtomicBoolean(true);
    }


    @Override
    public void run() {
        // Start scheduler
        try {
            scheduler.start();
            isSchedulerShutdown.getAndSet(false);

        } catch (SchedulerException e) {
            final String errorMessage =
                    format("Error while starting TCA DMaaP MR Subscriber scheduler: %s", e.toString());
            throw new DCAEAnalyticsRuntimeException(errorMessage, LOG, e);
        }

        LOG.info("TCA DMaaP MR Subscriber Scheduler started successfully");

        // indefinite loop which wakes up and confirms scheduler is indeed running
        while (!isSchedulerShutdown.get()) {
            try {

                Thread.sleep(AnalyticsConstants.TCA_DEFAULT_WORKER_SHUTDOWN_CHECK_INTERVAL_MS);

            } catch (InterruptedException e) {

                final String errorMessage =
                        format("Error while checking TCA DMaaP MR Subscriber worker status: %s", e);
                throw new DCAEAnalyticsRuntimeException(errorMessage, LOG, e);
            }
        }

        LOG.info("Finished execution of TCA DMaaP MR Subscriber worker thread");

    }

    @Override
    public void stop() {

        // Stop scheduler
        try {

            LOG.info("Shutting TCA DMaaP MR Subscriber Scheduler");

            scheduler.shutdown();
            isSchedulerShutdown.getAndSet(true);

        } catch (SchedulerException e) {

            final String errorMessage =
                    format("Error while shutting down TCA DMaaP MR Subscriber scheduler: %s", e);
            throw new DCAEAnalyticsRuntimeException(errorMessage, LOG, e);
        }
    }

    /**
     * Initializes a scheduler instance for DMaaP MR Subscriber Job
     *
     * @throws SchedulerException SchedulerException
     */
    private void initializeScheduler(TCAAppPreferences tcaAppPreferences) throws SchedulerException {

        // Initialize a new Quartz Standard scheduler - settings settings are in quartz-subscriber.properties file
        final StdSchedulerFactory stdSchedulerFactory = new StdSchedulerFactory();
        final String quartzSubscriberPropertiesFileName = AnalyticsConstants.TCA_QUARTZ_SUBSCRIBER_PROPERTIES_FILE_NAME;
        LOG.debug("Configuring quartz scheduler for TCA DMaaP MR Subscriber with properties file: {}",
                quartzSubscriberPropertiesFileName);
        final Properties subscriberProperties =
                AnalyticsModelIOUtils.loadPropertiesFile(quartzSubscriberPropertiesFileName);
        stdSchedulerFactory.initialize(subscriberProperties);
        scheduler = stdSchedulerFactory.getScheduler();

        // Create a new JobDataMap containing information required by TCA DMaaP Subscriber Job
        final JobDataMap jobDataMap = new JobDataMap();
        jobDataMap.put(AnalyticsConstants.CDAP_STREAM_VARIABLE_NAME, tcaSubscriberOutputStreamName);
        jobDataMap.put(AnalyticsConstants.WORKER_CONTEXT_VARIABLE_NAME, getContext());
        jobDataMap.put(AnalyticsConstants.DMAAP_SUBSCRIBER_VARIABLE_NAME, subscriber);
        jobDataMap.put(AnalyticsConstants.DMAAP_METRICS_VARIABLE_NAME, metrics);

        // Create a new job detail
        final JobDetail jobDetail = JobBuilder.newJob(TCADMaaPMRSubscriberJob.class)
                .withIdentity(AnalyticsConstants.TCA_DMAAP_SUBSCRIBER_QUARTZ_JOB_NAME,
                        AnalyticsConstants.TCA_QUARTZ_GROUP_NAME)
                .usingJobData(jobDataMap).build();

        // Create a new scheduling builder
        final Integer subscriberPollingInterval = tcaAppPreferences.getSubscriberPollingInterval();
        final SimpleScheduleBuilder simpleScheduleBuilder = SimpleScheduleBuilder.simpleSchedule()
                .withIntervalInMilliseconds(subscriberPollingInterval) // job will use custom polling schedule
                .repeatForever(); // repeats while worker is running

        // Create a trigger for the TCA Subscriber Job
        final SimpleTrigger simpleTrigger = TriggerBuilder.newTrigger()
                .withIdentity(AnalyticsConstants.TCA_DMAAP_SUBSCRIBER_QUARTZ_TRIGGER_NAME,
                        AnalyticsConstants.TCA_QUARTZ_GROUP_NAME)
                .startNow() // job starts right away
                .withSchedule(simpleScheduleBuilder).build();

        scheduler.scheduleJob(jobDetail, simpleTrigger);
        LOG.info("Initialized TCA DMaaP MR Subscriber Scheduler");
    }


}