2 * ============LICENSE_START=======================================================
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.onap.so.logging.jaxrs.filter;
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;
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;
42 import org.onap.so.logger.MsoLogger;
43 import org.slf4j.Logger;
44 import org.slf4j.LoggerFactory;
49 public class PayloadLoggingFilter implements ClientRequestFilter, ClientResponseFilter, WriterInterceptor {
51 private static final Logger logger = LoggerFactory.getLogger(PayloadLoggingFilter.class);
52 private static final String ENTITY_STREAM_PROPERTY = "LoggingFilter.entityStream";
53 private static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
54 private final int maxEntitySize;
56 public PayloadLoggingFilter() {
57 maxEntitySize = 1024 * 1024;
60 public PayloadLoggingFilter(int maxPayloadSize) {
61 this.maxEntitySize = Integer.min(maxPayloadSize, 1024 * 1024);
64 private void log(StringBuilder sb) {
65 logger.debug(sb.toString());
68 protected InputStream logInboundEntity(final StringBuilder b, InputStream stream, final Charset charset)
70 if (!stream.markSupported()) {
71 stream = new BufferedInputStream(stream);
73 stream.mark(maxEntitySize + 1);
74 final byte[] entity = new byte[maxEntitySize + 1];
75 final int entitySize = stream.read(entity);
76 if (entitySize != -1) {
77 b.append(new String(entity, 0, Math.min(entitySize, maxEntitySize), charset));
79 if (entitySize > maxEntitySize) {
80 b.append("...more...");
88 public void filter(ClientRequestContext requestContext) throws IOException {
89 if (requestContext.hasEntity()) {
90 final OutputStream stream = new LoggingStream(requestContext.getEntityStream());
91 requestContext.setEntityStream(stream);
92 requestContext.setProperty(ENTITY_STREAM_PROPERTY, stream);
94 String method = formatMethod(requestContext);
95 log(new StringBuilder("Making " + method + " request to: " + requestContext.getUri() + "\nRequest Headers: " + requestContext.getHeaders().toString()));
100 public void filter(ClientRequestContext requestContext, ClientResponseContext responseContext) throws IOException {
101 final StringBuilder sb = new StringBuilder();
102 if (responseContext.hasEntity()) {
103 responseContext.setEntityStream(logInboundEntity(sb, responseContext.getEntityStream(), DEFAULT_CHARSET));
104 String method = formatMethod(requestContext);
105 log(sb.insert(0, "Response from " + method + ": " + requestContext.getUri() + "\nResponse Headers: " + responseContext.getHeaders().toString()));
110 public void aroundWriteTo(WriterInterceptorContext context) throws IOException, WebApplicationException {
111 final LoggingStream stream = (LoggingStream) context.getProperty(ENTITY_STREAM_PROPERTY);
113 if (stream != null) {
114 log(stream.getStringBuilder(DEFAULT_CHARSET));
118 private class LoggingStream extends FilterOutputStream {
120 private final StringBuilder sb = new StringBuilder();
121 private final ByteArrayOutputStream baos = new ByteArrayOutputStream();
123 LoggingStream(OutputStream out) {
127 StringBuilder getStringBuilder(Charset charset) {
128 // write entity to the builder
129 final byte[] entity = baos.toByteArray();
131 sb.append(new String(entity, 0, entity.length, charset));
132 if (entity.length > maxEntitySize) {
133 sb.append("...more...");
141 public void write(final int i) throws IOException {
142 if (baos.size() <= maxEntitySize) {
149 private String formatMethod(ClientRequestContext requestContext) {
150 String method = requestContext.getHeaderString("X-HTTP-Method-Override");
151 if (method == null) {
152 method = requestContext.getMethod();
154 method = requestContext.getMethod() + " (overridden to " + method + ")";