2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Modifications Copyright (C) 2018 IBM.
8 * ================================================================================
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
20 * ============LICENSE_END=========================================================
23 package org.onap.logging.filter.base;
25 import java.io.BufferedReader;
26 import java.io.ByteArrayInputStream;
27 import java.io.ByteArrayOutputStream;
28 import java.io.IOException;
29 import java.io.InputStream;
30 import java.io.InputStreamReader;
31 import java.io.PrintWriter;
32 import java.util.zip.GZIPInputStream;
33 import javax.servlet.Filter;
34 import javax.servlet.FilterChain;
35 import javax.servlet.FilterConfig;
36 import javax.servlet.ReadListener;
37 import javax.servlet.ServletException;
38 import javax.servlet.ServletInputStream;
39 import javax.servlet.ServletOutputStream;
40 import javax.servlet.ServletRequest;
41 import javax.servlet.ServletResponse;
42 import javax.servlet.WriteListener;
43 import javax.servlet.http.HttpServletRequest;
44 import javax.servlet.http.HttpServletRequestWrapper;
45 import javax.servlet.http.HttpServletResponse;
46 import javax.servlet.http.HttpServletResponseWrapper;
48 public class PayloadLoggingServletFilter extends AbstractServletFilter implements Filter {
50 private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(PayloadLoggingServletFilter.class);
51 private static final int defaultMaxSize = 100000;
52 private static Integer maxResponseSize;
53 private static Integer maxRequestSize;
55 public PayloadLoggingServletFilter() {
56 String maxRequestSizeOverride = System.getProperty("FILTER_MAX_REQUEST_SIZE");
57 if (maxRequestSizeOverride != null) {
58 maxRequestSize = Integer.valueOf(maxRequestSizeOverride);
60 maxRequestSize = defaultMaxSize;
63 String maxResponseSizeOverride = System.getProperty("FILTER_MAX_RESPONSE_SIZE");
64 if (maxResponseSizeOverride != null) {
65 maxResponseSize = Integer.valueOf(maxResponseSizeOverride);
67 maxResponseSize = defaultMaxSize;
71 private static class ByteArrayServletStream extends ServletOutputStream {
72 ByteArrayOutputStream baos;
74 ByteArrayServletStream(ByteArrayOutputStream baos) {
79 public void write(int param) throws IOException {
84 public boolean isReady() {
89 public void setWriteListener(WriteListener arg0) {
90 // this method does nothing
95 private static class ByteArrayPrintWriter extends PrintWriter {
96 private ByteArrayOutputStream baos;
97 private int errorCode = -1;
98 private String errorMsg = "";
99 private boolean errored = false;
101 public ByteArrayPrintWriter(ByteArrayOutputStream out) {
106 public ServletOutputStream getStream() {
107 return new ByteArrayServletStream(baos);
110 public Boolean hasErrored() {
114 public int getErrorCode() {
118 public String getErrorMsg() {
122 public void setError(int code) {
127 public void setError(int code, String msg) {
136 private class BufferedServletInputStream extends ServletInputStream {
137 ByteArrayInputStream bais;
139 public BufferedServletInputStream(ByteArrayInputStream bais) {
144 public int available() {
145 return bais.available();
154 public int read(byte[] buf, int off, int len) {
155 return bais.read(buf, off, len);
159 public boolean isFinished() {
160 return available() < 1;
164 public boolean isReady() {
169 public void setReadListener(ReadListener arg0) {
170 // this method does nothing
176 private class BufferedRequestWrapper extends HttpServletRequestWrapper {
177 ByteArrayInputStream bais;
178 ByteArrayOutputStream baos;
179 BufferedServletInputStream bsis;
182 public BufferedRequestWrapper(HttpServletRequest req) throws IOException {
185 InputStream is = req.getInputStream();
186 baos = new ByteArrayOutputStream();
187 byte[] buf = new byte[1024];
189 while ((letti = is.read(buf)) > 0) {
190 baos.write(buf, 0, letti);
192 buffer = baos.toByteArray();
196 public ServletInputStream getInputStream() {
198 bais = new ByteArrayInputStream(buffer);
199 bsis = new BufferedServletInputStream(bais);
200 } catch (Exception ex) {
201 log.error("Exception in getInputStream", ex);
206 public byte[] getBuffer() {
212 public void init(FilterConfig filterConfig) throws ServletException {
213 // this method does nothing
217 public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
218 throws IOException, ServletException {
219 final HttpServletRequest httpRequest = (HttpServletRequest) servletRequest;
220 BufferedRequestWrapper bufferedRequest = new BufferedRequestWrapper(httpRequest);
222 StringBuilder requestHeaders = new StringBuilder("REQUEST|");
223 requestHeaders.append(httpRequest.getMethod());
224 requestHeaders.append(":");
225 requestHeaders.append(httpRequest.getRequestURL().toString());
226 requestHeaders.append("|");
227 requestHeaders.append(getSecureRequestHeaders(httpRequest));
229 log.info(requestHeaders.toString());
231 byte[] buffer = bufferedRequest.getBuffer();
232 if (buffer.length < maxRequestSize) {
233 log.info("REQUEST BODY|{}", new String(buffer));
235 log.info("REQUEST BODY|{}", new String(buffer, 0, maxRequestSize));
238 final HttpServletResponse response = (HttpServletResponse) servletResponse;
239 final ByteArrayOutputStream baos = new ByteArrayOutputStream();
240 final ByteArrayPrintWriter pw = new ByteArrayPrintWriter(baos);
242 HttpServletResponse wrappedResp = new HttpServletResponseWrapper(response) {
244 public PrintWriter getWriter() {
249 public ServletOutputStream getOutputStream() {
250 return pw.getStream();
254 public void sendError(int sc) throws IOException {
260 public void sendError(int sc, String msg) throws IOException {
261 super.sendError(sc, msg);
262 pw.setError(sc, msg);
267 filterChain.doFilter(bufferedRequest, wrappedResp);
268 } catch (Exception e) {
269 log.error("Chain Exception", e);
273 byte[] bytes = baos.toByteArray();
274 StringBuilder responseHeaders = new StringBuilder();
275 responseHeaders.append("RESPONSE HEADERS|").append(formatResponseHeaders(response));
276 responseHeaders.append("Status:").append(response.getStatus());
277 responseHeaders.append(";IsCommitted:").append(wrappedResp.isCommitted());
279 log.info(responseHeaders.toString());
281 if ("gzip".equals(response.getHeader("Content-Encoding"))) {
282 log.info("UNGZIPED RESPONSE BODY|{}", decompressGZIPByteArray(bytes));
284 if (bytes.length < maxResponseSize) {
285 log.info("RESPONSE BODY|{}", new String(bytes));
287 log.info("RESPONSE BODY|{}", new String(bytes, 0, maxResponseSize));
291 if (pw.hasErrored()) {
292 log.info("ERROR RESPONSE|{}:{}", pw.getErrorCode(), pw.getErrorMsg());
293 } else if (!wrappedResp.isCommitted()) {
294 response.getOutputStream().write(bytes);
295 response.getOutputStream().flush();
297 } catch (Exception e) {
298 log.error("Exception in response filter", e);
304 public void destroy() {
305 // this method does nothing
308 private String decompressGZIPByteArray(byte[] bytes) {
309 StringBuilder str = new StringBuilder();
310 try (BufferedReader in =
311 new BufferedReader(new InputStreamReader(new GZIPInputStream(new ByteArrayInputStream(bytes))))) {
313 while ((content = in.readLine()) != null) {
316 } catch (Exception e) {
317 log.error("Failed get read GZIPInputStream", e);
319 return str.toString();