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