com.yahoo.bullet.rest.service

Class QueryService

java.lang.Object

com.yahoo.bullet.pubsub.PubSubResponder

com.yahoo.bullet.rest.service.QueryService

All Implemented Interfaces:

AutoCloseable

public class QueryService
extends com.yahoo.bullet.pubsub.PubSubResponder

Field Summary

Fields inherited from class com.yahoo.bullet.pubsub.PubSubResponder

config

Constructor Summary

Constructors

Constructor and Description

QueryService(com.yahoo.bullet.storage.StorageManager<com.yahoo.bullet.pubsub.PubSubMessage> storageManager, List<com.yahoo.bullet.pubsub.PubSubResponder> responders, List<com.yahoo.bullet.pubsub.Publisher> publishers, List<com.yahoo.bullet.pubsub.Subscriber> subscribers, com.yahoo.bullet.pubsub.PubSubMessageSerDe pubSubMessageSendSerDe, int sleep) Constructor that takes various necessary components.

Method Summary

Modifier and Type	Method and Description
void	close() Stop all service threads and clear pending requests.
CompletableFuture<com.yahoo.bullet.pubsub.PubSubMessage>	get(String id) Retrieves the stored PubSubMessage of a submitted query.
CompletableFuture<Void>	kill(String id) Submits a Metadata.Signal#KILL signal to Bullet for the given query ID and removes the query.
void	respond(String id, com.yahoo.bullet.pubsub.PubSubMessage response) Respond to a PubSubMessage.
CompletableFuture<com.yahoo.bullet.pubsub.PubSubMessage>	send(com.yahoo.bullet.pubsub.PubSubMessage message) Sends a PubSubMessage to Bullet without storing it.
CompletableFuture<com.yahoo.bullet.pubsub.PubSubMessage>	send(String id, com.yahoo.bullet.pubsub.Metadata.Signal signal) Sends a Metadata.Signal to Bullet without storing it.
CompletableFuture<com.yahoo.bullet.pubsub.PubSubMessage>	submit(String id, com.yahoo.bullet.query.Query query, String queryString) Submit a query to Bullet and store it in the storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryService

public QueryService(com.yahoo.bullet.storage.StorageManager<com.yahoo.bullet.pubsub.PubSubMessage> storageManager,
                    List<com.yahoo.bullet.pubsub.PubSubResponder> responders,
                    List<com.yahoo.bullet.pubsub.Publisher> publishers,
                    List<com.yahoo.bullet.pubsub.Subscriber> subscribers,
                    com.yahoo.bullet.pubsub.PubSubMessageSerDe pubSubMessageSendSerDe,
                    int sleep)

Constructor that takes various necessary components.

Parameters:

storageManager - The non-null StorageManager to use.

responders - The non-empty List of PubSubResponder to use.

publishers - The non-empty List of Publisher to use.

subscribers - The non-empty List of Subscriber to use.

pubSubMessageSendSerDe - The PubSubMessageSerDe to use for sending messages to the PubSub.

sleep - The time to sleep between checking for messages from the pubsub.

Method Detail

submit

public CompletableFuture<com.yahoo.bullet.pubsub.PubSubMessage> submit(String id,
                                                                       com.yahoo.bullet.query.Query query,
                                                                       String queryString)

Submit a query to Bullet and store it in the storage. Unless the publishing succeeds, the query is not stored.

Parameters:

id - The query ID of the query.

query - The query to send.

queryString - The string representation of the query.

Returns:

A CompletableFuture that resolves to the sent PubSubMessage or null if it could not be sent.

kill

public CompletableFuture<Void> kill(String id)

Submits a Metadata.Signal#KILL signal to Bullet for the given query ID and removes the query.

Parameters:

id - The query ID to submit the kill signal for.

Returns:

A CompletableFuture that resolves when the kill was finished.

respond

public void respond(String id,
                    com.yahoo.bullet.pubsub.PubSubMessage response)

Respond to a PubSubMessage.

Specified by:

respond in class com.yahoo.bullet.pubsub.PubSubResponder

Parameters:

id - The id of the query.

response - The PubSubMessage response.

send

public CompletableFuture<com.yahoo.bullet.pubsub.PubSubMessage> send(String id,
                                                                     com.yahoo.bullet.pubsub.Metadata.Signal signal)

Sends a Metadata.Signal to Bullet without storing it.

Parameters:

id - The non-null ID of the message to send this signal in.

signal - The non-null Metadata.Signal to send.

Returns:

A CompletableFuture that resolves to the sent PubSubMessage or null if it could not be sent.

send

public CompletableFuture<com.yahoo.bullet.pubsub.PubSubMessage> send(com.yahoo.bullet.pubsub.PubSubMessage message)

Sends a PubSubMessage to Bullet without storing it. This can be used to send signals or anything else.

Parameters:

message - The non-null PubSubMessage to send.

Returns:

A CompletableFuture that resolves to the sent PubSubMessage or null if it could not be sent.

get

public CompletableFuture<com.yahoo.bullet.pubsub.PubSubMessage> get(String id)

Retrieves the stored PubSubMessage of a submitted query.

Parameters:

id - The non-null ID of the query.

Returns:

A CompletableFuture that resolves to the stored PubSubMessage or null if it could not be found.

close

@PreDestroy
public void close()

Stop all service threads and clear pending requests.

Specified by:

close in interface AutoCloseable

Overrides:

close in class com.yahoo.bullet.pubsub.PubSubResponder