com.ocarlsen.logging.http.client.apache.RequestLoggingInterceptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of client-apache Show documentation
Classes to assist HTTP request/response logging for Apache client.
There is a newer version: 1.0.1
package com.ocarlsen.logging.http.client.apache;

import com.ocarlsen.logging.http.GzipContentEnablingEntity;
import org.apache.http.Header;
import org.apache.http.HeaderElement;
import org.apache.http.HttpEntity;
import org.apache.http.HttpEntityEnclosingRequest;
import org.apache.http.HttpRequest;
import org.apache.http.HttpRequestInterceptor;
import org.apache.http.client.entity.EntityBuilder;
import org.apache.http.client.entity.GzipCompressingEntity;
import org.apache.http.client.entity.GzipDecompressingEntity;
import org.apache.http.protocol.HttpContext;
import org.apache.http.util.EntityUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;

import static java.lang.invoke.MethodHandles.lookup;
import static java.nio.charset.StandardCharsets.UTF_8;

public class RequestLoggingInterceptor implements HttpRequestInterceptor {

    private static final Logger LOGGER = LoggerFactory.getLogger(lookup().lookupClass());

    @Override
    public void process(final HttpRequest httpRequest, final HttpContext httpContext) throws IOException {
        logRequest(httpRequest);
    }

    private void logRequest(final HttpRequest request) throws IOException {
        LOGGER.debug("Method  : {}", request.getRequestLine().getMethod());
        LOGGER.debug("URL     : {}", request.getRequestLine().getUri());

        final String headersFormatted = formatHeaders(request.getAllHeaders());
        LOGGER.debug("Headers : {}", headersFormatted);

        final String body;
        if (request instanceof HttpEntityEnclosingRequest) {
            HttpEntity entity = ((HttpEntityEnclosingRequest) request).getEntity();

            // TODO: Generalize this, replicate for other clients
            // TODO: Test
            // Handle content encoding
            final Header contentEncodingHeader = entity.getContentEncoding();
            if (contentEncodingHeader != null) {
                final HeaderElement[] encodings = contentEncodingHeader.getElements();
                for (final HeaderElement encoding : encodings) {
                    if (encoding.getName().equalsIgnoreCase("gzip")) {

                        // In case of GzipCompressingEntity, need to wrap so GzipDecompressingEntity can read content.
                        if (entity instanceof GzipCompressingEntity) {
                            entity = new GzipContentEnablingEntity((GzipCompressingEntity) entity);
                        }

                        entity = new GzipDecompressingEntity(entity);
                        break;
                    }
                }
            }

            body = EntityUtils.toString(entity, UTF_8);

            // If entity has been consumed, we need to restore.
            if (!entity.isRepeatable()) {
                final HttpEntity repeatableEntity = EntityBuilder.create()
                                                                 .setText(body)
                                                                 // TODO: restore GZIP
                                                                 .build();
                ((HttpEntityEnclosingRequest) request).setEntity(repeatableEntity);
            }
        } else {
            body = "";
        }
        LOGGER.debug("Body    : [{}]", body);
    }


    // TODO: Factor out, this is duplicated
    private String formatHeaders(final Header[] headers) {
        final LinkedHashMap> headerMap = new LinkedHashMap<>();
        for (final Header header : headers) {
            final String headerName = header.getName();
            final String headerValue = header.getValue();
            final List values = headerMap.computeIfAbsent(headerName, key -> new ArrayList<>());
            values.add(headerValue);
        }
        return headerMap.toString();
    }
}