com.ingenico.connect.gateway.sdk.java.logging.LogMessageBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of connect-sdk-java Show documentation

SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API

There is a newer version: 6.47.0

package com.ingenico.connect.gateway.sdk.java.logging;

import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
import java.nio.charset.Charset;

/**
 * A utility class to build log messages.
 */
public abstract class LogMessageBuilder {

	private final String requestId;
	private final StringBuilder headers;

	private String body;
	private String contentType;

	private final BodyObfuscator bodyObfuscator;
	private final HeaderObfuscator headerObfuscator;

	/**
	 * @deprecated Use {@link #LogMessageBuilder(String, BodyObfuscator, HeaderObfuscator)} instead.
	 */
	@Deprecated
	protected LogMessageBuilder(String requestId) {
		this(requestId, BodyObfuscator.defaultObfuscator(), HeaderObfuscator.defaultObfuscator());
	}

	protected LogMessageBuilder(String requestId, BodyObfuscator bodyObfuscator, HeaderObfuscator headerObfuscator) {
		if (requestId == null || requestId.isEmpty()) {
			throw new IllegalArgumentException("requestId is required");
		}
		if (bodyObfuscator == null) {
			throw new IllegalArgumentException("bodyObfuscator is required");
		}
		if (headerObfuscator == null) {
			throw new IllegalArgumentException("headerObfuscator is required");
		}

		this.requestId = requestId;
		this.headers = new StringBuilder();
		this.bodyObfuscator = bodyObfuscator;
		this.headerObfuscator = headerObfuscator;
	}

	protected final String requestId() {
		return requestId;
	}

	protected final String headers() {
		return headers.toString();
	}

	protected final String body() {
		return body;
	}

	protected final String contentType() {
		return contentType;
	}

	public final void addHeader(String name, String value) {

		if (headers.length() > 0) {
			headers.append(", ");
		}

		headers.append(name);
		headers.append("=\"");
		if (value != null) {
			String obfuscatedValue = headerObfuscator.obfuscateHeader(name, value);
			headers.append(obfuscatedValue);
		}
		headers.append('"');
	}

	public final void setBody(String body, String contentType) {
		this.body = bodyObfuscator.obfuscateBody(body);
		this.contentType = contentType;
	}

	public final void setBody(InputStream bodyStream, Charset charset, String contentType) throws IOException {
		this.body = isBinaryContent(contentType) ? "" : bodyObfuscator.obfuscateBody(bodyStream, charset);
		this.contentType = contentType;
	}

	public final void setBinaryContentBody(String contentType) {
		if (!isBinaryContent(contentType)) {
			throw new IllegalArgumentException("Not a binary content type: " + contentType);
		}
		this.body = "";
		this.contentType = contentType;
	}

	private static boolean isBinaryContent(String contentType) {
		return contentType != null
				&& !contentType.startsWith("text/")
				&& !contentType.contains("json")
				&& !contentType.contains("xml");
	}

	public final void setBody(Reader bodyStream, String contentType) throws IOException {
		this.body = bodyObfuscator.obfuscateBody(bodyStream);
		this.contentType = contentType;
	}

	public abstract String getMessage();

	protected final String emptyIfNull(String value) {
		return value != null ? value : "";
	}
}