blob: 3b15c55dc0d0d55a723896f65615db8b697afc98 (
plain)
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
|
/*******************************************************************************
* ============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.dmf.mr.security;
import com.att.nsa.security.NsaApiKey;
import org.onap.dmaap.dmf.mr.beans.DMaaPContext;
import javax.servlet.http.HttpServletRequest;
/**
* An interface for authenticating an inbound request.
* @author nilanjana.maity
*
* @param <K> NsaApiKey
*/
public interface DMaaPAuthenticator<K extends NsaApiKey> {
/**
* Qualify a request as possibly using the authentication method that this class implements.
* @param req
* @return true if the request might be authenticated by this class
*/
boolean qualify ( HttpServletRequest req );
/**
* Check for a request being authentic. If it is, return the API key. If not, return null.
* @param req An inbound web request
* @return the API key for an authentic request, or null
*/
K isAuthentic ( HttpServletRequest req );
/**
* Check for a ctx being authenticate. If it is, return the API key. If not, return null.
* @param ctx
* @return the API key for an authentication request, or null
*/
K authenticate ( DMaaPContext ctx );
void addAuthenticator(DMaaPAuthenticator<K> a);
}
|
