ExchangeAdapter

All Known Implementing Classes:

AdaptvAdapter, AdXAdapter, BidSwitchAdapter, BrxAdapter, ExchangeAdapterImpl, LiverailAdapter, Lot49InternalAuctionExchangeAdapter, OpenXAdapter, PubmaticAdapter, SmaatoAdapter, SpotXChangeAdapter, Test1ExchangeAdapter, Test2ExchangeAdapter
```
public interface ExchangeAdapter<RequestType,ResponseType>
```
Interface defining connector to an exchange.

Author:

Gregory Golberg (grisha@alum.mit.edu)
Copyright © Enremmeta LLC 2015. All Rights Reserved.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class ExchangeAdapter.BidChoiceAlgorithm
What to return.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ExchangeAdapter.BidChoiceAlgorithm` What to return.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default String`	`checkExchangeTargeting(OpenRtbRequest req, Impression imp, ExchangeTargeting targeting)` Check any exchange-specific targeting.
`OpenRtbRequest`	`convertRequest(RequestType req)`
`ResponseType`	`convertResponse(OpenRtbRequest req, OpenRtbResponse resp)`
`default void`	`debug(String msg)`
`default void`	`error(String msg)`
`default void`	`error(String msg, Throwable t)`
`default void`	`fillPlatformInfoFromUa(OpenRtbRequest req)`
`default ExchangeAdapter.BidChoiceAlgorithm`	`getBidChoiceAlgorithm()` Defaults to `ExchangeAdapter.BidChoiceAlgorithm.MAX`.
`String`	`getClickEncMacro()`
`String`	`getClickMacro()`
`default long`	`getDefaultTimeout()` What is the default timeout, in milliseconds (default, because timeout can also be provided dynamically as `OpenRtbRequest.getTmax()` on each request, which takes precedence).
`String`	`getName()`
`default javax.ws.rs.core.Response.ResponseBuilder`	`getOptoutBuilder(OpenRtbRequest req)` Get a `Response.ResponseBuilder` proper for the opt-out response for this exchange.
`default String`	`getPartnerInitiatedSyncUrl(String myUserId)`
`String`	`getResponseMediaType()`
`default String`	`getSampleWinningPrice()` Return sample winning price suitable for decoding with `parse(String, long)`
`default String`	`getSeat(Ad ad)`
`String`	`getWinningPriceMacro()` Winning price macro.
`default long`	`getWinTimeout()` How long, in seconds, to wait, before declaring a loss.
`default void`	`info(String msg)`
`default boolean`	`isAggregator()`
`default boolean`	`isMacrosInNurl()`
`default boolean`	`isNurlRequired()` Whether `NUrl is required` (two-step response).
`boolean`	`localUserMapping()` Whether the mapping of `our user ID` to `exchange ID` is stored by us.
`default Map<String,Object>`	`makeExchangeSpecificInstructionsMap()`
`default Bid`	`massageBid(OpenRtbRequest req, Impression imp, Tag tag, Bid bid)` Post-process a bid.
`ParsedPriceInfo`	`parse(String winningPriceString, long bidMicros)`
`default void`	`parseUserId(String userId, OpenRtbRequest req)`
`default javax.ws.rs.core.Response.ResponseBuilder`	`setHeaders(OpenRtbResponse bResp, javax.ws.rs.core.Response.ResponseBuilder builder)`
`default void`	`trace(String msg)`
`default boolean`	`trueWinOnNurlOrImpression()` Whether the true win is known by the `winning price`, gotten either during the call of NUrl or out of band.
`default List<String>`	`validateAd(Ad ad)` For calls from `Ad.validate()`, for example.

- Method Detail
  - parseUserId
```
default void parseUserId(String userId,
                         OpenRtbRequest req)
```
  - makeExchangeSpecificInstructionsMap
```
default Map<String,Object> makeExchangeSpecificInstructionsMap()
```
  - info
```
default void info(String msg)
```
  - debug
```
default void debug(String msg)
```
  - trace
```
default void trace(String msg)
```
  - error
```
default void error(String msg)
```
  - error
```
default void error(String msg,
                   Throwable t)
```
  - fillPlatformInfoFromUa
```
default void fillPlatformInfoFromUa(OpenRtbRequest req)
```
  - getOptoutBuilder
```
default javax.ws.rs.core.Response.ResponseBuilder getOptoutBuilder(OpenRtbRequest req)
```
    Get a Response.ResponseBuilder proper for the opt-out response for this exchange. Default is to send a 204.
  - isMacrosInNurl
```
default boolean isMacrosInNurl()
```
  - setHeaders
```
default javax.ws.rs.core.Response.ResponseBuilder setHeaders(OpenRtbResponse bResp,
                                                             javax.ws.rs.core.Response.ResponseBuilder builder)
```
  - getWinTimeout
```
default long getWinTimeout()
```
    How long, in seconds, to wait, before declaring a loss.
  - getSampleWinningPrice
```
default String getSampleWinningPrice()
```
    Return sample winning price suitable for decoding with parse(String, long)
  - getPartnerInitiatedSyncUrl
```
default String getPartnerInitiatedSyncUrl(String myUserId)
```
  - getBidChoiceAlgorithm
```
default ExchangeAdapter.BidChoiceAlgorithm getBidChoiceAlgorithm()
```
    Defaults to ExchangeAdapter.BidChoiceAlgorithm.MAX.
  - isAggregator
```
default boolean isAggregator()
```
  - getResponseMediaType
```
String getResponseMediaType()
```
  - getName
```
String getName()
```
  - isNurlRequired
```
default boolean isNurlRequired()
```
    Whether NUrl is required (two-step response). Since most exchanges for now accept single-step response (returning the entire markup at once, we default the implementation to false.
    
    See Also:
    
    OpenRTB 2.3, section 4.3
  - trueWinOnNurlOrImpression
```
default boolean trueWinOnNurlOrImpression()
```
    Whether the true win is known by the winning price, gotten either during the call of NUrl or out of band. For example, OpenX does the latter, and so a true Win should be registered in StatsSvc.resultsOpenX(javax.ws.rs.core.UriInfo, String, com.enremmeta.rtb.proto.openx.AuctionResultMessage, String, javax.servlet.http.HttpServletRequest, String, javax.ws.rs.core.HttpHeaders)
    
    See Also:
    
    StatsSvc#nurl(javax.ws.rs.core.UriInfo, String, String, String, String, String, String, String, String, String, String, long, String, String, String, String, String, String, javax.servlet.http.HttpServletRequest, String, String, String, String, String), LogUtils.logWin(String, String, String, String, String, String, String, double, long, long, long, String, String, String, String, String, javax.servlet.http.HttpServletRequest, String, Long, String, java.net.URI, boolean, String, String, String, String, String, String, boolean, boolean, String), StatsSvc.impression(javax.ws.rs.core.UriInfo, String, String, String, String, String, String, String, String, String, long, String, int, String, String, String, String, String, String, String, javax.servlet.http.HttpServletRequest, String, javax.ws.rs.core.HttpHeaders, String, String)
  - getDefaultTimeout
```
default long getDefaultTimeout()
```
    What is the default timeout, in milliseconds (default, because timeout can also be provided dynamically as OpenRtbRequest.getTmax() on each request, which takes precedence).
  - getWinningPriceMacro
```
String getWinningPriceMacro()
```
    Winning price macro.
    
    See Also:
    
    parse(String, long)
  - localUserMapping
```
boolean localUserMapping()
```
    Whether the mapping of our user ID to exchange ID is stored by us.
  - convertRequest
```
OpenRtbRequest convertRequest(RequestType req)
                       throws Throwable
```
    Throws:
    
    Throwable
  - convertResponse
```
ResponseType convertResponse(OpenRtbRequest req,
                             OpenRtbResponse resp)
                      throws Throwable
```
    Throws:
    
    Throwable
  - parse
```
ParsedPriceInfo parse(String winningPriceString,
                      long bidMicros)
               throws Throwable
```
    Throws:
    
    Throwable
    
    See Also:
    
    getWinningPriceMacro()
  - getClickMacro
```
String getClickMacro()
```
  - getClickEncMacro
```
String getClickEncMacro()
```
  - getSeat
```
default String getSeat(Ad ad)
```
  - massageBid
```
default Bid massageBid(OpenRtbRequest req,
                       Impression imp,
                       Tag tag,
                       Bid bid)
```
    Post-process a bid. TODO should really be part of convertResponse and that should be passed request.
    
    See Also:
    
    Tag.getBid(OpenRtbRequest, Impression)
  - checkExchangeTargeting
```
default String checkExchangeTargeting(OpenRtbRequest req,
                                      Impression imp,
                                      ExchangeTargeting targeting)
```
    Check any exchange-specific targeting. For an example, see checkExchangeTargeting(OpenRtbRequest, Impression, ExchangeTargeting)
    
    Returns:
    
    null if everything is OK, otherwise a String with an error message.
  - validateAd
```
default List<String> validateAd(Ad ad)
```
    For calls from Ad.validate(), for example. Same semantics. Default implementation is to return null.

Interface ExchangeAdapter<RequestType,ResponseType>

Nested Class Summary

Method Summary

Method Detail

parseUserId

makeExchangeSpecificInstructionsMap

info

debug

trace

error

error

fillPlatformInfoFromUa

getOptoutBuilder

isMacrosInNurl

setHeaders

getWinTimeout

getSampleWinningPrice

getPartnerInitiatedSyncUrl

getBidChoiceAlgorithm

isAggregator

getResponseMediaType

getName

isNurlRequired

trueWinOnNurlOrImpression

getDefaultTimeout

getWinningPriceMacro

localUserMapping

convertRequest

convertResponse

parse

getClickMacro

getClickEncMacro

getSeat

massageBid

checkExchangeTargeting

validateAd