com.yahoo.bard.webservice.async.preresponses.stores

Interface PreResponseStore

All Known Implementing Classes:

NoOpPreResponseStore

public interface PreResponseStore

PreResponseStore is responsible for storing PreResponses. It is essentially a key-value mapping between a ticket and the PreResponse associated with that ticket.

Method Summary

Modifier and Type	Method and Description
rx.Observable<PreResponse>	get(String ticket) Returns an Observable over a PreResponse associated with a given ticket.
rx.Observable<String>	save(String ticket, PreResponse preResponse) Saves the specified PreResponse in the store.

Method Detail

get

rx.Observable<PreResponse> get(String ticket)

Returns an Observable over a PreResponse associated with a given ticket. The Observable's payload contains the PreResponse if the given ticket is present in the PreResponseStore otherwise it's just an empty Observable.

In case of any error while connecting to the PreResponseStore, the Observable's onError method gets called with the exception as payload.

Parameters:

ticket - The ticket used to identify a job and it's results

Returns:

An Observable over a PreResponse associated with the given ticket

save

rx.Observable<String> save(String ticket,
                           PreResponse preResponse)

Saves the specified PreResponse in the store. If PreResponse for the given ticket already exists, then that PreResponse will be overwritten. Otherwise, a new ticket-PreResponse mapping is added to the store.

This method returns an Observable with the given ticket as a payload. In case of any error while connecting to the PreResponseStore, the Observable's onError method gets called with the exception as payload.

Parameters:

ticket - The ticket used to identify a job and it's results

preResponse - The PreResponse associated with the given ticket

Returns:

An Observable with the ticket as a payload or an exception in case of an error