com.firefly.server.http2.router

接口 RoutingContext

所有超级接口:

AutoCloseable, Closeable

所有已知实现类:

RoutingContextImpl

public interface RoutingContext
extends Closeable

A new RoutingContext(ctx) instance is created for each HTTP request.

You can visit the RoutingContext instance in the whole router chain. It provides HTTP request/response API and allows you to maintain arbitrary data that lives for the lifetime of the context. Contexts are discarded once they have been routed to the handler for the request.

The context also provides access to the Session, cookies and body for the request, given the correct handlers in the application.

作者:

Pengtao Qiu

方法概要

限定符和类型	方法和说明
default RoutingContext	add(HttpHeader header, String value)
default RoutingContext	add(String name, String value)
default RoutingContext	addCookie(Cookie cookie)
default <T> CompletableFuture<T>	complete()
<T> RoutingContext	complete(Promise<T> promise)
RoutingContext	content(Action1<ByteBuffer> content)
RoutingContext	contentComplete(Action1<SimpleRequest> contentComplete)
default RoutingContext	end()
default RoutingContext	end(byte[] b)
default RoutingContext	end(String value)
void	fail(Throwable x)
SimpleResponse	getAsyncResponse()
Object	getAttribute(String key)
ConcurrentHashMap<String,Object>	getAttributes()
BufferedReader	getBufferedReader()
default int	getConnectionId()
default long	getContentLength()
default List<Cookie>	getCookies()
default HttpFields	getFields()
default HttpVersion	getHttpVersion()
InputStream	getInputStream()
JsonArray	getJsonArrayBody()
<T> T	getJsonBody(Class<T> clazz)
<T> T	getJsonBody(GenericTypeReference<T> typeReference)
JsonObject	getJsonObjectBody()
default String	getMethod()
String	getParameter(String name)
Map<String,List<String>>	getParameterMap()
List<String>	getParameterValues(String name)
default Optional<String>	getParamOpt(String name)
javax.servlet.http.Part	getPart(String name)
Collection<javax.servlet.http.Part>	getParts()
SimpleRequest	getRequest()
String	getRequestedSessionId()
SimpleResponse	getResponse()
String	getRouterParameter(String name)
default Optional<String>	getRouterParamOpt(String name)
CompletableFuture<HTTPSession>	getSession()
CompletableFuture<HTTPSession>	getSession(boolean create)
String	getSessionIdParameterName()
default HTTPSession	getSessionNow()
default HTTPSession	getSessionNow(boolean create)
CompletableFuture<Integer>	getSessionSize()
default int	getSessionSizeNow()
String	getStringBody()
String	getStringBody(String charset)
default HttpURI	getURI()
boolean	hasNext()
boolean	isAsynchronousRead()
boolean	isRequestedSessionIdFromCookie()
boolean	isRequestedSessionIdFromURL()
RoutingContext	messageComplete(Action1<SimpleRequest> messageComplete)
boolean	next()
<T> boolean	next(Promise<T> promise)
default <T> CompletableFuture<T>	nextFuture()
default RoutingContext	put(HttpHeader header, String value)
default RoutingContext	put(String header, String value)
default void	redirect(String url)
Object	removeAttribute(String key)
CompletableFuture<Boolean>	removeSession()
default boolean	removeSessionNow()
default void	renderTemplate(String resourceName)
void	renderTemplate(String resourceName, List<Object> scopes)
void	renderTemplate(String resourceName, Object scope)
void	renderTemplate(String resourceName, Object[] scopes)
Object	setAttribute(String key, Object value)
default RoutingContext	setHttpVersion(HttpVersion httpVersion)
default RoutingContext	setReason(String reason)
default RoutingContext	setStatus(int status)
<T> void	succeed(T t)
CompletableFuture<Boolean>	updateSession(HTTPSession httpSession)
default boolean	updateSessionNow(HTTPSession httpSession)
default RoutingContext	write(byte[] b)
default RoutingContext	write(byte[] b, int off, int len)
default RoutingContext	write(String value)
default RoutingContext	writeJson(Object object)

从接口继承的方法 java.io.Closeable

close

方法详细资料

getAttribute

Object getAttribute(String key)

setAttribute

Object setAttribute(String key,
                    Object value)

removeAttribute

Object removeAttribute(String key)

getAttributes

ConcurrentHashMap<String,Object> getAttributes()

getResponse

SimpleResponse getResponse()

getAsyncResponse

SimpleResponse getAsyncResponse()

getRequest

SimpleRequest getRequest()

getConnectionId

default int getConnectionId()

getRouterParameter

String getRouterParameter(String name)

getRouterParamOpt

default Optional<String> getRouterParamOpt(String name)

content

RoutingContext content(Action1<ByteBuffer> content)

contentComplete

RoutingContext contentComplete(Action1<SimpleRequest> contentComplete)

messageComplete

RoutingContext messageComplete(Action1<SimpleRequest> messageComplete)

isAsynchronousRead

boolean isAsynchronousRead()

next

boolean next()

hasNext

boolean hasNext()

complete

<T> RoutingContext complete(Promise<T> promise)

next

<T> boolean next(Promise<T> promise)

nextFuture

default <T> CompletableFuture<T> nextFuture()

complete

default <T> CompletableFuture<T> complete()

succeed

<T> void succeed(T t)

fail

void fail(Throwable x)

getMethod

default String getMethod()

getURI

default HttpURI getURI()

getHttpVersion

default HttpVersion getHttpVersion()

getFields

default HttpFields getFields()

getContentLength

default long getContentLength()

getCookies

default List<Cookie> getCookies()

setStatus

default RoutingContext setStatus(int status)

setReason

default RoutingContext setReason(String reason)

setHttpVersion

default RoutingContext setHttpVersion(HttpVersion httpVersion)

put

default RoutingContext put(HttpHeader header,
                           String value)

put

default RoutingContext put(String header,
                           String value)

add

default RoutingContext add(HttpHeader header,
                           String value)

add

default RoutingContext add(String name,
                           String value)

addCookie

default RoutingContext addCookie(Cookie cookie)

write

default RoutingContext write(String value)

writeJson

default RoutingContext writeJson(Object object)

end

default RoutingContext end(String value)

end

default RoutingContext end()

write

default RoutingContext write(byte[] b,
                             int off,
                             int len)

write

default RoutingContext write(byte[] b)

end

default RoutingContext end(byte[] b)

redirect

default void redirect(String url)

getParameter

String getParameter(String name)

getParamOpt

default Optional<String> getParamOpt(String name)

getParameterValues

List<String> getParameterValues(String name)

getParameterMap

Map<String,List<String>> getParameterMap()

getParts

Collection<javax.servlet.http.Part> getParts()

getPart

javax.servlet.http.Part getPart(String name)

getInputStream

InputStream getInputStream()

getBufferedReader

BufferedReader getBufferedReader()

getStringBody

String getStringBody(String charset)

getStringBody

String getStringBody()

getJsonBody

<T> T getJsonBody(Class<T> clazz)

getJsonBody

<T> T getJsonBody(GenericTypeReference<T> typeReference)

getJsonObjectBody

JsonObject getJsonObjectBody()

getJsonArrayBody

JsonArray getJsonArrayBody()

getSessionNow

default HTTPSession getSessionNow()

getSessionNow

default HTTPSession getSessionNow(boolean create)

getSessionSizeNow

default int getSessionSizeNow()

removeSessionNow

default boolean removeSessionNow()

updateSessionNow

default boolean updateSessionNow(HTTPSession httpSession)

getSession

CompletableFuture<HTTPSession> getSession()

getSession

CompletableFuture<HTTPSession> getSession(boolean create)

getSessionSize

CompletableFuture<Integer> getSessionSize()

removeSession

CompletableFuture<Boolean> removeSession()

updateSession

CompletableFuture<Boolean> updateSession(HTTPSession httpSession)

isRequestedSessionIdFromURL

boolean isRequestedSessionIdFromURL()

isRequestedSessionIdFromCookie

boolean isRequestedSessionIdFromCookie()

getRequestedSessionId

String getRequestedSessionId()

getSessionIdParameterName

String getSessionIdParameterName()

renderTemplate

void renderTemplate(String resourceName,
                    Object scope)

renderTemplate

void renderTemplate(String resourceName,
                    Object[] scopes)

renderTemplate

void renderTemplate(String resourceName,
                    List<Object> scopes)

renderTemplate

default void renderTemplate(String resourceName)