summaryrefslogtreecommitdiffstats
path: root/common/src/main/java/org/openecomp/mso/client/dmaap/DmaapConsumer.java
blob: 6a01fb61ba0e6582cc177eb7d6583dda9f9b3b97 (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
/*-
 * ============LICENSE_START=======================================================
 * ONAP - SO
 * ================================================================================
 * Copyright (C) 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.mso.client.dmaap;

import com.google.common.base.Stopwatch;
import java.io.IOException;
import java.util.concurrent.TimeUnit;
import org.openecomp.mso.client.dmaap.exceptions.DMaaPConsumerFailure;
import org.openecomp.mso.client.dmaap.exceptions.ExceededMaximumPollingTime;
import org.openecomp.mso.client.dmaap.rest.RestConsumer;

public abstract class DmaapConsumer extends DmaapClient {

	public DmaapConsumer() throws IOException {
		super("dmaap/default-consumer.properties");
	}

	public Consumer getConsumer() {
		return new RestConsumer(this.properties);
	}

	public boolean consume() throws Exception {
	    Consumer mrConsumer = this.getConsumer();
		boolean accepted = false;
		Stopwatch stopwatch = Stopwatch.createUnstarted();
		try {
			while (this.continuePolling()) {
				if (stopwatch.elapsed(TimeUnit.MILLISECONDS) >= this.getMaximumElapsedTime()) {
					final String message = "exceeded maximum retries on " + this.getRequestId() + " on " + this.getTopic();
					auditLogger.error(message);
					throw new ExceededMaximumPollingTime(message);
				}
				stopwatch.start();
				Iterable<String> itr = mrConsumer.fetch();
				stopwatch.stop();
				for (String message : itr) {
					if (!accepted && this.isAccepted(message)) {
						auditLogger.info("accepted message found for " + this.getRequestId() + " on " + this.getTopic());
						accepted = true;
					}
					if (accepted) {
						auditLogger.info("received dmaap message: " + message);
						if (this.isFailure(message)) {
							this.stopProcessingMessages();
							final String errorMsg = "failure received from dmaap topic " + this.getTopic();
							auditLogger.error(errorMsg);
							throw new DMaaPConsumerFailure(errorMsg);
						} else {
							this.processMessage(message);
						}
					}
				}
			}
			return true;
		} finally {
			if (stopwatch.isRunning()) {
				stopwatch.stop();
			}
		}
	}

	/**
	 * Should this consumer continue to consume messages from the topic?
	 * @return
	 */
	public abstract boolean continuePolling();
	/**
	 * Process a message from a DMaaP topic
	 *
	 * @param message
	 * @throws Exception
	 */
	public abstract void processMessage(String message) throws Exception;
	/**
	 * Has the request been accepted by the receiving system?
	 * Should the consumer move to processing messages?
	 *
	 * @param message
	 * @return
	 */
	public abstract boolean isAccepted(String message);
	/**
	 * has the request failed?
	 *
	 * @param message
	 * @return
	 */
	public abstract boolean isFailure(String message);
	/**
	 * The request id to filter messages on
	 * @return
	 */
	public abstract String getRequestId();
	/**
	 * Logic that defines when the consumer should stop processing messages
	 */
	public abstract void stopProcessingMessages();

	/**
	 * time in milliseconds
	 */
	public int getMaximumElapsedTime() {
		return 180000;
	}



}