aboutsummaryrefslogtreecommitdiffstats
path: root/cmso-service/src/main/java/org/onap/optf/cmso/eventq/CmsoQueueJob.java
blob: de85e2c5f7939e4ffbb75059b537a599a4a681a5 (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
/*
 * Copyright © 2017-2018 AT&T Intellectual Property.
 * Modifications Copyright © 2018 IBM.
 *
 * 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.
 *
 *
 * Unless otherwise specified, all documentation contained herein is licensed
 * under the Creative Commons License, Attribution 4.0 Intl. (the "License");
 * you may not use this documentation except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         https://creativecommons.org/licenses/by/4.0/
 *
 * Unless required by applicable law or agreed to in writing, documentation
 * 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.
*/

package org.onap.optf.cmso.eventq;

import com.att.eelf.configuration.EELFLogger;
import com.att.eelf.configuration.EELFManager;
import java.util.Date;
import java.util.List;
import org.onap.optf.cmso.common.CmsoStatusEnum;
import org.onap.optf.cmso.common.LogMessages;
import org.onap.optf.cmso.dispatcher.CmJob;
import org.onap.optf.cmso.model.ChangeManagementSchedule;
import org.onap.optf.cmso.model.dao.ChangeManagementScheduleDao;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.scheduling.quartz.SchedulerFactoryBean;
import org.springframework.stereotype.Component;
import org.springframework.transaction.annotation.Transactional;

/**
 * This job will look for ChangeManagementSchedule approved jobs that are due
 * within the next n intervals of this job and schedule them in as a Quartz
 * CmJob to be dispatched. These ChangeManagementSchedule rows will be
 * status=Queued The CmJob will confirm that the job is OK to be dispatched and
 * set status=.... The next N intervals should be enough to ensure sluggish
 * performance of this process does not miss events but does not exhaust
 * memory....
 */
@Component
public class CmsoQueueJob {
    private static EELFLogger debug = EELFManager.getInstance().getDebugLogger();

    @Autowired
    ChangeManagementScheduleDao cmScheduleDao;

    @Autowired
    SchedulerFactoryBean qsScheduler;

    @Autowired
    Environment env;

    @Autowired
    DispatchedEventList dispatchedEventList;

    /**
     * Queue imminent jobs.
     *
     * @return true, if successful
     */
    public boolean queueImminentJobs() {
        Integer interval = env.getProperty("cmso.cm.polling.job.interval.ms", Integer.class, 10000);
        Integer lookahead = env.getProperty("cmso.cm.polling.job.lookahead.intervals", Integer.class, 5);
        long now = System.currentTimeMillis();
        Long endTime = now + (interval * lookahead);
        List<ChangeManagementSchedule> schedules =
                cmScheduleDao.findByStatusAndEndTime(CmsoStatusEnum.Scheduled.toString(), endTime);
        if (schedules.size() == 0) {
            return false;
        }
        for (ChangeManagementSchedule schedule : schedules) {
            try {
                if (!dispatchedEventList.isAlreadyDispatched(schedule.getUuid())) {
                    scheduleCmJob(schedule);
                    dispatchedEventList.addToDispathcedEventList(schedule.getUuid());
                }
            } catch (org.quartz.SchedulerException e) {
                debug.debug(LogMessages.UNEXPECTED_EXCEPTION, e, e.getMessage());
                // WIll keep trying until it goes Past due
                schedule.setStatus(CmsoStatusEnum.Scheduled.toString());
                schedule.setDispatcherInstance("");
                updateScheduleStatus(schedule);
            } catch (Exception e) {
                debug.debug(LogMessages.UNEXPECTED_EXCEPTION, e, e.getMessage());
                schedule.setStatus(CmsoStatusEnum.Scheduled.toString());
                schedule.setDispatcherInstance("");
                updateScheduleStatus(schedule);
            }
        }
        return false;
    }

    /**
     * Schedule cm job.
     *
     * @param schedule the schedule
     * @throws Exception the scheduler exception
     */
    public void scheduleCmJob(ChangeManagementSchedule schedule) throws org.quartz.SchedulerException {
        //
        Integer dispatherLeadTime = env.getProperty("cmso.cm.dispatcher.lead.time.ms", Integer.class, 5000);
        long dispatchTime = 0;
        Long startTime = schedule.getStartTimeMillis();

        /// If startTIme is null, it is an immediate start
        if (startTime != null) {
            dispatchTime = startTime - dispatherLeadTime;
        }

        JobDetail jobDetail = JobBuilder.newJob(CmJob.class).build();
        jobDetail.getJobDataMap().put("key", schedule.getUuid().toString());

        TriggerBuilder<Trigger> tb = TriggerBuilder.newTrigger().forJob(jobDetail);

        long now = System.currentTimeMillis();
        if (now > dispatchTime) {
            tb.startNow();
        }
        else {
            tb.startAt(new Date(dispatchTime));
        }
        Trigger trigger = tb.build();
        qsScheduler.getScheduler().scheduleJob(jobDetail, trigger);

    }

    /**
     * Update schedule status.
     *
     * @param cmSchedule the cm schedule
     */
    @Transactional
    public void updateScheduleStatus(ChangeManagementSchedule cmSchedule) {
        cmScheduleDao.save(cmSchedule);

    }

}