vid-app-common/src/main/java/org/onap/vid/controller/filter/PromiseRequestIdFilter.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * VID
   4  * ================================================================================
   5  * Copyright (C) 2017 - 2019 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.vid.controller.filter;
  22
  23
  24 import static org.onap.portalsdk.core.util.SystemProperties.ECOMP_REQUEST_ID;
  25
  26 import com.google.common.collect.ImmutableList;
  27 import java.io.IOException;
  28 import java.util.Collections;
  29 import java.util.Enumeration;
  30 import java.util.UUID;
  31 import java.util.regex.Pattern;
  32 import javax.servlet.FilterChain;
  33 import javax.servlet.ServletException;
  34 import javax.servlet.ServletRequest;
  35 import javax.servlet.ServletResponse;
  36 import javax.servlet.annotation.WebFilter;
  37 import javax.servlet.http.HttpServletRequest;
  38 import javax.servlet.http.HttpServletRequestWrapper;
  39 import javax.servlet.http.HttpServletResponse;
  40 import org.apache.commons.lang3.StringUtils;
  41 import org.springframework.web.filter.GenericFilterBean;
  42
  43 @WebFilter(urlPatterns = "/*")
  44 public class PromiseRequestIdFilter extends GenericFilterBean {
  45
  46     private static final String REQUEST_ID_RESPONSE_HEADER = ECOMP_REQUEST_ID + "-echo";
  47
  48     private static final Pattern uuidRegex = Pattern.compile("[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}");
  49
  50     @Override
  51     public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
  52             throws IOException, ServletException {
  53
  54         if (request instanceof HttpServletRequest) {
  55             request = wrapIfNeeded(request);
  56
  57             if (response instanceof HttpServletResponse) {
  58                 final String actualRequestId = ((HttpServletRequest) request).getHeader(ECOMP_REQUEST_ID);
  59                 ((HttpServletResponse) response).addHeader(REQUEST_ID_RESPONSE_HEADER, actualRequestId);
  60             }
  61         }
  62
  63         chain.doFilter(request, response);
  64     }
  65
  66     public ServletRequest wrapIfNeeded(ServletRequest request) {
  67         final HttpServletRequest httpRequest = (HttpServletRequest) request;
  68         final String originalRequestId = incomingRequestId(httpRequest);
  69
  70         if (isWrapNeeded(originalRequestId)) {
  71             request = new PromiseRequestIdRequestWrapper(httpRequest);
  72         }
  73
  74         return request;
  75     }
  76
  77     private boolean verifyAndValidateUuid(String value) {
  78         return uuidRegex.matcher(value).matches();
  79     }
  80
  81     protected boolean isWrapNeeded(String originalRequestId) {
  82         return StringUtils.isEmpty(originalRequestId)
  83             || !verifyAndValidateUuid(originalRequestId);
  84     }
  85
  86     protected String incomingRequestId(HttpServletRequest httpRequest) {
  87         return httpRequest.getHeader(ECOMP_REQUEST_ID);
  88     }
  89
  90     private static class PromiseRequestIdRequestWrapper extends HttpServletRequestWrapper {
  91
  92         private final UUID requestId;
  93
  94         PromiseRequestIdRequestWrapper(HttpServletRequest request) {
  95             super(request);
  96             requestId = UUID.randomUUID();
  97         }
  98
  99         @Override
 100         public String getHeader(String name) {
 101             return isRequestIdHeaderName(name) ?
 102                     requestId.toString() : super.getHeader(name);
 103         }
 104
 105         @Override
 106         public Enumeration<String> getHeaders(String name) {
 107             if (isRequestIdHeaderName(name)) {
 108                 return Collections.enumeration(Collections.singleton(requestId.toString()));
 109             } else {
 110                 return super.getHeaders(name);
 111             }
 112         }
 113
 114         @Override
 115         public Enumeration<String> getHeaderNames() {
 116
 117             if (null == super.getHeader(ECOMP_REQUEST_ID)) {
 118                 return Collections.enumeration(ImmutableList.<String>builder()
 119                     .add(ECOMP_REQUEST_ID)
 120                     .addAll(Collections.list(super.getHeaderNames()))
 121                     .build());
 122             }
 123
 124             return super.getHeaderNames();
 125         }
 126
 127         private boolean isRequestIdHeaderName(String name) {
 128             return ECOMP_REQUEST_ID.equalsIgnoreCase(name);
 129         }
 130     }
 131 }