X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fonap%2Fdmaap%2Fdmf%2Fmr%2Fbackends%2FConsumer.java;fp=src%2Fmain%2Fjava%2Forg%2Fonap%2Fdmaap%2Fdmf%2Fmr%2Fbackends%2FConsumer.java;h=cba3696f4ef9e35f206aa3db5092ad22933f8329;hb=f052f758c29fa92c21578514202268f3b0430a1a;hp=0000000000000000000000000000000000000000;hpb=388410f85e44de41ef9b340f44c0b4b1b0af59b6;p=dmaap%2Fmessagerouter%2Fmessageservice.git

diff --git a/src/main/java/org/onap/dmaap/dmf/mr/backends/Consumer.java b/src/main/java/org/onap/dmaap/dmf/mr/backends/Consumer.java
new file mode 100644
index 0000000..cba3696
--- /dev/null
+++ b/src/main/java/org/onap/dmaap/dmf/mr/backends/Consumer.java
@@ -0,0 +1,105 @@
+/*******************************************************************************
+ *  ============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.dmf.mr.backends;
+
+
+/**
+ * A consumer interface. Consumers pull the next message from a given topic.
+ * @author peter
+ */
+public interface Consumer
+{	
+	/**
+	 * A message interface provide the offset and message
+	 * @author nilanjana.maity
+	 *
+	 */
+	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
+	 */
+
+
+	
+	/**
+	 * Close/clean up this consumer
+	 * @return 
+	 */
+	boolean close();
+	
+	/**
+	 * Commit the offset of the last consumed message
+	 * 
+	 */
+	void commitOffsets();
+	
+	/**
+	 * Get the offset this consumer is currently at
+	 * @return offset
+	 */
+	long getOffset();
+	
+	void setOffset(long offset);
+	
+	
+	
+	
+}