aai-els-onap-logging/src/main/java/org/onap/logging/filter/base/PayloadLoggingClientFilter.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - Logging
   4  * ================================================================================
   5  * Copyright (C) 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.logging.filter.base;
  22
  23 import java.io.BufferedInputStream;
  24 import java.io.ByteArrayOutputStream;
  25 import java.io.FilterOutputStream;
  26 import java.io.IOException;
  27 import java.io.InputStream;
  28 import java.io.OutputStream;
  29 import java.nio.charset.Charset;
  30 import java.nio.charset.StandardCharsets;
  31 import javax.ws.rs.WebApplicationException;
  32 import javax.ws.rs.client.ClientRequestContext;
  33 import javax.ws.rs.client.ClientRequestFilter;
  34 import javax.ws.rs.client.ClientResponseContext;
  35 import javax.ws.rs.client.ClientResponseFilter;
  36 import javax.ws.rs.core.HttpHeaders;
  37 import javax.ws.rs.core.MultivaluedHashMap;
  38 import javax.ws.rs.core.MultivaluedMap;
  39 import javax.ws.rs.ext.WriterInterceptor;
  40 import javax.ws.rs.ext.WriterInterceptorContext;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 public class PayloadLoggingClientFilter implements ClientRequestFilter, ClientResponseFilter, WriterInterceptor {
  45
  46     private static final Logger logger = LoggerFactory.getLogger(PayloadLoggingClientFilter.class);
  47     private static final String ENTITY_STREAM_PROPERTY = "LoggingFilter.entityStream";
  48     private static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
  49     private final int maxEntitySize;
  50
  51     public PayloadLoggingClientFilter() {
  52         maxEntitySize = 1024 * 1024;
  53     }
  54
  55     public PayloadLoggingClientFilter(int maxPayloadSize) {
  56         this.maxEntitySize = Integer.min(maxPayloadSize, 1024 * 1024);
  57     }
  58
  59     protected InputStream logInboundEntity(final StringBuilder b, InputStream stream, final Charset charset)
  60             throws IOException {
  61         if (!stream.markSupported()) {
  62             stream = new BufferedInputStream(stream);
  63         }
  64         stream.mark(maxEntitySize + 1);
  65         final byte[] entity = new byte[maxEntitySize + 1];
  66         final int entitySize = stream.read(entity);
  67         if (entitySize != -1) {
  68             b.append(new String(entity, 0, Math.min(entitySize, maxEntitySize), charset));
  69         }
  70         if (entitySize > maxEntitySize) {
  71             b.append("...more...");
  72         }
  73         b.append('\n');
  74         stream.reset();
  75         return stream;
  76     }
  77
  78     @Override
  79     public void filter(ClientRequestContext requestContext) throws IOException {
  80         if (requestContext.hasEntity()) {
  81             final OutputStream stream = new LoggingStream(requestContext.getEntityStream());
  82             requestContext.setEntityStream(stream);
  83             requestContext.setProperty(ENTITY_STREAM_PROPERTY, stream);
  84         }
  85         String method = formatMethod(requestContext);
  86         logger.debug("Sending HTTP {} to:{} with request headers:{}", method, requestContext.getUri(),
  87                 getHeaders(requestContext.getHeaders()));
  88     }
  89
  90     protected String getHeaders(MultivaluedMap<String, Object> headers) {
  91         MultivaluedMap<String, Object> printHeaders = new MultivaluedHashMap<>();
  92         for (String header : headers.keySet()) {
  93             if (!header.equals(HttpHeaders.AUTHORIZATION)) {
  94                 printHeaders.add(header, headers.getFirst(header));
  95             } else {
  96                 printHeaders.add(header, Constants.REDACTED);;
  97             }
  98         }
  99         return printHeaders.toString();
 100     }
 101
 102     @Override
 103     public void filter(ClientRequestContext requestContext, ClientResponseContext responseContext) throws IOException {
 104         String method = formatMethod(requestContext);
 105         logger.debug("Response from method:{} performed on uri:{} has http status code:{} and response headers:{}",
 106                 method, requestContext.getUri(), responseContext.getStatus(), responseContext.getHeaders().toString());
 107         if (responseContext.hasEntity()) {
 108             final StringBuilder sb = new StringBuilder();
 109             responseContext.setEntityStream(logInboundEntity(sb, responseContext.getEntityStream(), DEFAULT_CHARSET));
 110             logger.debug(sb.toString());
 111         }
 112     }
 113
 114     @Override
 115     public void aroundWriteTo(WriterInterceptorContext context) throws IOException, WebApplicationException {
 116         final LoggingStream stream = (LoggingStream) context.getProperty(ENTITY_STREAM_PROPERTY);
 117         context.proceed();
 118         if (stream != null) {
 119             logger.debug(stream.getStringBuilder(DEFAULT_CHARSET).toString());
 120         }
 121     }
 122
 123     private class LoggingStream extends FilterOutputStream {
 124
 125         private final StringBuilder sb = new StringBuilder();
 126         private final ByteArrayOutputStream baos = new ByteArrayOutputStream();
 127
 128         LoggingStream(OutputStream out) {
 129             super(out);
 130         }
 131
 132         StringBuilder getStringBuilder(Charset charset) {
 133             // write entity to the builder
 134             final byte[] entity = baos.toByteArray();
 135
 136             sb.append(new String(entity, 0, entity.length, charset));
 137             if (entity.length > maxEntitySize) {
 138                 sb.append("...more...");
 139             }
 140             sb.append('\n');
 141
 142             return sb;
 143         }
 144
 145         @Override
 146         public void write(final int i) throws IOException {
 147             if (baos.size() <= maxEntitySize) {
 148                 baos.write(i);
 149             }
 150             out.write(i);
 151         }
 152     }
 153
 154     protected String formatMethod(ClientRequestContext requestContext) {
 155         String httpMethodOverride = requestContext.getHeaderString("X-HTTP-Method-Override");
 156         if (httpMethodOverride == null) {
 157             return requestContext.getMethod();
 158         } else {
 159             return requestContext.getMethod() + " (overridden to " + httpMethodOverride + ")";
 160         }
 161     }
 162 }