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