src/main/java/com/att/dmf/mr/service/UIService.java

   1 /**
   2  *
   3  */
   4 /*******************************************************************************
   5  *  ============LICENSE_START=======================================================
   6  *  org.onap.dmaap
   7  *  ================================================================================
   8  *  Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   9  *  ================================================================================
  10  *  Licensed under the Apache License, Version 2.0 (the "License");
  11  *  you may not use this file except in compliance with the License.
  12  *  You may obtain a copy of the License at
  13  *        http://www.apache.org/licenses/LICENSE-2.0
  14 *
  15  *  Unless required by applicable law or agreed to in writing, software
  16  *  distributed under the License is distributed on an "AS IS" BASIS,
  17  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  *  See the License for the specific language governing permissions and
  19  *  limitations under the License.
  20  *  ============LICENSE_END=========================================================
  21  *
  22  *  ECOMP is a trademark and service mark of AT&T Intellectual Property.
  23  *
  24  *******************************************************************************/
  25 package com.att.dmf.mr.service;
  26
  27 import java.io.IOException;
  28
  29 import org.apache.kafka.common.errors.TopicExistsException;
  30
  31 import com.att.dmf.mr.beans.DMaaPContext;
  32 import com.att.nsa.configs.ConfigDbException;
  33 /**
  34  * @author muzainulhaque.qazi
  35  *
  36  */
  37 public interface UIService {
  38         /**
  39          * Returning template of hello page.
  40          *
  41          * @param dmaapContext
  42          * @throws IOException
  43          */
  44         void hello(DMaaPContext dmaapContext) throws IOException;
  45
  46         /**
  47          * Fetching list of all api keys and returning in a templated form for
  48          * display
  49          *
  50          * @param dmaapContext
  51          * @throws ConfigDbException
  52          * @throws IOException
  53          */
  54         void getApiKeysTable(DMaaPContext dmaapContext) throws ConfigDbException,
  55                         IOException;
  56
  57         /**
  58          * Fetching detials of apikey in a templated form for display
  59          *
  60          * @param dmaapContext
  61          * @param apiKey
  62          * @throws Exception
  63          */
  64         void getApiKey(DMaaPContext dmaapContext, final String apiKey)
  65                         throws Exception;
  66
  67         /**
  68          * Fetching list of all the topics and returning in a templated form for
  69          * display
  70          *
  71          * @param dmaapContext
  72          * @throws ConfigDbException
  73          * @throws IOException
  74          */
  75         void getTopicsTable(DMaaPContext dmaapContext) throws ConfigDbException,
  76                         IOException;
  77
  78         /**
  79          * Fetching detials of topic in a templated form for display
  80          *
  81          * @param dmaapContext
  82          * @param topic
  83          * @throws ConfigDbException
  84          * @throws IOException
  85          * @throws TopicExistsException
  86          */
  87         void getTopic(DMaaPContext dmaapContext, final String topic)
  88                         throws ConfigDbException, IOException, TopicExistsException;
  89
  90 }