1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
/*******************************************************************************
* ============LICENSE_START=======================================================
* org.onap.dmaap
* ================================================================================
* Copyright © 2017 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=========================================================
*
* ECOMP is a trademark and service mark of AT&T Intellectual Property.
*
*******************************************************************************/
package org.onap.dmaap.messagerouter.msgrtr.nsa.cambria.service;
import java.io.IOException;
import org.onap.dmaap.messagerouter.msgrtr.nsa.cambria.beans.ApiKeyBean;
import org.onap.dmaap.messagerouter.msgrtr.nsa.cambria.beans.DMaaPContext;
import com.att.nsa.security.ReadWriteSecuredResource.AccessDeniedException;
import com.att.nsa.configs.ConfigDbException;
import com.att.nsa.security.db.NsaApiDb.KeyExistsException;
/**
* Declaring all the method in interface that is mainly used for authentication
* purpose.
*
*
*/
public interface ApiKeysService {
/**
* This method declaration for getting all ApiKey that has generated on
* server.
*
* @param dmaapContext
* @throws ConfigDbException
* @throws IOException
*/
public void getAllApiKeys(DMaaPContext dmaapContext)
throws ConfigDbException, IOException;
/**
* Getting information about specific ApiKey
*
* @param dmaapContext
* @param apikey
* @throws ConfigDbException
* @throws IOException
*/
public void getApiKey(DMaaPContext dmaapContext, String apikey)
throws ConfigDbException, IOException;
/**
* Thid method is used for create a particular ApiKey
*
* @param dmaapContext
* @param nsaApiKey
* @throws KeyExistsException
* @throws ConfigDbException
* @throws IOException
*/
public void createApiKey(DMaaPContext dmaapContext, ApiKeyBean nsaApiKey)
throws KeyExistsException, ConfigDbException, IOException;
/**
* This method is used for update ApiKey that is already generated on
* server.
*
* @param dmaapContext
* @param apikey
* @param nsaApiKey
* @throws ConfigDbException
* @throws IOException
* @throws AccessDeniedException
* @throws com.att.nsa.security.ReadWriteSecuredResource.AccessDeniedException
*/
public void updateApiKey(DMaaPContext dmaapContext, String apikey,
ApiKeyBean nsaApiKey) throws ConfigDbException, IOException,AccessDeniedException
;
/**
* This method is used for delete specific ApiKey
*
* @param dmaapContext
* @param apikey
* @throws ConfigDbException
* @throws IOException
* @throws AccessDeniedException
*/
public void deleteApiKey(DMaaPContext dmaapContext, String apikey)
throws ConfigDbException, IOException,AccessDeniedException;
}
|
