common/src/main/java/org/onap/so/logging/jaxrs/filter/PayloadLoggingFilter.java

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