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
Map<String,Object>	context()
<T> T	context(String key, Class<T> clazz) Extract data from context
<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 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	setContext(Map<String,Object> data)
void	setHeaders(io.vertx.core.MultiMap headers)
void	setSession(io.vertx.ext.web.Session session)
void	setUser(io.vertx.ext.auth.User user)
void	setValue(Integer argIndex, String field, Object value)
void	setValue(String field, Object value)
io.vertx.core.http.HttpStatusCode	status()
static <T> Envelop	success(T entity)
static <T> Envelop	success(T entity, io.vertx.core.http.HttpStatusCode status)
io.vertx.core.Future<Envelop>	toFuture()
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

ok

public static Envelop ok()

Empty content success

Returns:

success

public static <T> Envelop success(T entity)

failure

public static 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:

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:

context

public <T> T context(String key,
                     Class<T> clazz)

Extract data from context

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:

setValue

public void setValue(String field,
                     Object value)

setValue

public void setValue(Integer argIndex,
                     String field,
                     Object value)

response

public String response()

Convert to response

Returns:

toFuture

public io.vertx.core.Future<Envelop> toFuture()

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)

context

public Map<String,Object> context()

setContext

public void setContext(Map<String,Object> data)

identifier

public String identifier(String field)

Read user's identifier

Returns:

toString

public String toString()

Overrides:

toString in class Object