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