src/main/java/com/att/dmf/mr/backends/Consumer.java

   1 /*******************************************************************************
   2  *  ============LICENSE_START=======================================================
   3  *  org.onap.dmaap
   4  *  ================================================================================
   5  *  Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  *  ================================================================================
   7  *  Licensed under the Apache License, Version 2.0 (the "License");
   8  *  you may not use this file except in compliance with the License.
   9  *  You may obtain a copy of the License at
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11 *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *  ============LICENSE_END=========================================================
  18  *
  19  *  ECOMP is a trademark and service mark of AT&T Intellectual Property.
  20  *
  21  *******************************************************************************/
  22 package com.att.dmf.mr.backends;
  23
  24
  25 /**
  26  * A consumer interface. Consumers pull the next message from a given topic.
  27  * @author peter
  28  */
  29 public interface Consumer
  30 {
  31         /**
  32          * A message interface provide the offset and message
  33          * @author nilanjana.maity
  34          *
  35          */
  36         public interface Message
  37         {
  38                 /**
  39                  * returning the offset of that particular message
  40                  * @return long
  41                  */
  42                 long getOffset ();
  43                 /**
  44                  * returning the message
  45                  * @return message
  46                  */
  47                 String getMessage ();
  48         }
  49
  50         /**
  51          * Get this consumer's name
  52          * @return name
  53          */
  54         String getName ();
  55
  56         /**
  57          * Get creation time in ms
  58          * @return
  59          */
  60         long getCreateTimeMs ();
  61
  62         /**
  63          * Get last access time in ms
  64          * @return
  65          */
  66         long getLastAccessMs ();
  67
  68         /**
  69          * Get the next message from this source. This method must not block.
  70          * @return the next message, or null if none are waiting
  71          */
  72         Message nextMessage ();
  73
  74         /**
  75          * Get the next message from this source. This method must not block.
  76          * @param atOffset start with the next message at or after atOffset. -1 means next from last request
  77          * @return the next message, or null if none are waiting
  78          */
  79
  80
  81
  82         /**
  83          * Close/clean up this consumer
  84          * @return
  85          */
  86         boolean close();
  87
  88         /**
  89          * Commit the offset of the last consumed message
  90          *
  91          */
  92         void commitOffsets();
  93
  94         /**
  95          * Get the offset this consumer is currently at
  96          * @return offset
  97          */
  98         long getOffset();
  99
 100         void setOffset(long offset);
 101
 102
 103
 104
 105 }