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.security;
24 import com.att.nsa.security.NsaApiKey;
25 import org.onap.dmaap.dmf.mr.beans.DMaaPContext;
27 import javax.servlet.http.HttpServletRequest;
31 * An interface for authenticating an inbound request.
32 * @author nilanjana.maity
34 * @param <K> NsaApiKey
36 public interface DMaaPAuthenticator<K extends NsaApiKey> {
39 * Qualify a request as possibly using the authentication method that this class implements.
41 * @return true if the request might be authenticated by this class
43 boolean qualify ( HttpServletRequest req );
46 * Check for a request being authentic. If it is, return the API key. If not, return null.
47 * @param req An inbound web request
48 * @return the API key for an authentic request, or null
50 K isAuthentic ( HttpServletRequest req );
52 * Check for a ctx being authenticate. If it is, return the API key. If not, return null.
54 * @return the API key for an authentication request, or null
56 K authenticate ( DMaaPContext ctx );
59 void addAuthenticator(DMaaPAuthenticator<K> a);