org.microbean.jersey.netty

Class HttpObjectToContainerRequestDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.MessageToMessageDecoder<T>

org.microbean.jersey.netty.AbstractContainerRequestDecoder<HttpObject,HttpRequest,HttpContent>

org.microbean.jersey.netty.HttpObjectToContainerRequestDecoder

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public final class HttpObjectToContainerRequestDecoder
extends AbstractContainerRequestDecoder<HttpObject,HttpRequest,HttpContent>

An AbstractContainerRequestDecoder that decodes HttpObjects into ContainerRequests.

Author:

Laird Nelson

See Also:

AbstractContainerRequestDecoder.decode(ChannelHandlerContext, Object, List)

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
HttpObjectToContainerRequestDecoder(URI baseUri) Deprecated. Please use the HttpObjectToContainerRequestDecoder(URI, Supplier) constructor instead.
HttpObjectToContainerRequestDecoder(URI baseUri, Configuration configuration) Creates a new HttpObjectToContainerRequestDecoder.
HttpObjectToContainerRequestDecoder(URI baseUri, Supplier<? extends Configuration> configurationSupplier) Creates a new HttpObjectToContainerRequestDecoder.

Method Summary

Modifier and Type	Method and Description
protected String	getMethod(HttpRequest httpRequest) Extracts and returns the name of the request method from the supplied message, which is guaranteed to be a "headers" message.
protected String	getRequestUriString(HttpRequest httpRequest) Extracts and returns a String representing a request URI from the supplied message, which is guaranteed to be a "headers" message.
protected void	installMessage(ChannelHandlerContext channelHandlerContext, HttpRequest message, ContainerRequest containerRequest) Overrides the AbstractContainerRequestDecoder.installMessage(ChannelHandlerContext, Object, ContainerRequest) method to additionally install incoming headers into the supplied ContainerRequest.
protected boolean	isLast(HttpObject httpObject) Returns true if the supplied HttpObject is the last of a stream of messages.

Methods inherited from class org.microbean.jersey.netty.AbstractContainerRequestDecoder

acceptInboundMessage, channelReadComplete, createPropertiesDelegate, createSecurityContext, createTerminableByteBufInputStream, decode, getContent, isData, isHeaders

Methods inherited from class io.netty.handler.codec.MessageToMessageDecoder

channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Detail

HttpObjectToContainerRequestDecoder

@Deprecated
public HttpObjectToContainerRequestDecoder(URI baseUri)

Deprecated. Please use the HttpObjectToContainerRequestDecoder(URI, Supplier) constructor instead.

Creates a new HttpObjectToContainerRequestDecoder.

Parameters:

baseUri - a URI that will serve as the base URI in a new ContainerRequest; may be null in which case the return value of URI.create("/") will be used instead

See Also:

HttpObjectToContainerRequestDecoder(URI, Configuration)

HttpObjectToContainerRequestDecoder

public HttpObjectToContainerRequestDecoder(URI baseUri,
                                           Configuration configuration)

Creates a new HttpObjectToContainerRequestDecoder.

Parameters:

baseUri - a URI that will serve as the base URI in a new ContainerRequest; may be null in which case the return value of URI.create("/") will be used instead

configuration - a Configuration describing how the container is configured; may be null

HttpObjectToContainerRequestDecoder

public HttpObjectToContainerRequestDecoder(URI baseUri,
                                           Supplier<? extends Configuration> configurationSupplier)

Creates a new HttpObjectToContainerRequestDecoder.

Parameters:

baseUri - a URI that will serve as the base URI in a new ContainerRequest; may be null in which case the return value of URI.create("/") will be used instead

configurationSupplier - a Supplier of Configuration instances describing how the container is configured; may be null

Method Detail

getRequestUriString

protected final String getRequestUriString(HttpRequest httpRequest)

Extracts and returns a String representing a request URI from the supplied message, which is guaranteed to be a "headers" message.

This implementation calls httpRequest.uri() and returns the result.

Specified by:

getRequestUriString in class AbstractContainerRequestDecoder<HttpObject,HttpRequest,HttpContent>

Parameters:

httpRequest - the message to interrogate; will not be null

Returns:

a String representing a request URI from the supplied message, or null

getMethod

protected final String getMethod(HttpRequest httpRequest)

Extracts and returns the name of the request method from the supplied message, which is guaranteed to be a "headers" message.

This implementation calls httpRequest.method().name() and returns the result.

Specified by:

getMethod in class AbstractContainerRequestDecoder<HttpObject,HttpRequest,HttpContent>

Parameters:

httpRequest - the message to interrogate; will not be null

Returns:

a String representing the request method from the supplied message, or null

installMessage

protected void installMessage(ChannelHandlerContext channelHandlerContext,
                              HttpRequest message,
                              ContainerRequest containerRequest)

Overrides the AbstractContainerRequestDecoder.installMessage(ChannelHandlerContext, Object, ContainerRequest) method to additionally install incoming headers into the supplied ContainerRequest.

Overrides:

installMessage in class AbstractContainerRequestDecoder<HttpObject,HttpRequest,HttpContent>

Parameters:

channelHandlerContext - the ChannelHandlerContext in effect; will not be null; supplied for convenience; overrides may (and often do) ignore this parameter

message - the message to install; will not be null

containerRequest - the just-constructed ContainerRequest into which to install the supplied message; will not be null

See Also:

HttpMessage.headers(), InboundMessageContext.header(String, Object)

isLast

protected final boolean isLast(HttpObject httpObject)

Returns true if the supplied HttpObject is the last of a stream of messages.

This implementation returns true if either:

• httpObject is an instance of LastHttpContent, or
• httpObject is an instance of HttpRequest and its content length equals 0L

Specified by:

isLast in class AbstractContainerRequestDecoder<HttpObject,HttpRequest,HttpContent>

Parameters:

httpObject - the message to interrogate; will not be null

Returns:

true if no further messages in the stream are forthcoming; false otherwise