io.vertx.up.atom

Class Envelop

java.lang.Object

io.vertx.up.atom.Envelop

All Implemented Interfaces:

Serializable

public class Envelop
extends Object
implements Serializable

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
<T> T	data() Extract data port to T
<T> T	data(Class<T> clazz) Extract request part to t
<T> T	data(Integer argIndex, Class<T> clazz) Extract request part to t ( Direct Mode )
static <T> Envelop	failure(String message)
static Envelop	failure(WebException error) Failure response with exception
io.vertx.ext.web.Session	getSession()
io.vertx.core.MultiMap	headers()
String	identifier(String field) Read user's identifier
static Envelop	ok() Empty content success
String	response() Convert to response
void	setHeaders(io.vertx.core.MultiMap headers)
void	setSession(io.vertx.ext.web.Session session)
void	setUser(io.vertx.ext.auth.User user)
io.vertx.core.http.HttpStatusCode	status()
static <T> Envelop	success(T entity)
static <T> Envelop	success(T entity, io.vertx.core.http.HttpStatusCode status)
String	toString()
io.vertx.ext.auth.User	user()
boolean	valid() Whether this envelop is valid.

Methods inherited from class java.lang.Object

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

Method Detail

valid

public boolean valid()

Whether this envelop is valid.

Returns:

data

public <T> T data()

Extract data port to T

Returns:

data

public <T> T data(Class<T> clazz)

Extract request part to t

Type Parameters:

T -

Parameters:

clazz -

Returns:

data

public <T> T data(Integer argIndex,
                  Class<T> clazz)

Extract request part to t ( Direct Mode )

Type Parameters:

T -

Parameters:

argIndex -

Returns:

response

public String response()

Convert to response

Returns:

status

public io.vertx.core.http.HttpStatusCode status()

user

public io.vertx.ext.auth.User user()

headers

public io.vertx.core.MultiMap headers()

setUser

public void setUser(io.vertx.ext.auth.User user)

setHeaders

public void setHeaders(io.vertx.core.MultiMap headers)

getSession

public io.vertx.ext.web.Session getSession()

setSession

public void setSession(io.vertx.ext.web.Session session)

identifier

public String identifier(String field)

Read user's identifier

Returns:

ok

public static Envelop ok()

Empty content success

Returns:

success

public static <T> Envelop success(T entity)

failure

public static <T> Envelop failure(String message)

success

public static <T> Envelop success(T entity,
                                  io.vertx.core.http.HttpStatusCode status)

failure

public static Envelop failure(WebException error)

Failure response with exception

Parameters:

error -

Returns:

toString

public String toString()

Overrides:

toString in class Object