src/main/java/org/onap/dmaap/dmf/mr/service/AdminService.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 com.att.nsa.configs.ConfigDbException;
  25 import com.att.nsa.security.ReadWriteSecuredResource.AccessDeniedException;
  26 import org.json.JSONException;
  27 import org.onap.dmaap.dmf.mr.beans.DMaaPContext;
  28
  29 import java.io.IOException;
  30
  31 /**
  32  * @author muzainulhaque.qazi
  33  *
  34  */
  35 public interface AdminService {
  36         /**
  37          * method provide consumerCache
  38          *
  39          * @param dMaaPContext
  40          * @throws IOException
  41          */
  42         void showConsumerCache(DMaaPContext dMaaPContext) throws IOException,AccessDeniedException;
  43
  44         /**
  45          * method drops consumer cache
  46          *
  47          * @param dMaaPContext
  48          * @throws JSONException
  49          * @throws IOException
  50          */
  51         void dropConsumerCache(DMaaPContext dMaaPContext) throws JSONException, IOException,AccessDeniedException;
  52
  53
  54         /**
  55          * Get list of blacklisted ips
  56          * @param dMaaPContext context
  57          * @throws IOException ex
  58          * @throws AccessDeniedException ex
  59          */
  60         void getBlacklist ( DMaaPContext dMaaPContext ) throws IOException, AccessDeniedException;
  61
  62         /**
  63          * Add ip to blacklist
  64          * @param dMaaPContext context
  65          * @param ip ip
  66          * @throws IOException ex
  67          * @throws ConfigDbException ex
  68          * @throws AccessDeniedException ex
  69          */
  70         void addToBlacklist ( DMaaPContext dMaaPContext, String ip ) throws IOException, ConfigDbException, AccessDeniedException;
  71
  72         /**
  73          * Remove ip from blacklist
  74          * @param dMaaPContext context
  75          * @param ip ip
  76          * @throws IOException ex
  77          * @throws ConfigDbException ex
  78          * @throws AccessDeniedException ex
  79          */
  80         void removeFromBlacklist ( DMaaPContext dMaaPContext, String ip ) throws IOException, ConfigDbException, AccessDeniedException;
  81
  82 }