summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/onap/dmaap/messagerouter/msgrtr/nsa/cambria/backends/Consumer.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/org/onap/dmaap/messagerouter/msgrtr/nsa/cambria/backends/Consumer.java')
-rw-r--r--src/main/java/org/onap/dmaap/messagerouter/msgrtr/nsa/cambria/backends/Consumer.java96
1 files changed, 96 insertions, 0 deletions
diff --git a/src/main/java/org/onap/dmaap/messagerouter/msgrtr/nsa/cambria/backends/Consumer.java b/src/main/java/org/onap/dmaap/messagerouter/msgrtr/nsa/cambria/backends/Consumer.java
new file mode 100644
index 0000000..8e5aa76
--- /dev/null
+++ b/src/main/java/org/onap/dmaap/messagerouter/msgrtr/nsa/cambria/backends/Consumer.java
@@ -0,0 +1,96 @@
+/*******************************************************************************
+ * ============LICENSE_START=======================================================
+ * org.onap.dmaap
+ * ================================================================================
+ * 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=========================================================
+ *
+ * ECOMP is a trademark and service mark of AT&T Intellectual Property.
+ *
+ *******************************************************************************/
+package org.onap.dmaap.messagerouter.msgrtr.nsa.cambria.backends;
+
+/**
+ * A consumer interface. Consumers pull the next message from a given topic.
+ * @author author
+ */
+public interface Consumer
+{
+ /**
+ * A message interface provide the offset and message
+ * @author author
+ *
+ */
+ public interface Message
+ {
+ /**
+ * returning the offset of that particular message
+ * @return long
+ */
+ long getOffset ();
+ /**
+ * returning the message
+ * @return message
+ */
+ String getMessage ();
+ }
+
+ /**
+ * Get this consumer's name
+ * @return name
+ */
+ String getName ();
+
+ /**
+ * Get creation time in ms
+ * @return
+ */
+ long getCreateTimeMs ();
+
+ /**
+ * Get last access time in ms
+ * @return
+ */
+ long getLastAccessMs ();
+
+ /**
+ * Get the next message from this source. This method must not block.
+ * @return the next message, or null if none are waiting
+ */
+ Message nextMessage ();
+
+ /**
+ * Get the next message from this source. This method must not block.
+ * @param atOffset start with the next message at or after atOffset. -1 means next from last request
+ * @return the next message, or null if none are waiting
+ */
+// Message nextMessage ( long atOffset );
+
+ /**
+ * Close/clean up this consumer
+ */
+ void close();
+
+ /**
+ * Commit the offset of the last consumed message
+ *
+ */
+ void commitOffsets();
+
+ /**
+ * Get the offset this consumer is currently at
+ * @return offset
+ */
+ long getOffset();
+}