authz-core/src/main/java/com/att/cssa/rserv/HttpCode.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.cssa.rserv;\r
  25 \r
  26 import javax.servlet.http.HttpServletRequest;\r
  27 import javax.servlet.http.HttpServletResponse;\r
  28 \r
  29 import com.att.inno.env.Trans;\r
  30 \r
  31 /**\r
  32  * HTTP Code element, which responds to the essential "handle Method".\r
  33  * \r
  34  * Use Native HttpServletRe[quest|sponse] calls for questions like QueryParameters (getParameter, etc)\r
  35  * \r
  36  * Use local "pathParam" method to obtain in an optimized manner the path parameter, which must be interpreted by originating string\r
  37  * \r
  38  * i.e. my/path/:id/:other/*\r
  39  * \r
  40  *\r
  41  * @param <TRANS>\r
  42  * @param <T>\r
  43  */\r
  44 public abstract class HttpCode<TRANS extends Trans, CONTEXT> {\r
  45         protected CONTEXT context;\r
  46         private String desc;\r
  47         protected String [] roles;\r
  48         private boolean all;\r
  49         \r
  50         // Package by design... Set by Route when linked\r
  51         Match match;\r
  52         \r
  53         public HttpCode(CONTEXT context, String description, String ... roles) {\r
  54                 this.context = context;\r
  55                 desc = description;\r
  56                 \r
  57                 // Evaluate for "*" once...\r
  58                 all = false;\r
  59                 for(String srole : roles) {\r
  60                         if("*".equals(srole)) {\r
  61                                 all = true;\r
  62                                 break;\r
  63                         }\r
  64                 }\r
  65                 this.roles = all?null:roles;\r
  66         }\r
  67         \r
  68         public abstract void handle(TRANS trans, HttpServletRequest req, HttpServletResponse resp) throws Exception;\r
  69         \r
  70         public String desc() {\r
  71                 return desc;\r
  72         }\r
  73         \r
  74         /**\r
  75          * Get the variable element out of the Path Parameter, as set by initial Code\r
  76          * \r
  77          * @param req\r
  78          * @param key\r
  79          * @return\r
  80          */\r
  81         public String pathParam(HttpServletRequest req, String key) {\r
  82                 return match.param(req.getPathInfo(), key);\r
  83         }\r
  84 \r
  85         // Note: get Query Params from Request\r
  86         \r
  87         /**\r
  88          * Check for Authorization when set.\r
  89          * \r
  90          * If no Roles set, then accepts all users\r
  91          * \r
  92          * @param req\r
  93          * @return\r
  94          */\r
  95         public boolean isAuthorized(HttpServletRequest req) {\r
  96                 if(all)return true;\r
  97                 if(roles!=null) {\r
  98                         for(String srole : roles) {\r
  99                                 if(req.isUserInRole(srole)) return true;\r
 100                         }\r
 101                 }\r
 102                 return false;\r
 103         }\r
 104         \r
 105         public boolean no_cache() {\r
 106                 return false;\r
 107         }\r
 108         \r
 109         public String toString() {\r
 110                 return desc;\r
 111         }\r
 112 }\r