Module org.yamcs.core

Package org.yamcs.http

Class HandlerContext

java.lang.Object

org.yamcs.http.HandlerContext

public class HandlerContext
extends Object

Constructor Summary

Constructors

Constructor	Description
HandlerContext(String contextPath, io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpRequest req, User user)

Method Summary

Modifier and Type	Method	Description
io.netty.buffer.ByteBuf	createByteBuf()
String[]	getBasicCredentials()
String	getContextPath()
String	getCredentials(String type)
String	getFormParameter(String parameter)
String	getHeader(CharSequence name)
io.netty.channel.ChannelHandlerContext	getNettyChannelHandlerContext()
io.netty.handler.codec.http.FullHttpRequest	getNettyFullHttpRequest()
io.netty.handler.codec.http.HttpRequest	getNettyHttpRequest()
String	getOriginalHostAddress()
String	getOriginalHostName()
String	getParameter(String parameter)
String	getPathWithoutContext()
String	getQueryParameter(String parameter)
String	getRequestBaseURL()	Attempts to derive the externally used URL to Yamcs based on request information
User	getUser()
boolean	isFormEncoded()
boolean	isGET()
boolean	isPOST()
void	render(io.netty.handler.codec.http.HttpResponseStatus status, String templateResource, Map<String,Object> vars)
void	renderOK(String templateResource, Map<String,Object> vars)
String	renderToString(String templateResource, Map<String,Object> vars)
void	requireFormEncoding()
String	requireFormParameter(String parameter)
void	requireGET()
void	requireMethod(io.netty.handler.codec.http.HttpMethod... allowedMethods)
String	requireParameter(String parameter)
void	requirePOST()
String	requireQueryParameter(String parameter)
void	sendAllow(io.netty.handler.codec.http.HttpMethod... methods)
void	sendOK()
void	sendOK(com.google.gson.JsonObject jsonObject)
void	sendOK(com.google.protobuf.Message message)
void	sendRedirect(String location)
void	sendResource(String resource)	Send a classpath resource.
io.netty.channel.ChannelFuture	sendResponse(io.netty.handler.codec.http.HttpResponse response)

Methods inherited from class java.lang.Object

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

Constructor Details

HandlerContext

public HandlerContext(String contextPath,
 io.netty.channel.ChannelHandlerContext ctx,
 io.netty.handler.codec.http.HttpRequest req,
 User user)

Method Details

getUser

public User getUser()

getRequestBaseURL

public String getRequestBaseURL()

Attempts to derive the externally used URL to Yamcs based on request information

Returns:

a url of the form [protocol]://[host]:[port][context]

getOriginalHostAddress

public String getOriginalHostAddress()

getOriginalHostName

public String getOriginalHostName()

getNettyChannelHandlerContext

public io.netty.channel.ChannelHandlerContext getNettyChannelHandlerContext()

getNettyHttpRequest

public io.netty.handler.codec.http.HttpRequest getNettyHttpRequest()

getNettyFullHttpRequest

public io.netty.handler.codec.http.FullHttpRequest getNettyFullHttpRequest()

Throws:

ClassCastException - if this context does not contain a "full" HTTP request.

getContextPath

public String getContextPath()

getPathWithoutContext

public String getPathWithoutContext()

isGET

public boolean isGET()

isPOST

public boolean isPOST()

requireGET

public void requireGET()

requirePOST

public void requirePOST()

requireMethod

public void requireMethod(io.netty.handler.codec.http.HttpMethod... allowedMethods)

requireFormEncoding

public void requireFormEncoding()

requireFormParameter

public String requireFormParameter(String parameter)

requireQueryParameter

public String requireQueryParameter(String parameter)

requireParameter

public String requireParameter(String parameter)

getHeader

public String getHeader(CharSequence name)

isFormEncoded

public boolean isFormEncoded()

getCredentials

public String getCredentials(String type)

getBasicCredentials

public String[] getBasicCredentials()

getFormParameter

public String getFormParameter(String parameter)

getQueryParameter

public String getQueryParameter(String parameter)

getParameter

public String getParameter(String parameter)

createByteBuf

public io.netty.buffer.ByteBuf createByteBuf()

renderOK

public void renderOK(String templateResource,
 Map<String,Object> vars)

render

public void render(io.netty.handler.codec.http.HttpResponseStatus status,
 String templateResource,
 Map<String,Object> vars)

renderToString

public String renderToString(String templateResource,
 Map<String,Object> vars)

sendOK

public void sendOK()

sendOK

public void sendOK(com.google.protobuf.Message message)

sendOK

public void sendOK(com.google.gson.JsonObject jsonObject)

sendAllow

public void sendAllow(io.netty.handler.codec.http.HttpMethod... methods)

sendResource

public void sendResource(String resource)

Send a classpath resource.

sendResponse

public io.netty.channel.ChannelFuture sendResponse(io.netty.handler.codec.http.HttpResponse response)

sendRedirect

public void sendRedirect(String location)