info.pascalkrause.vertx.datacollector.service

Class DataCollectorServiceVertxEBProxy

java.lang.Object

info.pascalkrause.vertx.datacollector.service.DataCollectorServiceVertxEBProxy

All Implemented Interfaces:

DataCollectorService

public class DataCollectorServiceVertxEBProxy
extends java.lang.Object
implements DataCollectorService

Field Summary

Fields inherited from interface info.pascalkrause.vertx.datacollector.service.DataCollectorService

ERROR_QUEUE_LIMIT_REACHED

Constructor Summary

Constructors

Constructor and Description
DataCollectorServiceVertxEBProxy(io.vertx.core.Vertx vertx, java.lang.String address)
DataCollectorServiceVertxEBProxy(io.vertx.core.Vertx vertx, java.lang.String address, io.vertx.core.eventbus.DeliveryOptions options)

Method Summary

Modifier and Type	Method and Description
void	close() Is needed for the proxy generation
void	collect(java.lang.String requestId, io.vertx.core.json.JsonObject feature, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>> resultHandler) This method is doing the same as DataCollectorService.collectAndReceive(String, JsonObject, Handler), but will not send back the result.
void	collectAndReceive(java.lang.String requestId, io.vertx.core.json.JsonObject feature, io.vertx.core.Handler<io.vertx.core.AsyncResult<CollectorJobResult>> resultHandler) This method triggers a CollectorJob and receives the CollectorJobResult in the passed result handler.
void	getMetricsSnapshot(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.core.json.JsonObject>> resultHandler) Returns a JsonObject which contains a current snapshot of the metrics.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataCollectorServiceVertxEBProxy

public DataCollectorServiceVertxEBProxy(io.vertx.core.Vertx vertx,
                                        java.lang.String address)

DataCollectorServiceVertxEBProxy

public DataCollectorServiceVertxEBProxy(io.vertx.core.Vertx vertx,
                                        java.lang.String address,
                                        io.vertx.core.eventbus.DeliveryOptions options)

Method Detail

collectAndReceive

public void collectAndReceive(java.lang.String requestId,
                              io.vertx.core.json.JsonObject feature,
                              io.vertx.core.Handler<io.vertx.core.AsyncResult<CollectorJobResult>> resultHandler)

Description copied from interface: DataCollectorService

This method triggers a CollectorJob and receives the CollectorJobResult in the passed result handler. If the queue of the DataCollectorServiceVerticle is already full, the response will be a failed AsyncResult with the message which is specified in DataCollectorService.ERROR_QUEUE_LIMIT_REACHED.

Specified by:

collectAndReceive in interface DataCollectorService

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.

resultHandler - A handler to process the result.

collect

public void collect(java.lang.String requestId,
                    io.vertx.core.json.JsonObject feature,
                    io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>> resultHandler)

Description copied from interface: DataCollectorService

This method is doing the same as DataCollectorService.collectAndReceive(String, JsonObject, Handler), but will not send back the result. It will just send back the information if the job succeeded or failed.

Specified by:

collect in interface DataCollectorService

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.

resultHandler - A handler to process the result.

getMetricsSnapshot

public void getMetricsSnapshot(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.core.json.JsonObject>> resultHandler)

Description copied from interface: DataCollectorService

Returns a JsonObject which contains a current snapshot of the metrics. The JsonObject has more or less the following structure:

 {
   total: {
     jobs: {
       count: 123,
       failed: 12,
       succeeded: 108,
       exception: 3
     },
     quality: {
       complete: 90,
       partial: 20,
       ....
     },
     errors: {
       blocked: 90,
       timeout: 20,
       ....
     }
   },
   queue: {
     maxSize: 30,
     free: 12,
     occupied: 18
   }
 }
 

Specified by:

getMetricsSnapshot in interface DataCollectorService

Parameters:

resultHandler - A handler to process the metrics result.

close

public void close()

Description copied from interface: DataCollectorService

Is needed for the proxy generation

Specified by:

close in interface DataCollectorService