Модель ресурса

1. Envelop

Слово Envelop происходит от веб-сервиса SOAP и содержит следующие поля:

1. status: io.horizon.eon.em.web.HttpStatusCode — данные перечисления Http Status Enum.
2. headers: io.vertx.core.MultiMap — заголовки Http (напрямую из Vert.x).
3. error: io.horizon.exception.WebException — абстрактная веб-ошибка, определённая Zero.
4. data: io.vertx.core.json.JsonObject — часть данных в текущем Envelop.
5. user: io.vertx.ext.auth.User — информация о пользователе (напрямую из Vert.x).

2. Common Api

// Извлекаем данные из Envelop
final JsonObject data = message.data();

// Извлекаем T из Envelop
final Demo user = message.data(Demo.class);

// Извлекаем данные из Message<Envelop>, статически (будьте осторожны)
final Demo user = Envelop.data(message, Demo.class);

// Создаём успешный Envelop
final Envelop envelop = Envelop.ok();

// Создаём успешный Envelop с данными
Demo user = ...
final Envelop envelop = Envelop.success(user);

// Создаём Envelop ошибки с WebException
WebException exception = ...
final Envelop error = Envelop.failure(exception);

4. Формат данных

Успех:

{
    "data": "Другой формат данных для этого поля"
}

Ошибка:

{
    "message": "Описание сообщения об ошибке",
    "code": -40013
}

• brief: статус Http;
• status: код статуса Http;
• data: часть данных (только при успешном выполнении);
• code: код ошибки Zero (отрицательное число);
• message: сообщение Zero (описывает значение числа).