com.yahoo.bard.webservice.async.jobs.payloads

Interface JobPayloadBuilder

All Known Implementing Classes:

DefaultJobPayloadBuilder

public interface JobPayloadBuilder

Interface to build a Job payload from a JobRow.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	buildPayload(JobRow jobRow, javax.ws.rs.core.UriInfo uriInfo) Given a Map containing job metadata, return a map representing job payload to be sent to the user.
static javax.ws.rs.core.UriBuilder	getResultsBaseUrl(javax.ws.rs.core.UriInfo uriInfo) Get the UriBuilder for the /jobs/ticket/results endpoint.
static String	getResultsUrl(String ticket, javax.ws.rs.core.UriInfo uriInfo) Get the job results url.
static String	getSelfUrl(String ticket, javax.ws.rs.core.UriInfo uriInfo) Get the url for the given ticket.
static String	getSyncResultsUrl(String ticket, javax.ws.rs.core.UriInfo uriInfo) Get the url for obtaining the job results synchronously.

Method Detail

buildPayload

Map<String,String> buildPayload(JobRow jobRow,
                                javax.ws.rs.core.UriInfo uriInfo)

Given a Map containing job metadata, return a map representing job payload to be sent to the user.

Parameters:

jobRow - The JobRow containing job metadata

uriInfo - UriInfo of the Jobs endpoint

Returns:

Map representing the job to be returned to the user

getResultsUrl

static String getResultsUrl(String ticket,
                            javax.ws.rs.core.UriInfo uriInfo)

Get the job results url.

  "http://localhost:9998/jobs/ticket1/results"
 

Parameters:

ticket - The ticket that can uniquely identify a Job

uriInfo - UriInfo of the request

Returns:

The job results url.

getSyncResultsUrl

static String getSyncResultsUrl(String ticket,
                                javax.ws.rs.core.UriInfo uriInfo)

Get the url for obtaining the job results synchronously.

     "http://localhost:9998/jobs/ticket1/results?asyncAfter=never"
 

Parameters:

ticket - The ticket that can uniquely identify a Job

uriInfo - UriInfo of the request

Returns:

The url for obtaining the job results synchronously

getResultsBaseUrl

static javax.ws.rs.core.UriBuilder getResultsBaseUrl(javax.ws.rs.core.UriInfo uriInfo)

Get the UriBuilder for the /jobs/ticket/results endpoint.

Parameters:

uriInfo - UriInfo of the request

Returns:

the UriBuilder for the /jobs/ticket/results endpoint

getSelfUrl

static String getSelfUrl(String ticket,
                         javax.ws.rs.core.UriInfo uriInfo)

Get the url for the given ticket.

     "http://localhost:9998/jobs/ticket1"
 

Parameters:

ticket - The ticket that can uniquely identify a Job

uriInfo - UriInfo of the request

Returns:

the url for the given ticket