core/src/main/java/com/att/cadi/taf/HttpTaf.java

   1 /*******************************************************************************\r
   2  * ============LICENSE_START====================================================\r
   3  * * org.onap.aai\r
   4  * * ===========================================================================\r
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * * Copyright © 2017 Amdocs\r
   7  * * ===========================================================================\r
   8  * * Licensed under the Apache License, Version 2.0 (the "License");\r
   9  * * you may not use this file except in compliance with the License.\r
  10  * * You may obtain a copy of the License at\r
  11  * * \r
  12  *  *      http://www.apache.org/licenses/LICENSE-2.0\r
  13  * * \r
  14  *  * Unless required by applicable law or agreed to in writing, software\r
  15  * * distributed under the License is distributed on an "AS IS" BASIS,\r
  16  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  17  * * See the License for the specific language governing permissions and\r
  18  * * limitations under the License.\r
  19  * * ============LICENSE_END====================================================\r
  20  * *\r
  21  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  22  * *\r
  23  ******************************************************************************/\r
  24 package com.att.cadi.taf;\r
  25 \r
  26 import javax.servlet.http.HttpServletRequest;\r
  27 import javax.servlet.http.HttpServletResponse;\r
  28 \r
  29 import com.att.cadi.CachedPrincipal;\r
  30 import com.att.cadi.Taf.LifeForm;\r
  31 \r
  32 /**\r
  33  * A TAF which is in a specific HTTP environment in which the engine implements \r
  34  * javax Servlet.\r
  35  * \r
  36  * Using the Http Request and Response interfaces takes the effort out of implementing in almost any kind of\r
  37  * HTTP Container or Engine.\r
  38  *  \r
  39  *\r
  40  */\r
  41 public interface HttpTaf {\r
  42         /**\r
  43          * validate\r
  44          * \r
  45          * Validate the Request, and respond with created TafResp object.\r
  46          * \r
  47          * @param reading\r
  48          * @param req\r
  49          * @param resp\r
  50          * @return\r
  51          */\r
  52         public TafResp validate(LifeForm reading, HttpServletRequest req, HttpServletResponse resp);\r
  53         \r
  54         /**\r
  55          * Re-Validate Credential\r
  56          * \r
  57          * @param prin\r
  58          * @return\r
  59          */\r
  60         public CachedPrincipal.Resp revalidate(CachedPrincipal prin);\r
  61 }\r