org.yamcs.web.rest

Class RestRequest

java.lang.Object

org.yamcs.web.rest.RestRequest

public class RestRequest
extends Object

Encapsulates everything to do with one Rest Request. Object is gc-ed, when request ends.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestRequest.IntervalResult
static class	RestRequest.Option

Constructor Summary

Constructors

Constructor and Description
RestRequest(io.netty.channel.ChannelHandlerContext channelHandlerContext, io.netty.handler.codec.http.FullHttpRequest httpRequest, io.netty.handler.codec.http.QueryStringDecoder qsDecoder, AuthenticationToken token)

Method Summary

Modifier and Type	Method and Description
void	addTransferredSize(long numBytes) add numBytes to the transferred size
boolean	asksDescending(boolean descendByDefault) Returns true if the request specifies descending by use of the query string paramter 'order=desc'
boolean	asksFor(MediaType mediaType) Matches the content type on either the Accept header or a 'format' query param.
InputStream	bodyAsInputStream()
<T extends com.google.protobuf.MessageLite.Builder> T	bodyAsMessage(io.protostuff.Schema<T> sourceSchema) Deserializes the incoming message extracted from the body.
com.fasterxml.jackson.core.JsonGenerator	createJsonGenerator(OutputStream out) Returns a new Json Generator that will have pretty-printing enabled if the original request specified this.
MediaType	deriveSourceContentType()
MediaType	deriveTargetContentType() Derives an applicable content type for the output.
static MediaType	deriveTargetContentType(io.netty.handler.codec.http.HttpRequest httpRequest)
String	getApiURL()
AuthenticationToken	getAuthToken()
String	getBaseURL()
io.netty.channel.ChannelHandlerContext	getChannelHandlerContext()
CompletableFuture<Void>	getCompletableFuture() When the request is finished, the CompleteableFuture has to be used to signal the end.
long	getDateRouteParam(String name)
String	getFullPathWithoutQueryString()
String	getHeader(io.netty.util.AsciiString name)
io.netty.handler.codec.http.HttpRequest	getHttpRequest()
int	getIntegerRouteParam(String name)
long	getLongRouteParam(String name)
Set<RestRequest.Option>	getOptions() Experimental feature to gather common parameters.
String	getQueryParameter(String name)
String	getQueryParameter(String name, String defaultValue)
boolean	getQueryParameterAsBoolean(String name)
boolean	getQueryParameterAsBoolean(String name, boolean defaultValue)
long	getQueryParameterAsDate(String name)
long	getQueryParameterAsDate(String name, long defaultValue)
int	getQueryParameterAsInt(String name)
int	getQueryParameterAsInt(String name, int defaultValue)
long	getQueryParameterAsLong(String name)
long	getQueryParameterAsLong(String name, long defaultValue)
List<String>	getQueryParameterList(String name)
List<String>	getQueryParameterList(String name, List<String> defaultList)
Map<String,List<String>>	getQueryParameters()
int	getRequestId()
String	getRouteParam(String name)
long	getTransferredSize() Get the number of bytes transferred as the result of the REST call.
String	getUsername() Returns the username of the authenticated user.
boolean	hasBody()
boolean	hasHeader(String name)
boolean	hasQueryParameter(String name)
boolean	hasRouteParam(String name)
boolean	isSSL()
static long	parseTime(String datetime) Interprets the provided string as either an instant, or an ISO 8601 string and returns it as an instant of type long
RestRequest.IntervalResult	scanForInterval()

Methods inherited from class java.lang.Object

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

Constructor Detail

RestRequest

public RestRequest(io.netty.channel.ChannelHandlerContext channelHandlerContext,
                   io.netty.handler.codec.http.FullHttpRequest httpRequest,
                   io.netty.handler.codec.http.QueryStringDecoder qsDecoder,
                   AuthenticationToken token)

Method Detail

hasRouteParam

public boolean hasRouteParam(String name)

getRouteParam

public String getRouteParam(String name)

getRequestId

public int getRequestId()

Returns:

unique across running yamcs server rest request id used to aid in tracking the request executin in the log file

getLongRouteParam

public long getLongRouteParam(String name)
                       throws BadRequestException

Throws:

BadRequestException

getIntegerRouteParam

public int getIntegerRouteParam(String name)
                         throws BadRequestException

Throws:

BadRequestException

getDateRouteParam

public long getDateRouteParam(String name)
                       throws BadRequestException

Throws:

BadRequestException

getFullPathWithoutQueryString

public String getFullPathWithoutQueryString()

hasHeader

public boolean hasHeader(String name)

getHeader

public String getHeader(io.netty.util.AsciiString name)

getOptions

public Set<RestRequest.Option> getOptions()

Experimental feature to gather common parameters. Should also be made to include the pretty-flag

asksFor

public boolean asksFor(MediaType mediaType)

Matches the content type on either the Accept header or a 'format' query param. Should probably better be integrated with the deriveTargetContentType setting.

getUsername

public String getUsername()

Returns the username of the authenticated user. Or Privilege.getDefaultUser() if the user is not authenticated.

getAuthToken

public AuthenticationToken getAuthToken()

hasQueryParameter

public boolean hasQueryParameter(String name)

getQueryParameters

public Map<String,List<String>> getQueryParameters()

getQueryParameterList

public List<String> getQueryParameterList(String name)

getQueryParameterList

public List<String> getQueryParameterList(String name,
                                          List<String> defaultList)

getQueryParameter

public String getQueryParameter(String name)

getQueryParameter

public String getQueryParameter(String name,
                                String defaultValue)
                         throws BadRequestException

Throws:

BadRequestException

getQueryParameterAsInt

public int getQueryParameterAsInt(String name)
                           throws BadRequestException

Throws:

BadRequestException

getQueryParameterAsInt

public int getQueryParameterAsInt(String name,
                                  int defaultValue)
                           throws BadRequestException

Throws:

BadRequestException

getQueryParameterAsLong

public long getQueryParameterAsLong(String name)
                             throws BadRequestException

Throws:

BadRequestException

getQueryParameterAsLong

public long getQueryParameterAsLong(String name,
                                    long defaultValue)
                             throws BadRequestException

Throws:

BadRequestException

getQueryParameterAsDate

public long getQueryParameterAsDate(String name)
                             throws BadRequestException

Throws:

BadRequestException

getQueryParameterAsDate

public long getQueryParameterAsDate(String name,
                                    long defaultValue)
                             throws BadRequestException

Throws:

BadRequestException

getQueryParameterAsBoolean

public boolean getQueryParameterAsBoolean(String name)

getQueryParameterAsBoolean

public boolean getQueryParameterAsBoolean(String name,
                                          boolean defaultValue)

isSSL

public boolean isSSL()

getChannelHandlerContext

public io.netty.channel.ChannelHandlerContext getChannelHandlerContext()

getHttpRequest

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

createJsonGenerator

public com.fasterxml.jackson.core.JsonGenerator createJsonGenerator(OutputStream out)
                                                             throws IOException

Returns a new Json Generator that will have pretty-printing enabled if the original request specified this.

Throws:

IOException

hasBody

public boolean hasBody()

bodyAsMessage

public <T extends com.google.protobuf.MessageLite.Builder> T bodyAsMessage(io.protostuff.Schema<T> sourceSchema)
                                                                    throws BadRequestException

Deserializes the incoming message extracted from the body. This does not care about what the HTTP method is. Any required checks should be done elsewhere.

This method is only able to read JSON or Protobuf, the two auto-supported serialization mechanisms. If a certain operation needs to read anything else, it should check for that itself, and then use bodyAsInputStream().

Throws:

BadRequestException

bodyAsInputStream

public InputStream bodyAsInputStream()

deriveSourceContentType

public MediaType deriveSourceContentType()

Returns:

see MediaType.getContentType(HttpRequest)

deriveTargetContentType

public MediaType deriveTargetContentType()

Derives an applicable content type for the output. This tries to match JSON or BINARY media types with the ACCEPT header, else it will revert to the (derived) source content type.

Returns:

the content type that will be used for the response message

deriveTargetContentType

public static MediaType deriveTargetContentType(io.netty.handler.codec.http.HttpRequest httpRequest)

getBaseURL

public String getBaseURL()

getCompletableFuture

public CompletableFuture<Void> getCompletableFuture()

When the request is finished, the CompleteableFuture has to be used to signal the end.

Returns:

future to be used to signal the end of processing the request

getTransferredSize

public long getTransferredSize()

Get the number of bytes transferred as the result of the REST call. It should not include the http headers. Note that the number might be increased before the data is sent so it will be wrong if there was an error sending data.

Returns:

number of bytes transferred as part of the request

addTransferredSize

public void addTransferredSize(long numBytes)

add numBytes to the transferred size

Parameters:

numBytes -

asksDescending

public boolean asksDescending(boolean descendByDefault)
                       throws HttpException

Returns true if the request specifies descending by use of the query string paramter 'order=desc'

Throws:

HttpException

parseTime

public static long parseTime(String datetime)

Interprets the provided string as either an instant, or an ISO 8601 string and returns it as an instant of type long

scanForInterval

public RestRequest.IntervalResult scanForInterval()
                                           throws HttpException

Throws:

HttpException

getApiURL

public String getApiURL()