com.enremmeta.rtb.jersey

Class AdminSvc

java.lang.Object

com.enremmeta.rtb.jersey.AdminSvc

All Implemented Interfaces:

Lot49Constants, JerseySvc

@Provider
 @Path(value="/admin")
public class AdminSvc
extends Object
implements JerseySvc, Lot49Constants

Administration utilities.

Author:

Gregory Golberg (grisha@alum.mit.edu) Copyright © Enremmeta LLC 2014. All Rights Reserved. This code is licensed under Affero GPL 3.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEBUG_ACTION_TYPE_DISPLAY
static String	DEBUG_RESPONSE_TYPE_FULL_BINARY
static String	DEBUG_RESPONSE_TYPE_FULL_JSON
static String	DEBUG_RESPONSE_TYPE_FULL_TEXT
static String	DEBUG_RESPONSE_TYPE_TAG_BINARY
static String	DEBUG_RESPONSE_TYPE_TAG_CACHED
static String	DEBUG_RESPONSE_TYPE_TAG_CONTAINER
static String	DEBUG_RESPONSE_TYPE_TAG_TEXT
private static String[]	DEBUG_RESPONSE_TYPES
private static Map<String,Object>	map

Fields inherited from interface com.enremmeta.rtb.jersey.JerseySvc

AUTH_COOKIE_DU_JOUR, RANDOM, USER_ID_COOKIE

Fields inherited from interface com.enremmeta.rtb.constants.Lot49Constants

AD_FILENAME_PREFIX, AUCTION_RESULTS_PATH_ADX, AUCTION_RESULTS_PATH_OPENX, AUCTION_RESULTS_PATH_PUBMATIC, BID_OUTCOME_CONTROL, BID_OUTCOME_INTERNAL_AUCTION_LOSS, BID_OUTCOME_SUBMITTED, BID_PRICE_CALCULATOR_FILENAME_PREFIX, COOKIE_PREFIX_A, DECISION_BIDS_MADE, DECISION_BIDS_NEEDED, DECISION_BIDS_POSSIBLE, DECISION_BRANDSAFETY, DECISION_BROWSER, DECISION_BUDGET, DECISION_CATEGORY, DECISION_DATE, DECISION_DAY, DECISION_DEVICE, DECISION_DOMAIN_REQUIRED, DECISION_DOMAIN_UNMATCHED, DECISION_EVALUATION_ERROR, DECISION_EXCHANGE, DECISION_EXPERIMENT_CONTROL_SET, DECISION_FLOOR, DECISION_FREQ_CAP, DECISION_GEO, DECISION_HOST, DECISION_HOUR, DECISION_INTEGRAL, DECISION_INTEGRAL_URL, DECISION_INTERNAL_AUCTION, DECISION_IP_BLACKLISTED, DECISION_LANGUAGE, DECISION_LOADING_ERROR, DECISION_NO_IMPRESSIONS, DECISION_NO_USER, DECISION_OS, DECISION_PACING, DECISION_PRIVATE_DEAL, DECISION_PROBABILITY, DECISION_PROVIDER, DECISION_SSP, DECISION_TAG, DECISION_TIMEOUT_EXPERIMENT_STATUS, DECISION_TIMEOUT_FC, DECISION_TIMEOUT_INTEGRAL, DECISION_TIMEOUT_UNKNOWN, DECISION_TIMEOUT_USERDATA, DECISION_TRAQ, DECISION_URL, DECISION_USER_UNKNOWN, DECISION_VALIDATION, DECISION_VIEWABILITY, DECISION_WRONG_USER, DEFAULT_CLICK_PATH_ABSOLUTE, DEFAULT_CLICK_PATH_RELATIVE, DEFAULT_IMPRESSION_PATH_ABSOLUTE, DEFAULT_IMPRESSION_PATH_RELATIVE, DEFAULT_NURL_PATH_ABSOLUTE, DEFAULT_NURL_PATH_RELATIVE, DEFAULT_PIXEL_PATH_ABSOLUTE, DEFAULT_PIXEL_PATH_RELATIVE, DEFAULT_PROUST_PATH_ABSOLUTE, DEFAULT_PROUST_PATH_RELATIVE, DEFAULT_REDIR_PATH_ABSOLUTE, DEFAULT_REDIR_PATH_RELATIVE, DEFAULT_TEST_PATH_RELATIVE, EXCHANGE_ADAPTV, EXCHANGE_ADX, EXCHANGE_BIDSWITCH, EXCHANGE_BRX, EXCHANGE_LIVERAIL, EXCHANGE_LOT49_INTERNAL_AUCTION, EXCHANGE_OPENX, EXCHANGE_PUBMATIC, EXCHANGE_SMAATO, EXCHANGE_SPOTXCHANGE, EXCHANGE_TEST1, EXCHANGE_TEST2, LOT49_VERSION_KEY, LOT49_VERSION_VALUE, MEDIA_TYPE_APPLICATION_JAVASCRIPT, MEDIA_TYPE_APPLICATION_SHOCKWAVE_FLASH, MEDIA_TYPE_VIDEO_FLV, MEDIA_TYPE_VIDEO_MP4, MOD_UID_COOKIE_LENGTH_MAX, MOD_UID_COOKIE_LENGTH_MIN, MOD_UID_LOG_LENGTH, NAME, NURL_ONLY_TAG, NURL_ONLY_WIN_NOTIFICATION, NURL_STANDART, QUERY_STRING_EXCHANGE_CLICK_THROUGH_ENCODED_MACRO, QUERY_STRING_EXCHANGE_CLICK_THROUGH_MACRO, QUERY_STRING_LOT49_CLICK_THROUGH_MACRO, REL_PATH_DEBUG_NURL, ROOT_PATH_ADMIN, ROOT_PATH_AUCTIONS, ROOT_PATH_STATS, TAG_DECISION_API, TAG_DECISION_DIMENSIONS, TAG_DECISION_DURATION, TAG_DECISION_MIME, TAG_DECISION_NOT_BANNER, TAG_DECISION_NOT_VIDEO, TAG_DECISION_PROTOCOL, TAG_DECISION_REQUEST_DISALLOWS_MARKUP, TAG_DECISION_SSL_REQUIRED, TAG_DECISION_VIDEO_LINEARITY, TAG_FILENAME_PREFIX, TEST_MOD_UID_COOKIE_1, TEST_MOD_UID_COOKIE_2, TEST_MOD_UID_COOKIE_3, TEST_MOD_UID_COOKIE_4, TEST_MOD_UID_LOG_1, TEST_MOD_UID_LOG_2, TEST_MOD_UID_LOG_3, TEST_MOD_UID_LOG_4

Constructor Summary

Constructors

Constructor and Description
AdminSvc()

Method Summary

Modifier and Type	Method and Description
private boolean	auth(javax.ws.rs.container.AsyncResponse response, String authCookie)
void	auth(javax.ws.rs.container.AsyncResponse response, String username, String password)
private OpenRtbResponse	createBidResponse(ExchangeAdapter adapter, Ad ad, Tag tag) We are very minimally simulating onBidRequestDelegate here.
void	debug1(String adId, String tagId, String exchange, javax.servlet.http.HttpServletRequest servletRequest, javax.ws.rs.container.AsyncResponse response, String auth)
Object	debug2(String adId, String tagId, String exchange, String responseType, String actionType, javax.servlet.http.HttpServletRequest servletRequest, javax.ws.rs.container.AsyncResponse response, String auth) A debug URL that, when hit, can show the tag and/or bid response as would be returned.
private Ad	findAd(String adId)
private Tag	findTag(Ad ad, String tagId)
private String	htmlAdTitle(Ad ad, boolean closeLi)
void	index(javax.ws.rs.container.AsyncResponse response, String auth) For ad ops, listing of available Ads.
void	invAd(javax.ws.rs.container.AsyncResponse response, String adId, String auth) For ad ops, listing of available Tags in the chosen Ad.
void	invTag(javax.ws.rs.container.AsyncResponse response, String adId, String tagId, String auth)
void	login(javax.ws.rs.container.AsyncResponse response)
String	refreshAdCache(javax.ws.rs.container.AsyncResponse response, String auth)
void	setBudget(javax.ws.rs.container.AsyncResponse response, String adId, long amount, String auth)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.enremmeta.rtb.jersey.JerseySvc

getMyCookie

Field Detail

map

private static final Map<String,Object> map

DEBUG_RESPONSE_TYPE_FULL_JSON

public static final String DEBUG_RESPONSE_TYPE_FULL_JSON

See Also:

Constant Field Values

DEBUG_RESPONSE_TYPE_FULL_TEXT

public static final String DEBUG_RESPONSE_TYPE_FULL_TEXT

See Also:

Constant Field Values

DEBUG_RESPONSE_TYPE_FULL_BINARY

public static final String DEBUG_RESPONSE_TYPE_FULL_BINARY

See Also:

Constant Field Values

DEBUG_RESPONSE_TYPE_TAG_TEXT

public static final String DEBUG_RESPONSE_TYPE_TAG_TEXT

See Also:

Constant Field Values

DEBUG_RESPONSE_TYPE_TAG_BINARY

public static final String DEBUG_RESPONSE_TYPE_TAG_BINARY

See Also:

Constant Field Values

DEBUG_RESPONSE_TYPE_TAG_CONTAINER

public static final String DEBUG_RESPONSE_TYPE_TAG_CONTAINER

See Also:

Constant Field Values

DEBUG_RESPONSE_TYPE_TAG_CACHED

public static final String DEBUG_RESPONSE_TYPE_TAG_CACHED

See Also:

Constant Field Values

DEBUG_RESPONSE_TYPES

private static final String[] DEBUG_RESPONSE_TYPES

DEBUG_ACTION_TYPE_DISPLAY

public static final String DEBUG_ACTION_TYPE_DISPLAY

See Also:

Constant Field Values

Constructor Detail

AdminSvc

public AdminSvc()

Method Detail

login

@GET
 @Produces(value="text/html")
 @Path(value="login")
public void login(@Suspended
                                                                           javax.ws.rs.container.AsyncResponse response)

auth

@POST
 @Produces(value="text/html")
 @Consumes(value="application/x-www-form-urlencoded")
 @Path(value="auth")
public void auth(@Suspended
                                                                                                                                javax.ws.rs.container.AsyncResponse response,
                                                                                                                                @FormParam(value="username")
                                                                                                                                String username,
                                                                                                                                @FormParam(value="password")
                                                                                                                                String password)

index

@GET
 @Produces(value="text/html")
 @Path(value="/")
public void index(@Suspended
                                                                       javax.ws.rs.container.AsyncResponse response,
                                                                       @CookieParam(value="auth")
                                                                       String auth)

For ad ops, listing of available Ads.

htmlAdTitle

private String htmlAdTitle(Ad ad,
                           boolean closeLi)

refreshAdCache

@GET
 @Produces(value="text/html")
 @Path(value="refreshAdCache")
public String refreshAdCache(@Suspended
                                                                                               javax.ws.rs.container.AsyncResponse response,
                                                                                               @CookieParam(value="auth")
                                                                                               String auth)

setBudget

@GET
 @Produces(value="text/html")
 @Path(value="ad/{adId}/setBudget")
public void setBudget(@Suspended
                                                                                             javax.ws.rs.container.AsyncResponse response,
                                                                                             @PathParam(value="adId")
                                                                                             String adId,
                                                                                             @QueryParam(value="amount")
                                                                                             long amount,
                                                                                             @CookieParam(value="auth")
                                                                                             String auth)
                                                                                      throws Lot49Exception

Throws:

Lot49Exception

invAd

@GET
 @Produces(value="text/html")
 @Path(value="ad/{adId}")
public void invAd(@Suspended
                                                                               javax.ws.rs.container.AsyncResponse response,
                                                                               @PathParam(value="adId")
                                                                               String adId,
                                                                               @CookieParam(value="auth")
                                                                               String auth)

For ad ops, listing of available Tags in the chosen Ad.

auth

private boolean auth(javax.ws.rs.container.AsyncResponse response,
                     String authCookie)
              throws javax.ws.rs.WebApplicationException

Throws:

javax.ws.rs.WebApplicationException

invTag

@GET
 @Produces(value="text/html")
 @Path(value="ad/{adId}/tag/{tagId}")
public void invTag(@Suspended
                                                                                            javax.ws.rs.container.AsyncResponse response,
                                                                                            @PathParam(value="adId")
                                                                                            String adId,
                                                                                            @PathParam(value="tagId")
                                                                                            String tagId,
                                                                                            @CookieParam(value="auth")
                                                                                            String auth)

debug1

@GET
 @Path(value="ad/{adId}/tag/{tagId}/debug1")
public void debug1(@PathParam(value="adId")
                                                                     String adId,
                                                                     @PathParam(value="tagId")
                                                                     String tagId,
                                                                     @QueryParam(value="exchange")
                                                                     String exchange,
                                                                     @Context
                                                                     javax.servlet.http.HttpServletRequest servletRequest,
                                                                     @Suspended
                                                                     javax.ws.rs.container.AsyncResponse response,
                                                                     @CookieParam(value="auth")
                                                                     String auth)

findAd

private Ad findAd(String adId)
           throws javax.ws.rs.WebApplicationException

Throws:

javax.ws.rs.WebApplicationException

findTag

private Tag findTag(Ad ad,
                    String tagId)
             throws javax.ws.rs.WebApplicationException

Throws:

javax.ws.rs.WebApplicationException

debug2

@GET
 @Path(value="ad/{adId}/tag/{tagId}/debug2")
public Object debug2(@PathParam(value="adId")
                                                                       String adId,
                                                                       @PathParam(value="tagId")
                                                                       String tagId,
                                                                       @QueryParam(value="exchange")
                                                                       String exchange,
                                                                       @QueryParam(value="responseType")
                                                                       String responseType,
                                                                       @QueryParam(value="actionType")
                                                                       String actionType,
                                                                       @Context
                                                                       javax.servlet.http.HttpServletRequest servletRequest,
                                                                       @Suspended
                                                                       javax.ws.rs.container.AsyncResponse response,
                                                                       @CookieParam(value="auth")
                                                                       String auth)

A debug URL that, when hit, can show the tag and/or bid response as would be returned. The URL is of the form:

/admin/ad/{adId}/tag/{tagId}?exchange={exchange}&responseType={responseType}&strict={strict}

The meaning of the parameters is as follows:

Parameters:

adId - Ad ID

tagId - Tag ID

exchange - Exchange (e.g. Lot49Constants.EXCHANGE_ADAPTV).

responseType - can take on the values as follows:

responseType	Behavior
DEBUG_RESPONSE_TYPE_FULL_JSON	Full bid response is returned with application/json content type.
DEBUG_RESPONSE_TYPE_FULL_BINARY	Full bid response is returned with the content type the exchange expects in a response -- this could be a binary type such as application/x-octet-stream.
DEBUG_RESPONSE_TYPE_FULL_TEXT	Full bid response is returned with text/plain content type.
DEBUG_RESPONSE_TYPE_TAG_TEXT	Just the ad markup (the "tag") is returned, with text/plain content type.
DEBUG_RESPONSE_TYPE_TAG_BINARY	Just the ad markup (the "tag") is returned, with the text/html in case of a a banner, and application/xml in case of a video ad. Also, X-Lot49-Creative-Content-Type custom header type will be returned with the value of creative's MIME type.
DEBUG_RESPONSE_TYPE_TAG_CONTAINER	The ad markup (the "tag") is returned within the container -- an IFRAME in case of a a banner, and Google VAST Inspector in case of a video ad.
DEBUG_RESPONSE_TYPE_TAG_CACHED	A link is returned which, when followed, will yield the result as from a DEBUG_RESPONSE_TYPE_TAG_BINARY. The link will not be under the Admin URL (see OpsSvc), that is, it is suitable for sending to third parties. The link will survive for as long as the cache survives.

Returns:

createBidResponse

private OpenRtbResponse createBidResponse(ExchangeAdapter adapter,
                                          Ad ad,
                                          Tag tag)

We are very minimally simulating onBidRequestDelegate here.

See Also:

AuctionsSvc#onBidRequestDelegate(JerseySvc, ExchangeAdapter, AsyncResponse, OpenRtbRequest, String, HttpServletRequest, String)