info.pascalkrause.vertx.datacollector.job

Interface CollectorJob

public interface CollectorJob

A generic interface which must be implemented to run the collection job inside the CollectorJobExecutor worker pool.

Method Summary

Modifier and Type	Method and Description
io.vertx.core.Handler<io.vertx.core.Future<CollectorJobResult>>	collect(java.lang.String requestId, io.vertx.core.json.JsonObject feature) This method should be used to create a Future that contains the collection logic.
io.vertx.core.Handler<io.vertx.core.Future<CollectorJobResult>>	postCollectAction(io.vertx.core.AsyncResult<CollectorJobResult> result) This method will be called after the collect(String, JsonObject) method and returns a Future which can be used to do some post-collect stuff like rough parsing or saving the result into a database.

Method Detail

collect

io.vertx.core.Handler<io.vertx.core.Future<CollectorJobResult>> collect(java.lang.String requestId,
                                                                        io.vertx.core.json.JsonObject feature)

This method should be used to create a Future that contains the collection logic. The Future will be executed in a worker thread pool, which allows blocking operations inside the Future.

Parameters:

requestId - A request id to identify the collection request.

feature - A JSON object to pass attributes and properties which are needed for the collection process.

Returns:

A Handler with the Future which contains the collection logic.

postCollectAction

io.vertx.core.Handler<io.vertx.core.Future<CollectorJobResult>> postCollectAction(io.vertx.core.AsyncResult<CollectorJobResult> result)

This method will be called after the collect(String, JsonObject) method and returns a Future which can be used to do some post-collect stuff like rough parsing or saving the result into a database. The Future will be executed in a worker thread pool, which allows blocking operations inside the Future.

Parameters:

result - The CollectorJobResult from the previous called collect(String, JsonObject) method.

Returns:

A Handler with the Future which contains the post-collection logic.