src/main/java/org/onap/dmaap/dmf/mr/service/MMService.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 org.onap.dmaap.dmf.mr.service;
  23
  24 import java.io.IOException;
  25 import java.io.InputStream;
  26
  27 import org.onap.dmaap.dmf.mr.CambriaApiException;
  28 import org.onap.dmaap.dmf.mr.backends.ConsumerFactory.UnavailableException;
  29 import org.onap.dmaap.dmf.mr.beans.DMaaPContext;
  30 import org.onap.dmaap.dmf.mr.metabroker.Broker.TopicExistsException;
  31 import com.att.nsa.configs.ConfigDbException;
  32 import com.att.nsa.drumlin.till.nv.rrNvReadable.missingReqdSetting;
  33 import com.att.nsa.security.ReadWriteSecuredResource.AccessDeniedException;
  34
  35 /**
  36  * Contains the logic for executing calls to the Mirror Maker agent tool.
  37  *
  38  * @author <a href="mailto:kawsar.jahan@att.com">Kawsar Jahan</a>
  39  *
  40  * @since May 25, 2016
  41  */
  42
  43 public interface MMService {
  44
  45         /*
  46          * this method calls the add white list method of a Mirror Maker agent API
  47          */
  48         public void addWhiteList();
  49
  50         /*
  51          * this method calls the remove white list method of a Mirror Maker agent API
  52          */
  53         public void removeWhiteList();
  54
  55         /*
  56          * This method calls the list white list method of a Mirror Maker agent API
  57          */
  58         public void listWhiteList();
  59
  60         public String subscribe(DMaaPContext ctx, String topic, String consumerGroup, String clientId) throws ConfigDbException, TopicExistsException,
  61                 AccessDeniedException, UnavailableException, CambriaApiException, IOException;
  62
  63         public void pushEvents(DMaaPContext ctx, final String topic, InputStream msg, final String defaultPartition,
  64                         final String requestTime) throws ConfigDbException, AccessDeniedException, TopicExistsException,
  65                         CambriaApiException, IOException, missingReqdSetting;
  66 }