Adapter.java

package org.prebid.server.bidder;

import com.fasterxml.jackson.core.type.TypeReference;
import org.prebid.server.auction.model.AdapterRequest;
import org.prebid.server.auction.model.PreBidRequestContext;
import org.prebid.server.bidder.model.AdapterHttpRequest;
import org.prebid.server.bidder.model.ExchangeCall;
import org.prebid.server.exception.PreBidException;
import org.prebid.server.proto.response.Bid;

import java.util.List;

/**
 * Describes the behavior for {@link Adapter} implementations.
 * <p>
 * Used by {@link HttpAdapterConnector} while performing requests to exchanges and compose results.
 */
public interface Adapter<T, R> {

    /**
     * Composes list of http request to submit to exchange.
     *
     * @throws PreBidException if error occurs while adUnitBids validation.
     */
    List<AdapterHttpRequest<T>> makeHttpRequests(AdapterRequest adapterRequest,
                                                 PreBidRequestContext preBidRequestContext) throws PreBidException;

    /**
     * Extracts bids from exchange response.
     *
     * @throws PreBidException if error occurs while bids validation.
     */
    List<Bid.BidBuilder> extractBids(AdapterRequest adapterRequest, ExchangeCall<T, R> exchangeCall)
            throws PreBidException;

    /**
     * If true - {@link org.prebid.server.auction.model.AdapterResponse} will contain bids if at least one valid bid
     * exists, otherwise will contain
     * error.
     * <p>
     * If false - {@link org.prebid.server.auction.model.AdapterResponse} will contain error if at least one error
     * occurs during processing.
     */
    boolean tolerateErrors();

    /**
     * A class that will be used to parse response from exchange.
     */
    TypeReference<R> responseTypeReference();
}