Package com.google.openrtb.snippet

Class SnippetProcessor

java.lang.Object

com.google.openrtb.snippet.SnippetProcessor

Direct Known Subclasses:

OpenRtbSnippetProcessor

public abstract class SnippetProcessor
extends Object

Supports preprocessing for "snippets" of textual information, in particular for various String fields from the response OpenRtb.BidResponse.SeatBid.Bids such as the ad markup, URLs and IDs. Additionally, you can use the syntax %{...}% for URL encoding. Nesting can be used, e.g. %{A%{B}%}% will encode A and doubly-encode B. This nesting is typically necessary when URLs have parameter that contain other URLs, so each server decodes and redirects to the next URL.

This class is threadsafe, and all concrete subclasses have to be too.

Field Summary

Fields

Modifier and Type	Field	Description
static SnippetProcessor	NULL

Constructor Summary

Constructors

Constructor	Description
SnippetProcessor()

Method Summary

Modifier and Type	Method	Description
static com.google.common.escape.Escaper	getEscaper()
String	process(SnippetProcessorContext ctx, String snippet)	Processes the raw snippet that was set by the bid, making any transformations necessary.
protected abstract boolean	processMacroAt(SnippetProcessorContext ctx, SnippetMacroType macroDef)
protected List<SnippetMacroType>	registerMacros()
String	toString()
protected com.google.common.base.MoreObjects.ToStringHelper	toStringHelper()
protected static String	urlEncode(SnippetProcessorContext ctx, String snippet)

Methods inherited from class java.lang.Object

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

Field Detail

NULL

public static final SnippetProcessor NULL

Constructor Detail

SnippetProcessor

public SnippetProcessor()

Method Detail

registerMacros

protected List<SnippetMacroType> registerMacros()

getEscaper

public static com.google.common.escape.Escaper getEscaper()

process

public String process(SnippetProcessorContext ctx,
                      String snippet)

Processes the raw snippet that was set by the bid, making any transformations necessary.

processMacroAt

protected abstract boolean processMacroAt(SnippetProcessorContext ctx,
                                          SnippetMacroType macroDef)

urlEncode

protected static String urlEncode(SnippetProcessorContext ctx,
                                  String snippet)

toString

public final String toString()

Overrides:

toString in class Object

toStringHelper

protected com.google.common.base.MoreObjects.ToStringHelper toStringHelper()