com.google.api.ads.common.lib.utils.logging

Class PrettyPrinter

java.lang.Object

com.google.api.ads.common.lib.utils.logging.PrettyPrinter

All Implemented Interfaces:

PrettyPrinterInterface

public final class PrettyPrinter
extends Object
implements PrettyPrinterInterface

A utility class that pretty prints XML messages.

Field Summary

Fields inherited from interface com.google.api.ads.common.lib.utils.logging.PrettyPrinterInterface

NO_OP_PRETTY_PRINTER

Constructor Summary

Constructors

Constructor and Description
PrettyPrinter(com.google.api.ads.common.lib.conf.AdsApiConfiguration adsApiConfiguration, org.slf4j.Logger libLogger, com.google.common.base.Supplier<XPath> xpathSupplier, com.google.common.base.Supplier<Transformer> transformerSupplier, com.google.common.base.Supplier<DocumentBuilder> documentBuilderSupplier) Default constructor used by Guice.

Method Summary

Modifier and Type	Method and Description
String	prettyPrint(String xml) Transforms XML into a pretty-printed format with sensitive strings removed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PrettyPrinter

@Inject
public PrettyPrinter(com.google.api.ads.common.lib.conf.AdsApiConfiguration adsApiConfiguration,
                             org.slf4j.Logger libLogger,
                             com.google.common.base.Supplier<XPath> xpathSupplier,
                             com.google.common.base.Supplier<Transformer> transformerSupplier,
                             com.google.common.base.Supplier<DocumentBuilder> documentBuilderSupplier)

Default constructor used by Guice. Takes Supplier instances for XPath, Transformer, and DocumentBuilder because the corresponding factory objects are not thread-safe. The Guice modules creating these suppliers should guarantee that the Supplier is thread-safe, however.

Parameters:

adsApiConfiguration - the API configuration

libLogger - the logger to use for errors

xpathSupplier - a thread-safe supplier of XPath objects

transformerSupplier - a thread-safe supplier of Transformer objects

documentBuilderSupplier - a thread-safe supplier of DocumentBuilder objects

Method Detail

prettyPrint

public String prettyPrint(String xml)

Transforms XML into a pretty-printed format with sensitive strings removed. If there is an error initializing formatting the XML message, the formatting step will be skipped and the unformatted XML with sensitive strings removed will be returned.

Specified by:

prettyPrint in interface PrettyPrinterInterface

Parameters:

xml - the XML message to be pretty printed

Returns:

the given message in pretty-printed format