src/main/java/com/att/dmf/mr/security/DMaaPAuthenticator.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 com.att.dmf.mr.security;
  23
  24 import javax.servlet.http.HttpServletRequest;
  25
  26 import com.att.dmf.mr.beans.DMaaPContext;
  27 import com.att.nsa.security.NsaApiKey;
  28
  29
  30 /**
  31  * An interface for authenticating an inbound request.
  32  * @author nilanjana.maity
  33  *
  34  * @param <K> NsaApiKey
  35  */
  36 public interface DMaaPAuthenticator<K extends NsaApiKey> {
  37
  38         /**
  39          * Qualify a request as possibly using the authentication method that this class implements.
  40          * @param req
  41          * @return true if the request might be authenticated by this class
  42          */
  43         boolean qualify ( HttpServletRequest req );
  44
  45         /**
  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
  49          */
  50         K isAuthentic ( HttpServletRequest req );
  51         /**
  52          * Check for a ctx being authenticate. If it is, return the API key. If not, return null.
  53          * @param ctx
  54          * @return the API key for an authentication request, or null
  55          */
  56         K authenticate ( DMaaPContext ctx );
  57
  58
  59         void addAuthenticator(DMaaPAuthenticator<K> a);
  60
  61 }