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