B C D E F G H I K L M P R S T V

B

backlogSize - Variable in class com.beeswax.http.config.ServerConfig

Bidder - Class in com.beeswax.hexbid.bidder

Bidder sets bid in Request.BidAgentResponse based on custom strategy name from Request.BidAgentRequest.

Supported custom strategies are the following:
Flat Price Strategy - FlatPriceStrategy
Random Price Strategy - RandomPriceStrategy
Retargeting Strategy - RetargetingStrategy

Bidder() - Constructor for class com.beeswax.hexbid.bidder.Bidder

BidHandler - Class in com.beeswax.hexbid.handler

The handler handles all requests to /bid end point
Expects a serialized Request.BidAgentRequest and returns a Request.BidAgentResponse

BidHandler() - Constructor for class com.beeswax.hexbid.handler.BidHandler

BidProtobufParser - Class in com.beeswax.hexbid.parser

BidRequestParser parses serialized protocol buffer Bytebuf.

BidProtobufParser() - Constructor for class com.beeswax.hexbid.parser.BidProtobufParser

BidStrategy - Interface in com.beeswax.hexbid.strategy

The interface of bidding strategy.
Each bidding strategy needs to implement this interface to define its own bidding logic.
Custom bidder only supports AdcandidateOuterClass.Bidding.CustomStrategy which is defined using Buzz API.

bossGroupSize - Variable in class com.beeswax.http.config.ServerConfig

build() - Method in class com.beeswax.http.config.ServerConfig.ServerConfigBuilder

C

channelRead0(ChannelHandlerContext, FullHttpRequest) - Method in class com.beeswax.http.handler.GlobalHandler

com.beeswax.hexbid.bidder - package com.beeswax.hexbid.bidder

com.beeswax.hexbid.handler - package com.beeswax.hexbid.handler

com.beeswax.hexbid.parser - package com.beeswax.hexbid.parser

com.beeswax.hexbid.server - package com.beeswax.hexbid.server

com.beeswax.hexbid.strategy - package com.beeswax.hexbid.strategy

com.beeswax.http.config - package com.beeswax.http.config

com.beeswax.http.handler - package com.beeswax.http.handler

com.beeswax.http.server - package com.beeswax.http.server

CONTENT_MESSAGE - Static variable in class com.beeswax.hexbid.handler.HealthHandler

CONTENT_MESSAGE - Static variable in class com.beeswax.hexbid.handler.VarHandler

D

DefaultHandler - Class in com.beeswax.hexbid.handler

Default handler for unknown path.
returns a 404 error to indicate that server cannot find what was requested.

DefaultHandler() - Constructor for class com.beeswax.hexbid.handler.DefaultHandler

E

exceptionCaught(ChannelHandlerContext, Throwable) - Method in class com.beeswax.http.handler.GlobalHandler

F

FlatPriceStrategy - Class in com.beeswax.hexbid.strategy

Flat price strategy sets a flat price for all bid requests.
If there are multiple flat prices in AdcandidateOuterClass.Bidding.CustomStrategy.Params, it simply uses the first one when iterating through the param list.

FlatPriceStrategy() - Constructor for class com.beeswax.hexbid.strategy.FlatPriceStrategy

fromProperties(String) - Method in class com.beeswax.http.config.ServerConfig.ServerConfigBuilder

Load server configurations from property files.

G

getBidPriceMicrosUSD(AdcandidateOuterClass.Adcandidate, Openrtb.BidRequest) - Method in interface com.beeswax.hexbid.strategy.BidStrategy

The method to set bid price with each bidding strategy.

getBidPriceMicrosUSD(AdcandidateOuterClass.Adcandidate, Openrtb.BidRequest) - Method in class com.beeswax.hexbid.strategy.FlatPriceStrategy

Return a flat rate from custom strategy parameter.

getBidPriceMicrosUSD(AdcandidateOuterClass.Adcandidate, Openrtb.BidRequest) - Method in class com.beeswax.hexbid.strategy.RandomPriceStrategy

Get a random bid price no exceeding a max price micros from custom strategy parameter.

getBidPriceMicrosUSD(AdcandidateOuterClass.Adcandidate, Openrtb.BidRequest) - Method in class com.beeswax.hexbid.strategy.RetargetingStrategy

Get the bid price by multiplying user score that is available from bidder's key-value store with a base price.

getHandler(String) - Method in class com.beeswax.hexbid.handler.HexbidHandlerFactory

getHandler(String) - Method in interface com.beeswax.http.handler.HandlerFactory

getIntegerProperty(String, int, Properties) - Static method in class com.beeswax.http.config.PropertyParserUtils

Returns Integer property value if exists.

getLongProperty(String, long, Properties) - Static method in class com.beeswax.http.config.PropertyParserUtils

Returns Long property value if exists.

getStrategy(AdcandidateOuterClass.Adcandidate) - Method in class com.beeswax.hexbid.strategy.StrategyFactory

Get strategy object for the adcandidate to set its bid price.

Customers can associate a bidding strategy with each adcandidate through the Buzz REST API (http://docs.beeswax.com/docs/bidding-strategies).
Custom bidding strategy is a powerful framework that can be used to implement sophisticated algorithms.

getStringProperty(String, Properties) - Static method in class com.beeswax.http.config.PropertyParserUtils

Returns String property value if exists.

GlobalHandler - Class in com.beeswax.http.handler

Global handler handles all HTTP requests received by the server.
It routes incoming HTTP request to appropriate handler based on request path.

GlobalHandler is designed to handle *stateless* HTTP requests so a single instance can be shared in ChannelPipeline.

Full HTTP response may have following error codes:
200 if it processed request successfully.
204 if request has no content.
400 if there is a IllegalArgumentException.
500 if there is an internal error.

GlobalHandler(HandlerFactory) - Constructor for class com.beeswax.http.handler.GlobalHandler

H

HandlerFactory - Interface in com.beeswax.http.handler

Handler Factory is responsible for creating handler object based on path info.
The handler owns the logic to process request.

HealthHandler - Class in com.beeswax.hexbid.handler

The handler which handles /health requests.

return 200 "ok" when the server is healthy.

HealthHandler() - Constructor for class com.beeswax.hexbid.handler.HealthHandler

HexbidHandlerFactory - Class in com.beeswax.hexbid.handler

Following end points are currently supported by the Hexbid HTTP server:

/bid - request to set bid price for bid agent request
/health - request to check server health
/var - request to check server variables

HexbidHandlerFactory() - Constructor for class com.beeswax.hexbid.handler.HexbidHandlerFactory

HexbidServer - Class in com.beeswax.hexbid.server

Hexbid HTTP Server
Refer to the HexbidHandlerFactory for the list of end points currently supported by this server.

HexbidServer(ServerConfig) - Constructor for class com.beeswax.hexbid.server.HexbidServer

HttpServer - Class in com.beeswax.http.server

Http Server handles HTTP requests.

HttpServer(ServerConfig, HandlerFactory) - Constructor for class com.beeswax.http.server.HttpServer

HttpServerChannelInitializer - Class in com.beeswax.http.server

Initialize Pipeline Channel for HTTP Server.

HttpServerChannelInitializer(ServerConfig, HandlerFactory) - Constructor for class com.beeswax.http.server.HttpServerChannelInitializer

I

initChannel(SocketChannel) - Method in class com.beeswax.http.server.HttpServerChannelInitializer

Configure the channel pipeline with the following handler in order:

HttpServerCodec - decodes/encodes ByteBuf into/from HttpRequest and HttpContent
HttpObjectAggregator - aggregates an HttpMessage and its following HttpContents into a single FullHttpRequest or FullHttpResponse.
GlobalHandler - handles request processing for all end points.

K

keepAlive - Variable in class com.beeswax.http.config.ServerConfig

L

loadFromProperties(String) - Static method in class com.beeswax.http.config.PropertyParserUtils

Load properties from a file path.

loadFromProperties(InputStream) - Static method in class com.beeswax.http.config.PropertyParserUtils

Load properties from Inputstream.

M

main(String[]) - Static method in class com.beeswax.hexbid.server.HexbidServer

Entry point of hexbid server.

Main method starts bid server to wait/process bid requests.
The first argument should be the property file path.

maxRequestSize - Variable in class com.beeswax.http.config.ServerConfig

P

parseBoolean(String, boolean, Properties) - Static method in class com.beeswax.http.config.PropertyParserUtils

Helper method used to parse boolean properties.

parseProtoBytebuf(ByteBuf, T) - Static method in class com.beeswax.hexbid.parser.BidProtobufParser

Parse serialized protocol buffer Bytebuf to protobuf object.
Preferencing implementation of ProtobufDecoder

PATH - Static variable in class com.beeswax.hexbid.handler.BidHandler

PATH - Static variable in class com.beeswax.hexbid.handler.HealthHandler

PATH - Static variable in class com.beeswax.hexbid.handler.VarHandler

port - Variable in class com.beeswax.http.config.ServerConfig

processRequest(ChannelHandlerContext, FullHttpRequest) - Method in class com.beeswax.hexbid.handler.BidHandler

Process full bid request with following error codes:

200 if it sets bid price in Request.BidAgentResponse successfully.
204 if no bid is made for this request
400 if there is a parsing error Request.BidAgentRequest or it fails to get bidding strategy.
500 if server experienced an error.

processRequest(ChannelHandlerContext, FullHttpRequest) - Method in class com.beeswax.hexbid.handler.DefaultHandler

processRequest(ChannelHandlerContext, FullHttpRequest) - Method in class com.beeswax.hexbid.handler.HealthHandler

processRequest(ChannelHandlerContext, FullHttpRequest) - Method in class com.beeswax.hexbid.handler.VarHandler

processRequest(ChannelHandlerContext, FullHttpRequest) - Method in interface com.beeswax.http.handler.RequestHandler

The method to process HTTP request and return a HTTP response to the client.

PropertyParserUtils - Class in com.beeswax.http.config

Utility class for parsing property file.

PropertyParserUtils() - Constructor for class com.beeswax.http.config.PropertyParserUtils

R

RandomPriceStrategy - Class in com.beeswax.hexbid.strategy

Random Price Strategy sets a random price no exceeding max price micros.
If there are multiple max price in AdcandidateOuterClass.Bidding.CustomStrategy.Params, it simply uses the first one when iterating through param list.

RandomPriceStrategy() - Constructor for class com.beeswax.hexbid.strategy.RandomPriceStrategy

RequestHandler - Interface in com.beeswax.http.handler

The interface of HTTP request handlers.
Each supported end point in the server needs to implement this handler.
NOTE: methods in this interface are executed in I/O thread so it has to be fully asynchronous or finished very quickly.

RetargetingStrategy - Class in com.beeswax.hexbid.strategy

Retargeting Strategy assumes custom bidder maintains a key-value store which has a score indicating the importance of a user.

RetargetingStrategy() - Constructor for class com.beeswax.hexbid.strategy.RetargetingStrategy

run() - Method in class com.beeswax.hexbid.server.HexbidServer

run() - Method in class com.beeswax.http.server.HttpServer

S

ServerConfig - Class in com.beeswax.http.config

ServerConfig loads configurations from a specified property file and falls back to default value when the file is missing or not found.

Server Configurable values:

Port
- This is the port that the HTTP server is listening on to accept new connections.

Max request size
- maximum length of aggregated content in HTTP request

Boss group size
- number of threads used by boss NioEventLoopGroup which only accepts incoming connection and registers the connection to the worker.

Backlog size
- the maximum queue length for incoming connection indications(a request to connect)

TCP nodelay
- option to disable Nagle's algorithm to achieve lower latency on every packet sent

Keep alive
- option to enable keep-alive packets for a socket connection

ServerConfig.ServerConfigBuilder - Class in com.beeswax.http.config

Builder class builds server configuration from property file.

ServerConfigBuilder() - Constructor for class com.beeswax.http.config.ServerConfig.ServerConfigBuilder

SetBid(Request.BidAgentRequest) - Method in class com.beeswax.hexbid.bidder.Bidder

Set bid in BidAgentResponse including line item id, creative, bid price and bid agent data.

STRATEGY_NAME - Static variable in class com.beeswax.hexbid.strategy.FlatPriceStrategy

STRATEGY_NAME - Static variable in class com.beeswax.hexbid.strategy.RandomPriceStrategy

STRATEGY_NAME - Static variable in class com.beeswax.hexbid.strategy.RetargetingStrategy

StrategyFactory - Class in com.beeswax.hexbid.strategy

Strategy Factory is responsible for getting strategy object which sets bid price based on strategy info from bid agent request.

StrategyFactory() - Constructor for class com.beeswax.hexbid.strategy.StrategyFactory

T

tcpNodelay - Variable in class com.beeswax.http.config.ServerConfig

V

VarHandler - Class in com.beeswax.hexbid.handler

Handler which handles /var requests.

VarHandler() - Constructor for class com.beeswax.hexbid.handler.VarHandler

B C D E F G H I K L M P R S T V