com.yahoo.bard.webservice.async.workflows

Class DefaultAsynchronousWorkflowsBuilder

java.lang.Object

com.yahoo.bard.webservice.async.workflows.DefaultAsynchronousWorkflowsBuilder

All Implemented Interfaces:

AsynchronousWorkflowsBuilder

@Singleton
public class DefaultAsynchronousWorkflowsBuilder
extends Object
implements AsynchronousWorkflowsBuilder

Builds an Asynchronous process that only saves the results of a query if the query is asynchronous.

Constructor Summary

Constructors

Constructor and Description
DefaultAsynchronousWorkflowsBuilder(ApiJobStore apiJobStore, PreResponseStore preResponseStore, Clock timestampGenerator) A factory for constructing the asynchronous response building workflow.

Method Summary

Modifier and Type	Method and Description
AsynchronousWorkflows	buildAsynchronousWorkflows(rx.Observable<PreResponse> preResponseEmitter, rx.Observable<Either<PreResponse,JobRow>> payloadEmitter, JobRow jobMetadata, Function<JobRow,String> jobMetadataSerializer) Builds the asynchronous workflows.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAsynchronousWorkflowsBuilder

@Inject
public DefaultAsynchronousWorkflowsBuilder(ApiJobStore apiJobStore,
                                                   PreResponseStore preResponseStore,
                                                   Clock timestampGenerator)

A factory for constructing the asynchronous response building workflow.

Parameters:

apiJobStore - A service for storing and requesting job metadata

preResponseStore - A service for storing and requesting query results

timestampGenerator - The clock to use to generate timestamps

Method Detail

buildAsynchronousWorkflows

public AsynchronousWorkflows buildAsynchronousWorkflows(rx.Observable<PreResponse> preResponseEmitter,
                                                        rx.Observable<Either<PreResponse,JobRow>> payloadEmitter,
                                                        JobRow jobMetadata,
                                                        Function<JobRow,String> jobMetadataSerializer)

Description copied from interface: AsynchronousWorkflowsBuilder

Builds the asynchronous workflows.

There are four workflows:

1. One that emits the results of the query if the query is synchronous.
2. One that emits the (serialized) job metadata if the query is asynchronous.
3. One that emits notifications that the PreResponse is ready to be accessed.
4. One that emits notifications that the Job has been marked complete.

WARNING: Some implementations (i.e. DefaultAsynchronousWorkflowsBuilder) may communicate with external resources, or do other potentially expensive operations. If you wish to guarantee that the asynchronous workflows are executed at most once (as opposed to once per subscription), then make sure to pass in instances of ConnectableObservable.

Specified by:

buildAsynchronousWorkflows in interface AsynchronousWorkflowsBuilder

Parameters:

preResponseEmitter - The Observable that will eventually emit the results of the backend query

payloadEmitter - The Observable that will emit the results of the query if the query is synchronous, and the job metadata if the query is asynchronous

jobMetadata - The query's metadata

jobMetadataSerializer - A function that serializes a given JobRow into the payload to return to the user

Returns:

A bean containing all the asynchronous workflows