authz-core/src/main/java/org/onap/aaf/cssa/rserv/HttpCode.java

   1 /*******************************************************************************\r
   2  * ============LICENSE_START====================================================\r
   3  * * org.onap.aaf\r
   4  * * ===========================================================================\r
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * * ===========================================================================\r
   7  * * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * * you may not use this file except in compliance with the License.\r
   9  * * You may obtain a copy of the License at\r
  10  * * \r
  11  *  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  * * \r
  13  *  * Unless required by applicable law or agreed to in writing, software\r
  14  * * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * * See the License for the specific language governing permissions and\r
  17  * * limitations under the License.\r
  18  * * ============LICENSE_END====================================================\r
  19  * *\r
  20  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  21  * *\r
  22  ******************************************************************************/\r
  23 package org.onap.aaf.cssa.rserv;\r
  24 \r
  25 import javax.servlet.http.HttpServletRequest;\r
  26 import javax.servlet.http.HttpServletResponse;\r
  27 \r
  28 import org.onap.aaf.inno.env.Trans;\r
  29 \r
  30 /**\r
  31  * HTTP Code element, which responds to the essential "handle Method".\r
  32  * \r
  33  * Use Native HttpServletRe[quest|sponse] calls for questions like QueryParameters (getParameter, etc)\r
  34  * \r
  35  * Use local "pathParam" method to obtain in an optimized manner the path parameter, which must be interpreted by originating string\r
  36  * \r
  37  * i.e. my/path/:id/:other/*\r
  38  * \r
  39  *\r
  40  * @param <TRANS>\r
  41  * @param <T>\r
  42  */\r
  43 public abstract class HttpCode<TRANS extends Trans, CONTEXT> {\r
  44         protected CONTEXT context;\r
  45         private String desc;\r
  46         protected String [] roles;\r
  47         private boolean all;\r
  48         \r
  49         // Package by design... Set by Route when linked\r
  50         Match match;\r
  51         \r
  52         public HttpCode(CONTEXT context, String description, String ... roles) {\r
  53                 this.context = context;\r
  54                 desc = description;\r
  55                 \r
  56                 // Evaluate for "*" once...\r
  57                 all = false;\r
  58                 for(String srole : roles) {\r
  59                         if("*".equals(srole)) {\r
  60                                 all = true;\r
  61                                 break;\r
  62                         }\r
  63                 }\r
  64                 this.roles = all?null:roles;\r
  65         }\r
  66         \r
  67         public abstract void handle(TRANS trans, HttpServletRequest req, HttpServletResponse resp) throws Exception;\r
  68         \r
  69         public String desc() {\r
  70                 return desc;\r
  71         }\r
  72         \r
  73         /**\r
  74          * Get the variable element out of the Path Parameter, as set by initial Code\r
  75          * \r
  76          * @param req\r
  77          * @param key\r
  78          * @return\r
  79          */\r
  80         public String pathParam(HttpServletRequest req, String key) {\r
  81                 return match.param(req.getPathInfo(), key);\r
  82         }\r
  83 \r
  84         // Note: get Query Params from Request\r
  85         \r
  86         /**\r
  87          * Check for Authorization when set.\r
  88          * \r
  89          * If no Roles set, then accepts all users\r
  90          * \r
  91          * @param req\r
  92          * @return\r
  93          */\r
  94         public boolean isAuthorized(HttpServletRequest req) {\r
  95                 if(all)return true;\r
  96                 if(roles!=null) {\r
  97                         for(String srole : roles) {\r
  98                                 if(req.isUserInRole(srole)) return true;\r
  99                         }\r
 100                 }\r
 101                 return false;\r
 102         }\r
 103         \r
 104         public boolean no_cache() {\r
 105                 return false;\r
 106         }\r
 107         \r
 108         public String toString() {\r
 109                 return desc;\r
 110         }\r
 111 }\r