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 import org.json.JSONException;
  31
  32 import com.att.dmf.mr.CambriaApiException;
  33 import com.att.dmf.mr.beans.DMaaPContext;
  34 import com.att.nsa.configs.ConfigDbException;
  35 /**
  36  * @author muzainulhaque.qazi
  37  *
  38  */
  39 public interface UIService {
  40         /**
  41          * Returning template of hello page.
  42          *
  43          * @param dmaapContext
  44          * @throws IOException
  45          */
  46         void hello(DMaaPContext dmaapContext) throws IOException;
  47
  48         /**
  49          * Fetching list of all api keys and returning in a templated form for
  50          * display
  51          *
  52          * @param dmaapContext
  53          * @throws ConfigDbException
  54          * @throws IOException
  55          */
  56         void getApiKeysTable(DMaaPContext dmaapContext) throws ConfigDbException,
  57                         IOException;
  58
  59         /**
  60          * Fetching detials of apikey in a templated form for display
  61          *
  62          * @param dmaapContext
  63          * @param apiKey
  64          * @throws Exception
  65          */
  66         void getApiKey(DMaaPContext dmaapContext, final String apiKey)
  67                         throws CambriaApiException, ConfigDbException, JSONException, IOException;
  68
  69         /**
  70          * Fetching list of all the topics and returning in a templated form for
  71          * display
  72          *
  73          * @param dmaapContext
  74          * @throws ConfigDbException
  75          * @throws IOException
  76          */
  77         void getTopicsTable(DMaaPContext dmaapContext) throws ConfigDbException,
  78                         IOException;
  79
  80         /**
  81          * Fetching detials of topic in a templated form for display
  82          *
  83          * @param dmaapContext
  84          * @param topic
  85          * @throws ConfigDbException
  86          * @throws IOException
  87          * @throws TopicExistsException
  88          */
  89         void getTopic(DMaaPContext dmaapContext, final String topic)
  90                         throws ConfigDbException, IOException, TopicExistsException;
  91
  92 }