org.vertx.java.busmods

Class BusModBase

java.lang.Object

org.vertx.java.platform.Verticle

org.vertx.java.busmods.BusModBase

public abstract class BusModBase
extends Verticle

Base helper class for Java modules which use the event bus.

You don't have to use this class but it contains some useful functionality.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.vertx.java.core.json.JsonObject	config
protected org.vertx.java.core.eventbus.EventBus	eb
protected org.vertx.java.core.logging.Logger	logger

Fields inherited from class org.vertx.java.platform.Verticle

container, vertx

Constructor Summary

Constructors

Constructor and Description
BusModBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	getMandatoryBooleanConfig(java.lang.String fieldName)
protected int	getMandatoryIntConfig(java.lang.String fieldName)
protected long	getMandatoryLongConfig(java.lang.String fieldName)
protected org.vertx.java.core.json.JsonObject	getMandatoryObject(java.lang.String field, org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject> message)
protected java.lang.String	getMandatoryString(java.lang.String field, org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject> message)
protected java.lang.String	getMandatoryStringConfig(java.lang.String fieldName)
protected org.vertx.java.core.json.JsonArray	getOptionalArrayConfig(java.lang.String fieldName, org.vertx.java.core.json.JsonArray defaultValue)
protected boolean	getOptionalBooleanConfig(java.lang.String fieldName, boolean defaultValue)
protected int	getOptionalIntConfig(java.lang.String fieldName, int defaultValue)
protected long	getOptionalLongConfig(java.lang.String fieldName, long defaultValue)
protected org.vertx.java.core.json.JsonObject	getOptionalObjectConfig(java.lang.String fieldName, org.vertx.java.core.json.JsonObject defaultValue)
protected java.lang.String	getOptionalStringConfig(java.lang.String fieldName, java.lang.String defaultValue)
protected void	sendError(org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject> message, java.lang.String error)
protected void	sendError(org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject> message, java.lang.String error, java.lang.Exception e)
protected void	sendOK(org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject> message)
protected void	sendOK(org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject> message, org.vertx.java.core.json.JsonObject json)
protected void	sendStatus(java.lang.String status, org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject> message)
protected void	sendStatus(java.lang.String status, org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject> message, org.vertx.java.core.json.JsonObject json)
void	start() Start the busmod

Methods inherited from class org.vertx.java.platform.Verticle

getContainer, getVertx, setContainer, setVertx, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

eb

protected org.vertx.java.core.eventbus.EventBus eb

config

protected org.vertx.java.core.json.JsonObject config

logger

protected org.vertx.java.core.logging.Logger logger

Constructor Detail

BusModBase

public BusModBase()

Method Detail

start

public void start()

Start the busmod

Overrides:

start in class Verticle

sendOK

protected void sendOK(org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject> message)

sendStatus

protected void sendStatus(java.lang.String status,
              org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject> message)

sendStatus

protected void sendStatus(java.lang.String status,
              org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject> message,
              org.vertx.java.core.json.JsonObject json)

sendOK

protected void sendOK(org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject> message,
          org.vertx.java.core.json.JsonObject json)

sendError

protected void sendError(org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject> message,
             java.lang.String error)

sendError

protected void sendError(org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject> message,
             java.lang.String error,
             java.lang.Exception e)

getMandatoryString

protected java.lang.String getMandatoryString(java.lang.String field,
                                  org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject> message)

getMandatoryObject

protected org.vertx.java.core.json.JsonObject getMandatoryObject(java.lang.String field,
                                                     org.vertx.java.core.eventbus.Message<org.vertx.java.core.json.JsonObject> message)

getOptionalBooleanConfig

protected boolean getOptionalBooleanConfig(java.lang.String fieldName,
                               boolean defaultValue)

getOptionalStringConfig

protected java.lang.String getOptionalStringConfig(java.lang.String fieldName,
                                       java.lang.String defaultValue)

getOptionalIntConfig

protected int getOptionalIntConfig(java.lang.String fieldName,
                       int defaultValue)

getOptionalLongConfig

protected long getOptionalLongConfig(java.lang.String fieldName,
                         long defaultValue)

getOptionalObjectConfig

protected org.vertx.java.core.json.JsonObject getOptionalObjectConfig(java.lang.String fieldName,
                                                          org.vertx.java.core.json.JsonObject defaultValue)

getOptionalArrayConfig

protected org.vertx.java.core.json.JsonArray getOptionalArrayConfig(java.lang.String fieldName,
                                                        org.vertx.java.core.json.JsonArray defaultValue)

getMandatoryBooleanConfig

protected boolean getMandatoryBooleanConfig(java.lang.String fieldName)

getMandatoryStringConfig

protected java.lang.String getMandatoryStringConfig(java.lang.String fieldName)

getMandatoryIntConfig

protected int getMandatoryIntConfig(java.lang.String fieldName)

getMandatoryLongConfig

protected long getMandatoryLongConfig(java.lang.String fieldName)