com.yahoo.bard.webservice.async.workflows

Class AsynchronousWorkflows

java.lang.Object

com.yahoo.bard.webservice.async.workflows.AsynchronousWorkflows

public class AsynchronousWorkflows
extends Object

A bean containing the Observables for each of the message flows needed to support asynchronous processing:

1. The flow that emits the results to be sent to the user if they are ready within the asynchronous timeout.
2. The flow that emits the metadata payload to be sent to the user if the data response is not ready within the asynchronous timeout.
3. The flow that stores the JobRow in the ApiJobStore, the PreResponse in the PreResponseStore, and notifies all subscribers when the PreResponse has been successfully stored
4. The flow that updates the JobRow with the Success (or Error) status once the PreResponse has been stored successfully

Users may access the results of each workflow by extracting the appropriate Observables from the bean, and subscribing to them.

Constructor Summary

Constructors

Constructor and Description
AsynchronousWorkflows(rx.Observable<PreResponse> queryResultsPayload, rx.Observable<String> jobMetadataPayload, rx.Observable<String> preResponseReadyNotifications, rx.Observable<JobRow> jobMarkedCompleteNotifications) Builds a bean containing all the message flows that support asynchronous processing.

Method Summary

Modifier and Type	Method and Description
rx.Observable<String>	getAsynchronousPayload() Returns an Observable that emits the job metadata to send to the user.
rx.Observable<JobRow>	getJobMarkedCompleteNotifications() Returns an Observable that emits notifications that the JobRow has been updated.
rx.Observable<String>	getPreResponseReadyNotifications() Returns an Observable that emits notifications that the query results have been stored in the PreResponseStore.
rx.Observable<PreResponse>	getSynchronousPayload() Returns an Observable that emits the query results to send to the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsynchronousWorkflows

public AsynchronousWorkflows(rx.Observable<PreResponse> queryResultsPayload,
                             rx.Observable<String> jobMetadataPayload,
                             rx.Observable<String> preResponseReadyNotifications,
                             rx.Observable<JobRow> jobMarkedCompleteNotifications)

Builds a bean containing all the message flows that support asynchronous processing.

Parameters:

queryResultsPayload - Emits query results to send to the user

jobMetadataPayload - Emits job metadata to send to the user

preResponseReadyNotifications - Emits notifications that the query results have been stored in the PreResponseStore

jobMarkedCompleteNotifications - Emits notifications that the JobRow has been updated with success or error upon completion of the query

Method Detail

getSynchronousPayload

public rx.Observable<PreResponse> getSynchronousPayload()

Returns an Observable that emits the query results to send to the user.

Returns:

An Observable that emits the query results to send to the user

getAsynchronousPayload

public rx.Observable<String> getAsynchronousPayload()

Returns an Observable that emits the job metadata to send to the user.

Returns:

an Observable that emits the job metadata to send to the user

getPreResponseReadyNotifications

public rx.Observable<String> getPreResponseReadyNotifications()

Returns an Observable that emits notifications that the query results have been stored in the PreResponseStore.

Returns:

an Observable that emits notifications that the query results have been stored in the PreResponseStore

getJobMarkedCompleteNotifications

public rx.Observable<JobRow> getJobMarkedCompleteNotifications()

Returns an Observable that emits notifications that the JobRow has been updated.

Typically, a JobRow will be updated with some sort of notification (i.e. a Status value) indicating that the query has completed, either successfully or with an error.

Returns:

an Observable that emits notifications that the JobRow has been updated with success or error upon completion of the query