com.yahoo.bard.webservice.async.jobs.jobrows

Class DefaultJobRowBuilder

java.lang.Object

com.yahoo.bard.webservice.async.jobs.jobrows.DefaultJobRowBuilder

All Implemented Interfaces:

JobRowBuilder

public class DefaultJobRowBuilder
extends Object
implements JobRowBuilder

A JobRowBuilder that populates a JobRow with the information for all the job fields defined in DefaultJobField.

Constructor Summary

Constructors

Constructor and Description
DefaultJobRowBuilder(Function<Map<JobField,String>,String> idGenerator) Builds a factory for generating JobRows containing values for every DefaultJobField.
DefaultJobRowBuilder(Function<Map<JobField,String>,String> idGenerator, Function<javax.ws.rs.core.SecurityContext,String> userIdExtractor, Clock timestampGenerator) Builds a factory for generating JobRows with a custom function for extracting a userid from a request's SecurityContext.

Method Summary

Modifier and Type	Method and Description
JobRow	buildJobRow(javax.ws.rs.core.UriInfo request, javax.ws.rs.container.ContainerRequestContext requestContext) Builds a JobRow with values for every field defined in DefaultJobField.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJobRowBuilder

public DefaultJobRowBuilder(Function<Map<JobField,String>,String> idGenerator,
                            Function<javax.ws.rs.core.SecurityContext,String> userIdExtractor,
                            Clock timestampGenerator)

Builds a factory for generating JobRows with a custom function for extracting a userid from a request's SecurityContext.

Parameters:

idGenerator - A function that takes all the job metadata except for the job's id and generates a globally unique id

userIdExtractor - A function that given a SecurityContext, returns the id of the user who made the request

timestampGenerator - The clock to use to generate timestamps

DefaultJobRowBuilder

public DefaultJobRowBuilder(Function<Map<JobField,String>,String> idGenerator)

Builds a factory for generating JobRows containing values for every DefaultJobField.

The user id is extracted from the UserPrincipal of a request's SecurityContext, and timestamps are generated from the System clock.

Parameters:

idGenerator - A function that takes all the job metadata except for the job's id, and returns a globally unique id for the job

Method Detail

buildJobRow

public JobRow buildJobRow(javax.ws.rs.core.UriInfo request,
                          javax.ws.rs.container.ContainerRequestContext requestContext)

Builds a JobRow with values for every field defined in DefaultJobField.

Specified by:

buildJobRow in interface JobRowBuilder

Parameters:

request - The request that is triggering this job

requestContext - The context of the request triggering this job

Returns:

A JobRow with all the metadata for the job under construction