com.yahoo.bullet.rest.controller

Class RESTPubSubController

java.lang.Object

com.yahoo.bullet.rest.controller.RESTPubSubController

@RestController
 @ConditionalOnProperty(prefix="bullet.pubsub.builtin.rest",
                       name="enabled",
                       havingValue="true")
public class RESTPubSubController
extends Object

Constructor Summary

Constructors

Constructor and Description
RESTPubSubController(RESTPubSubService restPubSubService) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getQuery(javax.servlet.http.HttpServletResponse response) The method that handles reading a query.
String	getResult(javax.servlet.http.HttpServletResponse response) The method that handles reading a result.
void	postQuery(String query) The method that handles adding queries to the query queue.
void	postResult(String result) The method that handles adding results to the result queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

RESTPubSubController

@Autowired
public RESTPubSubController(RESTPubSubService restPubSubService)

Constructor.

Parameters:

restPubSubService - The RESTPubSubService to use.

Method Detail

postResult

@PostMapping(path="${bullet.pubsub.builtin.rest.result.path}",
             consumes="application/json")
public void postResult(@RequestBody
                                                                                                                                String result)

The method that handles adding results to the result queue. Clients should POST to this endpoint to write results to the queue. Invokes RESTPubSubService to add the result to the queue.

Parameters:

result - The result to add to the queue.

getResult

@GetMapping(path="${bullet.pubsub.builtin.rest.result.path}",
            produces="application/json")
public String getResult(javax.servlet.http.HttpServletResponse response)

The method that handles reading a result. Clients should GET from this endpoint to read a result. Returns NO_CONTENT (204) if there are no results to read.

Parameters:

response - The HttpServletResponse that will be used to set the response status code.

Returns:

A String representing the result.

postQuery

@PostMapping(path="${bullet.pubsub.builtin.rest.query.path}",
             consumes="application/json")
public void postQuery(@RequestBody
                                                                                                                              String query)

The method that handles adding queries to the query queue. Clients should POST to this endpoint to write queries to the queue. Invokes RESTPubSubService to add the query to the queue.

Parameters:

query - The query to add to the queue.

getQuery

@GetMapping(path="${bullet.pubsub.builtin.rest.query.path}",
            produces="application/json")
public String getQuery(javax.servlet.http.HttpServletResponse response)

The method that handles reading a query. Clients should GET from this endpoint to read a query. Returns NO_CONTENT (204) if there are no queries to read.

Parameters:

response - The HttpServletResponse that will be used to set the response status code.

Returns:

A String representing the query.