2 * ============LICENSE_START=======================================================
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.onap.vid.controller.filter;
24 import com.google.common.collect.ImmutableList;
25 import org.apache.commons.lang3.StringUtils;
26 import org.springframework.web.filter.GenericFilterBean;
28 import javax.servlet.FilterChain;
29 import javax.servlet.ServletException;
30 import javax.servlet.ServletRequest;
31 import javax.servlet.ServletResponse;
32 import javax.servlet.annotation.WebFilter;
33 import javax.servlet.http.HttpServletRequest;
34 import javax.servlet.http.HttpServletRequestWrapper;
35 import javax.servlet.http.HttpServletResponse;
36 import java.io.IOException;
37 import java.util.Collections;
38 import java.util.Enumeration;
39 import java.util.UUID;
41 import static org.onap.portalsdk.core.util.SystemProperties.ECOMP_REQUEST_ID;
43 @WebFilter(urlPatterns = "/*")
44 public class PromiseEcompRequestIdFilter extends GenericFilterBean {
46 private static final String REQUEST_ID_RESPONSE_HEADER = ECOMP_REQUEST_ID + "-echo";
50 public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
51 throws IOException, ServletException {
53 if (request instanceof HttpServletRequest) {
54 request = wrapIfNeeded(request);
56 if (response instanceof HttpServletResponse) {
57 final String actualRequestId = ((HttpServletRequest) request).getHeader(ECOMP_REQUEST_ID);
58 ((HttpServletResponse) response).addHeader(REQUEST_ID_RESPONSE_HEADER, actualRequestId);
62 chain.doFilter(request, response);
65 public static ServletRequest wrapIfNeeded(ServletRequest request) {
66 final HttpServletRequest httpRequest = (HttpServletRequest) request;
67 final String originalRequestId = httpRequest.getHeader(ECOMP_REQUEST_ID);
69 if (StringUtils.isEmpty(originalRequestId) || !verifyAndValidateUuid(originalRequestId)) {
70 request = new PromiseEcompRequestIdRequestWrapper(httpRequest);
76 public static boolean verifyAndValidateUuid(String value)
78 String uuidRegex = "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}";
79 return value.matches(uuidRegex);
82 private static class PromiseEcompRequestIdRequestWrapper extends HttpServletRequestWrapper {
84 private final UUID requestId;
86 PromiseEcompRequestIdRequestWrapper(HttpServletRequest request) {
88 requestId = UUID.randomUUID();
92 public String getHeader(String name) {
93 return isRequestIdHeaderName(name) ?
94 requestId.toString() : super.getHeader(name);
98 public Enumeration<String> getHeaders(String name) {
99 if (isRequestIdHeaderName(name)) {
100 return Collections.enumeration(Collections.singleton(requestId.toString()));
102 return super.getHeaders(name);
107 public Enumeration<String> getHeaderNames() {
109 if (null == super.getHeader(ECOMP_REQUEST_ID)) {
110 return Collections.enumeration(ImmutableList.<String>builder()
111 .add(ECOMP_REQUEST_ID)
112 .addAll(Collections.list(super.getHeaderNames()))
116 return super.getHeaderNames();
119 private boolean isRequestIdHeaderName(String name) {
120 return ECOMP_REQUEST_ID.equalsIgnoreCase(name);