1 /*******************************************************************************
2 * ============LICENSE_START=======================================================
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
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=========================================================
19 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
21 *******************************************************************************/
22 package org.onap.dmaap.dmf.mr.service;
24 import com.att.nsa.configs.ConfigDbException;
25 import com.att.nsa.security.ReadWriteSecuredResource.AccessDeniedException;
26 import com.att.nsa.security.db.NsaApiDb.KeyExistsException;
27 import org.onap.dmaap.dmf.mr.beans.ApiKeyBean;
28 import org.onap.dmaap.dmf.mr.beans.DMaaPContext;
30 import java.io.IOException;
33 * Declaring all the method in interface that is mainly used for authentication
39 public interface ApiKeysService {
41 * This method declaration for getting all ApiKey that has generated on
45 * @throws ConfigDbException
49 public void getAllApiKeys(DMaaPContext dmaapContext)
50 throws ConfigDbException, IOException;
53 * Getting information about specific ApiKey
57 * @throws ConfigDbException
61 public void getApiKey(DMaaPContext dmaapContext, String apikey)
62 throws ConfigDbException, IOException;
65 * Thid method is used for create a particular ApiKey
69 * @throws KeyExistsException
70 * @throws ConfigDbException
74 public void createApiKey(DMaaPContext dmaapContext, ApiKeyBean nsaApiKey)
75 throws KeyExistsException, ConfigDbException, IOException;
78 * This method is used for update ApiKey that is already generated on
84 * @throws ConfigDbException
86 * @throws AccessDeniedException
87 * @throws AccessDeniedException
89 public void updateApiKey(DMaaPContext dmaapContext, String apikey,
90 ApiKeyBean nsaApiKey) throws ConfigDbException, IOException,AccessDeniedException
94 * This method is used for delete specific ApiKey
98 * @throws ConfigDbException
100 * @throws AccessDeniedException
103 public void deleteApiKey(DMaaPContext dmaapContext, String apikey)
104 throws ConfigDbException, IOException,AccessDeniedException;