com.yahoo.bard.webservice.web.endpoints

Class JobsServlet

java.lang.Object

com.yahoo.bard.webservice.web.endpoints.EndpointServlet

com.yahoo.bard.webservice.web.endpoints.JobsServlet

@Path(value="/jobs")
 @Singleton
public class JobsServlet
extends EndpointServlet

Resource code for job resource endpoints.

Field Summary

Fields inherited from class com.yahoo.bard.webservice.web.endpoints.EndpointServlet

objectMappers

Constructor Summary

Constructors

Constructor and Description
JobsServlet(ObjectMappersSuite objectMappers, ApiJobStore apiJobStore, JobPayloadBuilder jobPayloadBuilder, PreResponseStore preResponseStore, BroadcastChannel<String> broadcastChannel, RequestMapper requestMapper, HttpResponseMaker httpResponseMaker, ResponseFormatResolver formatResolver) Constructor.

Method Summary

Modifier and Type	Method and Description
protected ResponseContext	addPaginationInfoToResponseContext(ResponseContext responseContext, javax.ws.rs.core.UriInfo uriInfo, Pagination<Result> pages) Add pagination details to ResponseContext.
protected javax.ws.rs.core.Response	getErrorResponse(Throwable throwable) Map the exception thrown while processing the job request to an appropriate http response.
void	getJobByTicket(String ticket, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.container.ContainerRequestContext containerRequestContext, javax.ws.rs.container.AsyncResponse asyncResponse) Endpoint to get all the metadata about a particular job.
void	getJobResultsByTicket(String ticket, String format, String asyncAfter, String perPage, String page, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.container.ContainerRequestContext containerRequestContext, javax.ws.rs.container.AsyncResponse asyncResponse) Endpoint to get a particular job's result.
void	getJobs(String perPage, String page, String format, String filters, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.container.ContainerRequestContext containerRequestContext, javax.ws.rs.container.AsyncResponse asyncResponse) Endpoint to get metadata of all the Jobs in the ApiJobStore.
protected javax.ws.rs.core.Response	getResponse(String jsonResponse) Map the given jsonString to a Response object.
protected rx.Observable<PreResponse>	getResults(String ticket, long asyncAfter) Get an Observable wrapping a PreResponse.
protected rx.Observable<javax.ws.rs.core.Response>	handleJobResponse(String ticket, JobsApiRequestImpl apiRequest) Process a request to get job payload.
protected rx.Observable<javax.ws.rs.core.Response>	handlePreResponse(String ticket, JobsApiRequestImpl apiRequest, javax.ws.rs.container.AsyncResponse asyncResponse, rx.Observable<PreResponse> preResponseObservable, boolean isEmpty) If isEmpty is true, call the method to send the job payload to the user else call the method to send the job result to the user.
protected rx.Observable<PreResponse>	handlePreResponseWithError(PreResponse preResponse, javax.ws.rs.core.UriInfo uriInfo, Optional<PaginationParameters> paginationParameters) Check whether the PreResponse contains an error and if it does, return an Observable wrapping the error else return an Observable wrapping the PreResponse as is.
protected void	handleResultsResponse(rx.Observable<PreResponse> preResponseObservable, javax.ws.rs.container.AsyncResponse asyncResponse, ApiRequest apiRequest) Process a request to get job results.

Methods inherited from class com.yahoo.bard.webservice.web.endpoints.EndpointServlet

formatResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

JobsServlet

@Inject
public JobsServlet(ObjectMappersSuite objectMappers,
                           ApiJobStore apiJobStore,
                           JobPayloadBuilder jobPayloadBuilder,
                           PreResponseStore preResponseStore,
                           BroadcastChannel<String> broadcastChannel,
                           @Named(value="jobsApiRequestMapper")
                           RequestMapper requestMapper,
                           HttpResponseMaker httpResponseMaker,
                           ResponseFormatResolver formatResolver)

Constructor.

Parameters:

objectMappers - JSON tools

apiJobStore - The ApiJobStore containing job metadata

jobPayloadBuilder - The JobRowMapper to be used to map JobRow to the Job returned via the api

preResponseStore - The Data store that stores all the PreResponses

broadcastChannel - Channel to notify other Bard processes (i.e. long pollers)

requestMapper - Mapper for changing the API request

httpResponseMaker - The factory for building HTTP responses

formatResolver - The formatResolver for determining correct response format

Method Detail

getJobs

@GET
 @Timed
public void getJobs(@DefaultValue(value="") @NotNull @QueryParam(value="perPage")
                                 String perPage,
                                 @DefaultValue(value="") @NotNull @QueryParam(value="page")
                                 String page,
                                 @QueryParam(value="format")
                                 String format,
                                 @QueryParam(value="filters")
                                 String filters,
                                 @Context
                                 javax.ws.rs.core.UriInfo uriInfo,
                                 @Context
                                 javax.ws.rs.container.ContainerRequestContext containerRequestContext,
                                 @Suspended
                                 javax.ws.rs.container.AsyncResponse asyncResponse)

Endpoint to get metadata of all the Jobs in the ApiJobStore.

Parameters:

perPage - Requested number of rows of data to be displayed on each page of results

page - Requested page of results desired

format - Requested format

filters - Filters to be applied on the JobRows. Expects a URL filter query String that may contain multiple filter strings separated by comma. The format of a filter String is : (JobField name)-(operation)[(value or comma separated values)]?

uriInfo - UriInfo of the request

containerRequestContext - The context of data provided by the Jersey container for this request

asyncResponse - An asyncAfter response that we can use to respond asynchronously

getJobByTicket

@GET
 @Timed
 @Path(value="/{ticket}")
public void getJobByTicket(@PathParam(value="ticket")
                                                                  String ticket,
                                                                  @Context
                                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                                  @Context
                                                                  javax.ws.rs.container.ContainerRequestContext containerRequestContext,
                                                                  @Suspended
                                                                  javax.ws.rs.container.AsyncResponse asyncResponse)

Endpoint to get all the metadata about a particular job.

Parameters:

ticket - The ticket that can uniquely identify a Job

uriInfo - UriInfo of the request

containerRequestContext - The context of data provided by the Jersey container for this request

asyncResponse - An async response that we can use to respond asynchronously

getJobResultsByTicket

@GET
 @Timed
 @Path(value="/{ticket}/results")
public void getJobResultsByTicket(@PathParam(value="ticket")
                                                                                 String ticket,
                                                                                 @QueryParam(value="format")
                                                                                 String format,
                                                                                 @QueryParam(value="asyncAfter")
                                                                                 String asyncAfter,
                                                                                 @DefaultValue(value="") @NotNull @QueryParam(value="perPage")
                                                                                 String perPage,
                                                                                 @DefaultValue(value="") @NotNull @QueryParam(value="page")
                                                                                 String page,
                                                                                 @Context
                                                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                                                 @Context
                                                                                 javax.ws.rs.container.ContainerRequestContext containerRequestContext,
                                                                                 @Suspended
                                                                                 javax.ws.rs.container.AsyncResponse asyncResponse)

Endpoint to get a particular job's result.

Parameters:

ticket - The ticket that can uniquely identify a Job

format - Requested format of the response

asyncAfter - How long the user is willing to wait for a synchronous request in milliseconds, if null defaults to the system config default_asyncAfter

perPage - Requested number of rows of data to be displayed on each page of results

page - Requested page of results desired

uriInfo - UriInfo of the request

containerRequestContext - The context of data provided by the Jersey container for this request

asyncResponse - An async response that we can use to respond asynchronously

handlePreResponse

protected rx.Observable<javax.ws.rs.core.Response> handlePreResponse(String ticket,
                                                                     JobsApiRequestImpl apiRequest,
                                                                     javax.ws.rs.container.AsyncResponse asyncResponse,
                                                                     rx.Observable<PreResponse> preResponseObservable,
                                                                     boolean isEmpty)

If isEmpty is true, call the method to send the job payload to the user else call the method to send the job result to the user.

Parameters:

ticket - The ticket that can uniquely identify a Job

apiRequest - JobsApiRequestImpl object with all the associated info in it

asyncResponse - Parameter specifying for how long the request should be asyncAfter

preResponseObservable - An Observable wrapping a PreResponse or an empty observable

isEmpty - A boolean that indicates if the PreResponse is empty

Returns:

an observable response to be consumed.

getResults

protected rx.Observable<PreResponse> getResults(@NotNull
                                                String ticket,
                                                long asyncAfter)

Get an Observable wrapping a PreResponse. We first connect to the BroadcastChannel to ensure that we do not miss any notifications. We then check the PreResponseStore for the PreResponse. If no PreResponse is available, we check to see if we got a notification from the BroadcastChannel before the async timeout. If we get a notification before timeout, we retrieve the PreResponse from the PreResponseStore else we return an empty Observable.

Parameters:

ticket - The ticket for which the PreResponse needs to be retrieved.

asyncAfter - The minimum duration the request is allowed to last before becoming asynchronous

Returns:

An Observable wrapping a PreResponse or an empty Observable in case a timeout occurs.

handleJobResponse

protected rx.Observable<javax.ws.rs.core.Response> handleJobResponse(String ticket,
                                                                     JobsApiRequestImpl apiRequest)

Process a request to get job payload.

Parameters:

ticket - The ticket that can uniquely identify a Job

apiRequest - JobsApiRequestImpl object with all the associated info in it

Returns:

an observable response to be consumed.

handleResultsResponse

protected void handleResultsResponse(rx.Observable<PreResponse> preResponseObservable,
                                     javax.ws.rs.container.AsyncResponse asyncResponse,
                                     ApiRequest apiRequest)

Process a request to get job results.

Parameters:

preResponseObservable - An Observable over the PreResponse which will be used to generate the Response

asyncResponse - An async response that we can use to respond asynchronously

apiRequest - JobsApiRequest object with all the associated info with it

handlePreResponseWithError

protected rx.Observable<PreResponse> handlePreResponseWithError(PreResponse preResponse,
                                                                javax.ws.rs.core.UriInfo uriInfo,
                                                                Optional<PaginationParameters> paginationParameters)

Check whether the PreResponse contains an error and if it does, return an Observable wrapping the error else return an Observable wrapping the PreResponse as is.

Parameters:

preResponse - The PreResponse to be inspected

uriInfo - uriInfo object to get uriBuilder

paginationParameters - user's requested pagination parameters

Returns:

An Observable wrapping the PreResponse or an Observable wrapping a ResponseException

addPaginationInfoToResponseContext

protected ResponseContext addPaginationInfoToResponseContext(ResponseContext responseContext,
                                                             javax.ws.rs.core.UriInfo uriInfo,
                                                             Pagination<Result> pages)

Add pagination details to ResponseContext.

Parameters:

responseContext - ResponseContext object contains all the meta info of the resultSet

uriInfo - uriInfo object to get uriBuilder

pages - Paginated resultSet

Returns:

Updated ResponseContext contains pagination info

getResponse

protected javax.ws.rs.core.Response getResponse(String jsonResponse)

Map the given jsonString to a Response object.

Parameters:

jsonResponse - The jsonResponse to be mapped to a Response object

Returns:

The Response object

getErrorResponse

protected javax.ws.rs.core.Response getErrorResponse(Throwable throwable)

Map the exception thrown while processing the job request to an appropriate http response.

Parameters:

throwable - The exception thrown while processing the request

Returns:

The http Response to be sent to the user