authz-core/src/main/java/com/att/cssa/rserv/TransOnlyFilter.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 java.io.IOException;\r
  27 import java.security.Principal;\r
  28 \r
  29 import javax.servlet.Filter;\r
  30 import javax.servlet.FilterChain;\r
  31 import javax.servlet.FilterConfig;\r
  32 import javax.servlet.ServletException;\r
  33 import javax.servlet.ServletRequest;\r
  34 import javax.servlet.ServletResponse;\r
  35 \r
  36 import com.att.inno.env.TimeTaken;\r
  37 import com.att.inno.env.TransStore;\r
  38 \r
  39 /**\r
  40  * Create a new Transaction Object for each and every incoming Transaction\r
  41  * \r
  42  * Attach to Request.  User "FilterHolder" mechanism to retain single instance.\r
  43  * \r
  44  * TransFilter includes CADIFilter as part of the package, so that it can\r
  45  * set User Data, etc, as necessary.\r
  46  * \r
  47  *\r
  48  */\r
  49 public abstract class TransOnlyFilter<TRANS extends TransStore> implements Filter {\r
  50         @Override\r
  51         public void init(FilterConfig filterConfig) throws ServletException {\r
  52         }\r
  53         \r
  54 \r
  55 \r
  56         protected abstract TRANS newTrans();\r
  57         protected abstract TimeTaken start(TRANS trans, ServletRequest request);\r
  58         protected abstract void authenticated(TRANS trans, Principal p);\r
  59         protected abstract void tallyHo(TRANS trans);\r
  60         \r
  61         @Override\r
  62         public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {\r
  63                 TRANS trans = newTrans();\r
  64                 \r
  65                 TimeTaken overall = start(trans,request);\r
  66                 try {\r
  67                         request.setAttribute(TransFilter.TRANS_TAG, trans);\r
  68                         chain.doFilter(request, response);\r
  69                 } finally {\r
  70                         overall.done();\r
  71                 }\r
  72                 tallyHo(trans);\r
  73         }\r
  74 \r
  75         @Override\r
  76         public void destroy() {\r
  77         };\r
  78 }\r