src/main/java/org/onap/dmaap/dmf/mr/service/ApiKeysService.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.onap.dmaap.dmf.mr.beans.ApiKeyBean;
  27 import org.onap.dmaap.dmf.mr.beans.DMaaPContext;
  28 import com.att.nsa.configs.ConfigDbException;
  29 import com.att.nsa.security.ReadWriteSecuredResource.AccessDeniedException;
  30 import com.att.nsa.security.db.NsaApiDb.KeyExistsException;
  31
  32 /**
  33  * Declaring all the method in interface that is mainly used for authentication
  34  * purpose.
  35  *
  36  *
  37  */
  38
  39 public interface ApiKeysService {
  40         /**
  41          * This method declaration for getting all ApiKey that has generated on
  42          * server.
  43          *
  44          * @param dmaapContext
  45          * @throws ConfigDbException
  46          * @throws IOException
  47          */
  48
  49         public void getAllApiKeys(DMaaPContext dmaapContext)
  50                         throws ConfigDbException, IOException;
  51
  52         /**
  53          * Getting information about specific ApiKey
  54          *
  55          * @param dmaapContext
  56          * @param apikey
  57          * @throws ConfigDbException
  58          * @throws IOException
  59          */
  60
  61         public void getApiKey(DMaaPContext dmaapContext, String apikey)
  62                         throws ConfigDbException, IOException;
  63
  64         /**
  65          * Thid method is used for create a particular ApiKey
  66          *
  67          * @param dmaapContext
  68          * @param nsaApiKey
  69          * @throws KeyExistsException
  70          * @throws ConfigDbException
  71          * @throws IOException
  72          */
  73
  74         public void createApiKey(DMaaPContext dmaapContext, ApiKeyBean nsaApiKey)
  75                         throws KeyExistsException, ConfigDbException, IOException;
  76
  77         /**
  78          * This method is used for update ApiKey that is already generated on
  79          * server.
  80          *
  81          * @param dmaapContext
  82          * @param apikey
  83          * @param nsaApiKey
  84          * @throws ConfigDbException
  85          * @throws IOException
  86          * @throws AccessDeniedException
  87          * @throws com.att.nsa.security.ReadWriteSecuredResource.AccessDeniedException
  88          */
  89         public void updateApiKey(DMaaPContext dmaapContext, String apikey,
  90                         ApiKeyBean nsaApiKey) throws ConfigDbException, IOException,AccessDeniedException
  91                         ;
  92
  93         /**
  94          * This method is used for delete specific ApiKey
  95          *
  96          * @param dmaapContext
  97          * @param apikey
  98          * @throws ConfigDbException
  99          * @throws IOException
 100          * @throws AccessDeniedException
 101          */
 102
 103         public void deleteApiKey(DMaaPContext dmaapContext, String apikey)
 104                         throws ConfigDbException, IOException,AccessDeniedException;
 105 }