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 org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(PayloadLoggingServletFilter.class);
52 private static class ByteArrayServletStream extends ServletOutputStream {
53 ByteArrayOutputStream baos;
55 ByteArrayServletStream(ByteArrayOutputStream baos) {
60 public void write(int param) throws IOException {
65 public boolean isReady() {
70 public void setWriteListener(WriteListener arg0) {
71 // this method does nothing
75 private static class ByteArrayPrintWriter extends PrintWriter {
76 private ByteArrayOutputStream baos;
77 private int errorCode = -1;
78 private String errorMsg = "";
79 private boolean errored = false;
81 public ByteArrayPrintWriter(ByteArrayOutputStream out) {
86 public ServletOutputStream getStream() {
87 return new ByteArrayServletStream(baos);
90 public Boolean hasErrored() {
94 public int getErrorCode() {
98 public String getErrorMsg() {
102 public void setError(int code) {
107 public void setError(int code, String msg) {
115 private class BufferedServletInputStream extends ServletInputStream {
116 ByteArrayInputStream bais;
118 public BufferedServletInputStream(ByteArrayInputStream bais) {
123 public int available() {
124 return bais.available();
133 public int read(byte[] buf, int off, int len) {
134 return bais.read(buf, off, len);
138 public boolean isFinished() {
139 return available() < 1;
143 public boolean isReady() {
148 public void setReadListener(ReadListener arg0) {
149 // this method does nothing
154 private class BufferedRequestWrapper extends HttpServletRequestWrapper {
155 ByteArrayInputStream bais;
156 ByteArrayOutputStream baos;
157 BufferedServletInputStream bsis;
160 public BufferedRequestWrapper(HttpServletRequest req) throws IOException {
163 InputStream is = req.getInputStream();
164 baos = new ByteArrayOutputStream();
165 byte[] buf = new byte[1024];
167 while ((letti = is.read(buf)) > 0) {
168 baos.write(buf, 0, letti);
170 buffer = baos.toByteArray();
174 public ServletInputStream getInputStream() {
176 bais = new ByteArrayInputStream(buffer);
177 bsis = new BufferedServletInputStream(bais);
178 } catch (Exception ex) {
179 log.error("Exception in getInputStream", ex);
184 public byte[] getBuffer() {
190 public void init(FilterConfig filterConfig) throws ServletException {
191 // this method does nothing
195 public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
196 throws IOException, ServletException {
197 final HttpServletRequest httpRequest = (HttpServletRequest) servletRequest;
198 BufferedRequestWrapper bufferedRequest = new BufferedRequestWrapper(httpRequest);
200 StringBuilder requestHeaders = new StringBuilder("REQUEST|");
201 requestHeaders.append(httpRequest.getMethod());
202 requestHeaders.append(":");
203 requestHeaders.append(httpRequest.getRequestURL().toString());
204 requestHeaders.append("|");
205 requestHeaders.append(getSecureRequestHeaders(httpRequest));
206 log.info(requestHeaders.toString());
208 log.info("REQUEST BODY|" + new String(bufferedRequest.getBuffer()));
210 final HttpServletResponse response = (HttpServletResponse) servletResponse;
211 final ByteArrayOutputStream baos = new ByteArrayOutputStream();
212 final ByteArrayPrintWriter pw = new ByteArrayPrintWriter(baos);
214 HttpServletResponse wrappedResp = new HttpServletResponseWrapper(response) {
216 public PrintWriter getWriter() {
221 public ServletOutputStream getOutputStream() {
222 return pw.getStream();
226 public void sendError(int sc) throws IOException {
233 public void sendError(int sc, String msg) throws IOException {
234 super.sendError(sc, msg);
235 pw.setError(sc, msg);
240 filterChain.doFilter(bufferedRequest, wrappedResp);
241 } catch (Exception e) {
242 log.error("Chain Exception", e);
246 byte[] bytes = baos.toByteArray();
247 StringBuilder responseHeaders = new StringBuilder("RESPONSE HEADERS|");
248 responseHeaders.append(formatResponseHeaders(response));
249 responseHeaders.append("Status:");
250 responseHeaders.append(response.getStatus());
251 responseHeaders.append(";IsCommited:" + wrappedResp.isCommitted());
253 log.info(responseHeaders.toString());
255 if ("gzip".equals(response.getHeader("Content-Encoding"))) {
256 log.info("UNGZIPED RESPONSE BODY|" + decompressGZIPByteArray(bytes));
258 log.info("RESPONSE BODY|" + new String(bytes));
261 if (pw.hasErrored()) {
262 log.info("ERROR RESPONSE|" + pw.getErrorCode() + ":" + pw.getErrorMsg());
264 if (!wrappedResp.isCommitted()) {
265 response.getOutputStream().write(bytes);
266 response.getOutputStream().flush();
269 } catch (Exception e) {
270 log.error("Exception in response filter", e);
276 public void destroy() {
277 // this method does nothing
280 private String decompressGZIPByteArray(byte[] bytes) {
281 BufferedReader in = null;
282 InputStreamReader inR = null;
283 ByteArrayInputStream byteS = null;
284 GZIPInputStream gzS = null;
285 StringBuilder str = new StringBuilder();
287 byteS = new ByteArrayInputStream(bytes);
288 gzS = new GZIPInputStream(byteS);
289 inR = new InputStreamReader(gzS);
290 in = new BufferedReader(inR);
294 while ((content = in.readLine()) != null) {
299 } catch (Exception e) {
300 log.error("Failed get read GZIPInputStream", e);
305 } catch (IOException e1) {
306 log.error("Failed to close ByteStream", e1);
311 } catch (IOException e2) {
312 log.error("Failed to close GZStream", e2);
317 } catch (IOException e3) {
318 log.error("Failed to close InputReader", e3);
323 } catch (IOException e) {
324 log.error("Failed to close BufferedReader", e);
327 return str.toString();